> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Time Machine — undo a revert batch > **The undo button.** Puts every account in a revert batch back **exactly where it was the moment before the revert ran**: pre-revert balance, status, high-water mark and daily baseline are restored from the ledger, and every snapshot and order the batch voided is un-voided — the trader's journal, order history, and daily stats come back like the revert never happened. Open terminals update live. A revert destroys nothing (rows are stamped, not deleted), which is what makes this possible. **Per-account rules** (each account is checked independently — eligible ones proceed, blocked ones come back in `failures`): | Code | Meaning | |------|---------| | `NEW_ACTIVITY` | The trader placed orders after the revert, or a market close recorded a day with real activity since. The old timeline can't be restored over a new one — this account stays as-is. | | `NOT_LATEST_REVERT` | A newer revert covers this account. Reverts undo newest-first, like a stack — undo the newer batch first. | | `UNDO_UPDATE_ERROR` | Failed to write the restored state — retry (idempotent). | **Batch-level error codes:** | Code | Status | Meaning | |------|:---:|---------| | `BATCH_NOT_FOUND` | 404 | Unknown batch id (or it belongs to a different organization) | | `ALREADY_UNDONE` | 409 | Every account in this batch has already been undone | **Timing:** the undo window stays open as long as the account has no new activity — minutes or days later both work. In practice: if you realize the mistake before traders resume trading, everything restores; accounts that already traded again are individually skipped and reported. **Recommended flow:** `"preview": true` first — you get the exact per-account restore report plus who would be blocked and why — then execute. **Example — preview, then undo:** ```bash # 1. Dry run — nothing changes curl -X POST ".../v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/undo" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "preview": true }' # 2. Execute curl -X POST ".../v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/undo" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "reason": "Reverted the wrong day — restoring" }' ``` ## OpenAPI ````yaml /api-reference/openapi.json post /v1/organization/revert-batches/{batchId}/undo openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. ## Authentication Two methods, depending on who is calling: ### Bearer Token (JWT) — users & dashboard Most endpoints accept a JWT via `Authorization: Bearer `. Used by the dashboard and client applications. ### API Key — organizations (prop firms) Organization endpoints also accept `X-API-Key: hp_live_...` for programmatic access from your backend — no browser session needed. Keys are managed by organization admins in the dashboard; each key carries permissions (`read`, `write`, `admin`) and can be rotated or revoked at any time. Keys are stored hashed (SHA-256) — the raw key is shown once at creation. Endpoints that create or modify data require `write` or `admin`. ## Quick Start ```bash # 1. List your trading plans (grab a tradingPlanId) curl "https://api.hyperprop.com/platform/v1/organization/trading-plans" \ -H "X-API-Key: hp_live_your_key_here" # 2. Create a trading account for a trader (by Hyperprop user ID or email) curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "", "email": "trader@example.com"}' ``` ## Response Envelope & Error Handling **Success** responses always wrap the payload: ```json { "success": true, "data": { ... }, "message": "optional human-readable note" } ``` **Errors** — including request-validation failures, auth failures, and errors proxied from the trade engine — always return this single uniform shape with a machine-readable `code` you can switch on: ```json { "success": false, "statusCode": 404, "error": "Not Found", "message": "No Hyperprop user found with that email. The trader must have a Hyperprop account before an account can be created for them.", "code": "TRADER_NOT_FOUND" } ``` Parse rule of thumb: check `success`; on `false`, switch on `code` (never on `message` text — messages can be reworded). Some errors carry additional structured context alongside these fields (e.g. payout rejections include a `consistency` block). Common codes: `VALIDATION_ERROR` (malformed payload/params), `UNAUTHORIZED`, `INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN` (key lacks write/admin), `*_NOT_FOUND` (missing resource), `*_NOT_IN_ORG` (resource belongs to another organization), `IDEMPOTENCY_KEY_IN_PROGRESS` (duplicate in flight), `ENGINE_UNREACHABLE` (trade engine down — retry with the same idempotency key). Endpoint-specific codes (e.g. payout `OPEN_EXPOSURE`, `CONSISTENCY_BLOCKED`) are documented on each endpoint. ## Idempotency **Every mutating endpoint (POST, PUT, PATCH, DELETE) honors idempotency keys uniformly.** Send an `Idempotency-Key` header (the `X-Idempotency-Key` spelling is accepted as an alias) to retry any write safely without creating duplicates. How it works: - The key is scoped to your organization + the request path. The first request with a given key executes normally and its response is cached for **24 hours**. - A replay (same key, same path) within 24 hours returns the cached response with an `Idempotency-Replayed: true` response header — the operation is **not** executed again. - If a request with the same key is still in flight, the duplicate gets `409 IDEMPOTENCY_KEY_IN_PROGRESS` — back off and retry; you'll then receive the cached response. - 5xx responses are **not** cached, so retrying after a server error re-executes the request (that's what you want). 2xx-4xx responses are cached — if a request failed validation and you fix the payload, use a **fresh key**. - Keys are free-form strings up to 255 characters. Use something that identifies the operation on your side, e.g. `order-8814-attempt-1`. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Idempotency-Key: order-8814-attempt-1" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "...", "traderId": "..."}' ``` This applies to account creation, account PATCH (status, currentBalance, metadata), rules, plans, lockouts, payouts, team, webhooks — every write on the platform API. Payouts additionally forward the key to the trade engine for engine-level double-withdrawal protection. ## Pagination & Sorting List endpoints support both styles: - **Cursor (recommended):** pass `?cursor=` from the previous response's `pagination.nextCursor`. Stable under concurrent writes. - **Offset:** `?limit=&offset=` with `pagination.total` / `hasMore` in the response. Sorting uses `?sort=field:direction` (e.g. `?sort=created_at:asc`); allowed fields are listed per endpoint. Default: `created_at:desc`. ## Custom Metadata Trading accounts, purchases, traders, plans, and rules all carry a free-form `metadata` JSON object. Use it to store your own references — payment IDs, campaign tags, payout records, internal notes. Hyperprop stores and returns it verbatim (and lets you filter list endpoints by it, e.g. `?metadata=stripePaymentId:pi_123`) but never interprets it. Update endpoints support `mergeMetadata: true` for shallow (top-level) merges instead of wholesale replacement. ## Webhooks Subscribe to account lifecycle events (`account.created`, `account.status_changed`, `account.updated`, `account.passed`, `account.failed`, and more) via the Webhooks endpoints. Deliveries are HMAC-SHA256 signed — verify `X-Hyperprop-Signature` with your endpoint secret, using `X-Hyperprop-Timestamp` for replay protection; `X-Hyperprop-Delivery` gives you a unique delivery ID for deduplication. Failed deliveries are retried with backoff, and you can redeliver any event from the dashboard or API. ## MCP Connector (AI Agents) The platform ships a built-in [MCP](https://modelcontextprotocol.io) server, so AI agents and assistants (Claude, Cursor, custom agents) can operate your organization directly — no integration code required. ```http Endpoint: POST https://api.hyperprop.com/platform/v1/mcp Transport: Streamable HTTP (stateless, JSON responses) Auth: X-API-Key header, Authorization: Bearer hp_live_..., or OAuth ``` **Claude web / desktop (Add custom connector):** paste the endpoint URL and leave the OAuth Client ID/Secret fields empty — the connector registers itself automatically. Claude opens a Hyperprop consent page where an org admin pastes the organization API key once; access then follows that key's permissions and ends if the key is revoked. (Under the hood: OAuth 2.1 with PKCE and dynamic client registration.) **Cursor / Claude Code — `mcp.json`:** ```json { "mcpServers": { "hyperprop": { "url": "https://api.hyperprop.com/platform/v1/mcp", "headers": { "X-API-Key": "hp_live_your_key_here" } } } } ``` **Available tools (12):** `list_trading_plans`, `list_trading_accounts`, `get_trading_account`, `get_account_audit_log`, `list_traders`, `get_trader`, `list_purchases`, `get_purchase`, `get_billing_summary` (read) · `create_trading_account`, `update_trading_account`, `record_payout` (write). Every tool call executes the corresponding REST endpoint with your key, so organization scoping, permissions, validation, audit logging, and webhooks apply exactly as documented on each endpoint. Read tools work with any key; write tools need `write`/`admin` permission — connect a **read-only key** if you want a strictly read-only agent. `create_trading_account` accepts an optional `idempotencyKey` so agent retries can't create duplicates, and `record_payout` implements the documented payout recipe (append to `metadata.payouts`, adjust `currentBalance`, audit-logged `reason`). ## Endpoint Groups - **Authentication** — Sign up, sign in, OAuth, MFA, password reset. No auth required for most. - **User** — Profile, notifications, demo accounts, audit logs. Requires **Bearer token** (JWT). - **Organization** — Trading accounts, plans, rules, traders, purchases, lockouts, billing, bulk operations, webhooks, analytics. Accepts **Bearer token** OR **API Key**. - **System** — Health checks. No auth required. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Authentication description: >- User authentication - signup, signin, signout, password reset, email verification, OAuth, and MFA - name: User description: >- User account management - profile, notifications, agreements, dismissals, and audit logs. Requires Bearer token. - name: Organization description: >- Organization management - profile, team, trading accounts, plans, and rules. Supports **dual authentication**: Bearer JWT token (dashboard users) OR X-API-Key (programmatic access). - name: Demo description: >- Demo account management - import, list, and delete demo trading accounts. Requires Bearer token. - name: Market Data description: CME futures contracts and market data. Requires Bearer token. - name: System description: System endpoints - health checks and connectivity paths: /v1/organization/revert-batches/{batchId}/undo: post: tags: - Organization summary: Time Machine — undo a revert batch description: >- **The undo button.** Puts every account in a revert batch back **exactly where it was the moment before the revert ran**: pre-revert balance, status, high-water mark and daily baseline are restored from the ledger, and every snapshot and order the batch voided is un-voided — the trader's journal, order history, and daily stats come back like the revert never happened. Open terminals update live. A revert destroys nothing (rows are stamped, not deleted), which is what makes this possible. **Per-account rules** (each account is checked independently — eligible ones proceed, blocked ones come back in `failures`): | Code | Meaning | |------|---------| | `NEW_ACTIVITY` | The trader placed orders after the revert, or a market close recorded a day with real activity since. The old timeline can't be restored over a new one — this account stays as-is. | | `NOT_LATEST_REVERT` | A newer revert covers this account. Reverts undo newest-first, like a stack — undo the newer batch first. | | `UNDO_UPDATE_ERROR` | Failed to write the restored state — retry (idempotent). | **Batch-level error codes:** | Code | Status | Meaning | |------|:---:|---------| | `BATCH_NOT_FOUND` | 404 | Unknown batch id (or it belongs to a different organization) | | `ALREADY_UNDONE` | 409 | Every account in this batch has already been undone | **Timing:** the undo window stays open as long as the account has no new activity — minutes or days later both work. In practice: if you realize the mistake before traders resume trading, everything restores; accounts that already traded again are individually skipped and reported. **Recommended flow:** `"preview": true` first — you get the exact per-account restore report plus who would be blocked and why — then execute. **Example — preview, then undo:** ```bash # 1. Dry run — nothing changes curl -X POST ".../v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/undo" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "preview": true }' # 2. Execute curl -X POST ".../v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/undo" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "reason": "Reverted the wrong day — restoring" }' ``` operationId: postV1OrganizationRevertbatchesBatchidUndo parameters: - description: Batch id returned by the revert call x-format: guid: true name: batchId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model651' responses: '200': description: Undo processed (check per-account failures) content: '*/*': schema: $ref: '#/components/schemas/Model657' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model7' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model39' '404': description: Batch not found content: '*/*': schema: $ref: '#/components/schemas/Model658' '409': description: Already undone content: '*/*': schema: $ref: '#/components/schemas/Model659' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model3' security: - Bearer: [] - X-API-Key: [] components: schemas: Model651: type: object properties: reason: type: string description: >- Why the undo happened — stored in the audit trail and webhook events. Defaults to a generated message. example: Reverted the wrong day — restoring minLength: 3 preview: type: boolean description: >- Dry run: per-account report of what the undo WOULD restore (and which accounts are blocked), nothing changed. example: true default: false Model657: type: object properties: success: type: boolean example: true message: type: string example: Restored 1 account to their pre-revert state data: $ref: '#/components/schemas/Model656' Model7: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model39: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model658: type: object properties: success: type: boolean example: false code: type: string example: BATCH_NOT_FOUND message: type: string example: Revert batch not found Model659: type: object properties: success: type: boolean example: false code: type: string example: ALREADY_UNDONE message: type: string example: This revert batch has already been undone Model3: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model656: type: object example: batchId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 tradingDay: '2026-07-07' preview: false restored: 1 failed: 1 accounts: - accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-7845KXPQ balanceBefore: 51250 balanceAfter: 48750 statusBefore: in_progress statusAfter: failed snapshotsRestored: 1 ordersRestored: 14 failures: - accountId: 8d0f7780-8536-51ef-b55c-f18gd2g01bf8 code: NEW_ACTIVITY message: >- The trader has new order activity after the revert — the old timeline can no longer be restored properties: batchId: type: string tradingDay: type: string description: The day the original batch reverted to preview: type: boolean restored: type: number failed: type: number accounts: $ref: '#/components/schemas/Model653' failures: $ref: '#/components/schemas/Model655' Model653: type: array items: $ref: '#/components/schemas/Model652' Model655: type: array items: $ref: '#/components/schemas/Model654' Model652: type: object properties: accountId: type: string accountNumber: type: string balanceBefore: type: number description: Balance while reverted balanceAfter: type: number description: Restored pre-revert balance statusBefore: type: string statusAfter: type: string snapshotsRestored: type: number description: Voided daily snapshots brought back ordersRestored: type: number description: Voided order events brought back into journal/history Model654: type: object properties: accountId: type: string code: type: string message: type: string securitySchemes: Bearer: type: apiKey name: Authorization in: header description: >- JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints. X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key for programmatic access. Format: "hp_live_{key}". Used by Organization endpoints as an alternative to Bearer token. Keys are managed in the dashboard. ```` ## Related topics - [Time Machine — list revert batches](/platform-api/organization/time-machine-—-list-revert-batches.md) - [Time Machine — inspect a revert batch](/platform-api/organization/time-machine-—-inspect-a-revert-batch.md) - [Time Machine — bulk revert accounts to a trading day](/platform-api/organization/time-machine-—-bulk-revert-accounts-to-a-trading-day.md) - [Time Machine — revert an account to a trading day](/platform-api/organization/time-machine-—-revert-an-account-to-a-trading-day.md) - [Changelog](/changelog.md)