Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.
For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore.
Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running:
status
Meaning
running
Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far
completed
Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted
interrupted
The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts
A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome.
failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response.
Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest.
Large batches.accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset.
{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}
Authorizations
X-API-Key
string
header
required
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Path Parameters
batchId
string
required
Batch id returned by a revert call (or from the ledger list)
Query Parameters
accountsLimit
integer
default:1000
Accounts per page in accounts (oldest first)
Required range: 1 <= x <= 1000
accountsOffset
integer
default:0
Accounts to skip — page through batches larger than accountsLimit with accountsTotal
{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Hyperprop Platform API","colors":{"primary":"#253CFF","light":"#253CFF","dark":"#253CFF"},"logo":{"light":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3","dark":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/dark.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=1e52fc25e71c2a6a9e047b4fbd60dae4","href":"https://hyperprop.com"},"favicon":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/favicon.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=760656e341413d4cd9dae53925c04cf6","navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://portal.hyperprop.com"}},"footer":{"socials":{"x":"https://x.com/hyperpropcom","github":"https://github.com/Hyperprop-LLC-FZ"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperprop-401fc39d","hasAudioNarration":false,"actualSubdomain":"hyperprop-401fc39d","customDomains":["docs.hyperprop.com"],"gitSource":{"type":"github","owner":"hyperprop-llc-fz","repo":"hyperprop-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9d28c5400fbb020686d90","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":246},{"language":"default","tag":"Platform API","count":202},{"language":"default","tag":"Trade API","count":44},{"language":"default","tag":"Risk","count":39},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Trading accounts","count":29},{"language":"default","tag":"Mass credit","count":23},{"language":"default","tag":"Billing and invoices","count":16},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Webhooks","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar nav-logo img,nav-logo img{height:2rem!important;width:auto}@media (max-width: 640px){pre{max-width:100%;overflow-x:auto}pre code{white-space:pre;word-break:normal}}@media (max-width: 640px){.prose table,#content-area table{display:block;max-width:100%;overflow-x:auto}}html.dark pre.shiki.shiki-themes,html[data-theme=\"dark\"] pre.shiki.shiki-themes{background-color:var(--shiki-dark-bg)!important;color:var(--shiki-dark)!important}html.dark pre.shiki.shiki-themes span,html[data-theme=\"dark\"] pre.shiki.shiki-themes span{color:var(--shiki-dark)!important;font-style:var(--shiki-dark-font-style)!important;font-weight:var(--shiki-dark-font-weight)!important;text-decoration:var(--shiki-dark-text-decoration)!important}"}],"page":{"pagePath":"platform-api/time-machine/inspect-a-revert-batch","slug":"/platform-api/time-machine/inspect-a-revert-batch","pageMetadata":{"title":"Inspect a revert batch","description":"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.\n\nFor each account, `balanceBefore`/`statusBefore` is the **pre-revert** state — exactly what an undo would restore.\n\n**Following a background revert.** A bulk revert that answered `202` keeps running after the response; poll this endpoint (every few seconds is plenty) until `status` leaves `running`:\n| `status` | Meaning |\n|---|---|\n| `running` | Still working. `processedCount` of `accountCount` accounts are done (`failedCount` of them failed); `accounts` lists the ones reverted so far |\n| `completed` | Finished. `accountCount` is now the number of accounts reverted; `failures` lists accounts that could not be reverted |\n| `interrupted` | The run was cancelled (`POST /revert-batches/{batchId}/cancel`) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; `POST /revert-batches/{batchId}/retry-failed` reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts |\n\nA background run continues through our maintenance and restarts and picks up where it stopped, so `status` stays `running`. `job` shows its progress: `succeededCount`, `failedCount`, `retryingCount` (accounts waiting to retry after a temporary error) and `pendingCount` of `total`. `GET /revert-batches/{batchId}/items` lists every account with its outcome.\n\n`failures` holds up to the first 200 failed accounts (`accountId`, `code`, `message`; codes as in the single-account endpoint); `failedCount` always counts all of them. Batches that ran within their request are `completed` with an empty `failures` list — their failures were in the revert response.\n\n**Following a background undo.** An undo that answered `202` sets `status` to `undoing` until it finishes; `undoProcessedCount` of `undoTotal` accounts are done (`undoFailedCount` failed, listed in `undoFailures`, first 200), and `undoneCount` grows as accounts are restored. When it finishes, `status` returns to what it was before the undo (`completed`, or `interrupted` for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous `status`; the accounts it restored stay restored, and `POST /revert-batches/{batchId}/retry-failed` or another undo restores the rest.\n\n**Large batches.** `accounts` lists up to `accountsLimit` accounts (default and maximum 1000), oldest first; `accountsTotal` counts all of them. Page with `accountsOffset`.\n\n**Example:**\n```bash\ncurl \"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\" \\\n -H \"X-API-Key: hp_live_your_key_here\"\n```\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}","href":"/platform-api/time-machine/inspect-a-revert-batch","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For each account, \", _jsx(_components.code, {\n children: \"balanceBefore\"\n }), \"/\", _jsx(_components.code, {\n children: \"statusBefore\"\n }), \" is the \", _jsx(_components.strong, {\n children: \"pre-revert\"\n }), \" state — exactly what an undo would restore.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Following a background revert.\"\n }), \" A bulk revert that answered \", _jsx(_components.code, {\n children: \"202\"\n }), \" keeps running after the response; poll this endpoint (every few seconds is plenty) until \", _jsx(_components.code, {\n children: \"status\"\n }), \" leaves \", _jsx(_components.code, {\n children: \"running\"\n }), \":\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: _jsx(_components.code, {\n children: \"status\"\n })\n }), _jsx(_components.th, {\n children: \"Meaning\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"running\"\n })\n }), _jsxs(_components.td, {\n children: [\"Still working. \", _jsx(_components.code, {\n children: \"processedCount\"\n }), \" of \", _jsx(_components.code, {\n children: \"accountCount\"\n }), \" accounts are done (\", _jsx(_components.code, {\n children: \"failedCount\"\n }), \" of them failed); \", _jsx(_components.code, {\n children: \"accounts\"\n }), \" lists the ones reverted so far\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"completed\"\n })\n }), _jsxs(_components.td, {\n children: [\"Finished. \", _jsx(_components.code, {\n children: \"accountCount\"\n }), \" is now the number of accounts reverted; \", _jsx(_components.code, {\n children: \"failures\"\n }), \" lists accounts that could not be reverted\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"interrupted\"\n })\n }), _jsxs(_components.td, {\n children: [\"The run was cancelled (\", _jsx(_components.code, {\n children: \"POST /revert-batches/{batchId}/cancel\"\n }), \") before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; \", _jsx(_components.code, {\n children: \"POST /revert-batches/{batchId}/retry-failed\"\n }), \" reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts\"]\n })]\n })]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A background run continues through our maintenance and restarts and picks up where it stopped, so \", _jsx(_components.code, {\n children: \"status\"\n }), \" stays \", _jsx(_components.code, {\n children: \"running\"\n }), \". \", _jsx(_components.code, {\n children: \"job\"\n }), \" shows its progress: \", _jsx(_components.code, {\n children: \"succeededCount\"\n }), \", \", _jsx(_components.code, {\n children: \"failedCount\"\n }), \", \", _jsx(_components.code, {\n children: \"retryingCount\"\n }), \" (accounts waiting to retry after a temporary error) and \", _jsx(_components.code, {\n children: \"pendingCount\"\n }), \" of \", _jsx(_components.code, {\n children: \"total\"\n }), \". \", _jsx(_components.code, {\n children: \"GET /revert-batches/{batchId}/items\"\n }), \" lists every account with its outcome.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"failures\"\n }), \" holds up to the first 200 failed accounts (\", _jsx(_components.code, {\n children: \"accountId\"\n }), \", \", _jsx(_components.code, {\n children: \"code\"\n }), \", \", _jsx(_components.code, {\n children: \"message\"\n }), \"; codes as in the single-account endpoint); \", _jsx(_components.code, {\n children: \"failedCount\"\n }), \" always counts all of them. Batches that ran within their request are \", _jsx(_components.code, {\n children: \"completed\"\n }), \" with an empty \", _jsx(_components.code, {\n children: \"failures\"\n }), \" list — their failures were in the revert response.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Following a background undo.\"\n }), \" An undo that answered \", _jsx(_components.code, {\n children: \"202\"\n }), \" sets \", _jsx(_components.code, {\n children: \"status\"\n }), \" to \", _jsx(_components.code, {\n children: \"undoing\"\n }), \" until it finishes; \", _jsx(_components.code, {\n children: \"undoProcessedCount\"\n }), \" of \", _jsx(_components.code, {\n children: \"undoTotal\"\n }), \" accounts are done (\", _jsx(_components.code, {\n children: \"undoFailedCount\"\n }), \" failed, listed in \", _jsx(_components.code, {\n children: \"undoFailures\"\n }), \", first 200), and \", _jsx(_components.code, {\n children: \"undoneCount\"\n }), \" grows as accounts are restored. When it finishes, \", _jsx(_components.code, {\n children: \"status\"\n }), \" returns to what it was before the undo (\", _jsx(_components.code, {\n children: \"completed\"\n }), \", or \", _jsx(_components.code, {\n children: \"interrupted\"\n }), \" for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous \", _jsx(_components.code, {\n children: \"status\"\n }), \"; the accounts it restored stay restored, and \", _jsx(_components.code, {\n children: \"POST /revert-batches/{batchId}/retry-failed\"\n }), \" or another undo restores the rest.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Large batches.\"\n }), \" \", _jsx(_components.code, {\n children: \"accounts\"\n }), \" lists up to \", _jsx(_components.code, {\n children: \"accountsLimit\"\n }), \" accounts (default and maximum 1000), oldest first; \", _jsx(_components.code, {\n children: \"accountsTotal\"\n }), \" counts all of them. Page with \", _jsx(_components.code, {\n children: \"accountsOffset\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"2\",\n language: \"shellscript\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"shellscript\",\n children: _jsxs(_components.code, {\n language: \"shellscript\",\n numberOfLines: \"2\",\n children: [_jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#8250DF\",\n \"--shiki-dark\": \"#DCDCAA\"\n },\n children: \"curl\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" \\\\\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" -H \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"X-API-Key: hp_live_your_key_here\\\"\"\n })]\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Inspect a revert batch","description":"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.\n\nFor each account, `balanceBefore`/`statusBefore` is the **pre-revert** state — exactly what an undo would restore.\n\n**Following a background revert.** A bulk revert that answered `202` keeps running after the response; poll this endpoint (every few seconds is plenty) until `status` leaves `running`:\n| `status` | Meaning |\n|---|---|\n| `running` | Still working. `processedCount` of `accountCount` accounts are done (`failedCount` of them failed); `accounts` lists the ones reverted so far |\n| `completed` | Finished. `accountCount` is now the number of accounts reverted; `failures` lists accounts that could not be reverted |\n| `interrupted` | The run was cancelled (`POST /revert-batches/{batchId}/cancel`) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; `POST /revert-batches/{batchId}/retry-failed` reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts |\n\nA background run continues through our maintenance and restarts and picks up where it stopped, so `status` stays `running`. `job` shows its progress: `succeededCount`, `failedCount`, `retryingCount` (accounts waiting to retry after a temporary error) and `pendingCount` of `total`. `GET /revert-batches/{batchId}/items` lists every account with its outcome.\n\n`failures` holds up to the first 200 failed accounts (`accountId`, `code`, `message`; codes as in the single-account endpoint); `failedCount` always counts all of them. Batches that ran within their request are `completed` with an empty `failures` list — their failures were in the revert response.\n\n**Following a background undo.** An undo that answered `202` sets `status` to `undoing` until it finishes; `undoProcessedCount` of `undoTotal` accounts are done (`undoFailedCount` failed, listed in `undoFailures`, first 200), and `undoneCount` grows as accounts are restored. When it finishes, `status` returns to what it was before the undo (`completed`, or `interrupted` for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous `status`; the accounts it restored stay restored, and `POST /revert-batches/{batchId}/retry-failed` or another undo restores the rest.\n\n**Large batches.** `accounts` lists up to `accountsLimit` accounts (default and maximum 1000), oldest first; `accountsTotal` counts all of them. Page with `accountsOffset`.\n\n**Example:**\n```bash\ncurl \"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\" \\\n -H \"X-API-Key: hp_live_your_key_here\"\n```\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}","href":"/platform-api/time-machine/inspect-a-revert-batch","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Inspect a revert batch","operationId":"getV1OrganizationRevertbatchesBatchid","description":"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.\n\nFor each account, `balanceBefore`/`statusBefore` is the **pre-revert** state — exactly what an undo would restore.\n\n**Following a background revert.** A bulk revert that answered `202` keeps running after the response; poll this endpoint (every few seconds is plenty) until `status` leaves `running`:\n| `status` | Meaning |\n|---|---|\n| `running` | Still working. `processedCount` of `accountCount` accounts are done (`failedCount` of them failed); `accounts` lists the ones reverted so far |\n| `completed` | Finished. `accountCount` is now the number of accounts reverted; `failures` lists accounts that could not be reverted |\n| `interrupted` | The run was cancelled (`POST /revert-batches/{batchId}/cancel`) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; `POST /revert-batches/{batchId}/retry-failed` reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts |\n\nA background run continues through our maintenance and restarts and picks up where it stopped, so `status` stays `running`. `job` shows its progress: `succeededCount`, `failedCount`, `retryingCount` (accounts waiting to retry after a temporary error) and `pendingCount` of `total`. `GET /revert-batches/{batchId}/items` lists every account with its outcome.\n\n`failures` holds up to the first 200 failed accounts (`accountId`, `code`, `message`; codes as in the single-account endpoint); `failedCount` always counts all of them. Batches that ran within their request are `completed` with an empty `failures` list — their failures were in the revert response.\n\n**Following a background undo.** An undo that answered `202` sets `status` to `undoing` until it finishes; `undoProcessedCount` of `undoTotal` accounts are done (`undoFailedCount` failed, listed in `undoFailures`, first 200), and `undoneCount` grows as accounts are restored. When it finishes, `status` returns to what it was before the undo (`completed`, or `interrupted` for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous `status`; the accounts it restored stay restored, and `POST /revert-batches/{batchId}/retry-failed` or another undo restores the rest.\n\n**Large batches.** `accounts` lists up to `accountsLimit` accounts (default and maximum 1000), oldest first; `accountsTotal` counts all of them. Page with `accountsOffset`.\n\n**Example:**\n```bash\ncurl \"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\" \\\n -H \"X-API-Key: hp_live_your_key_here\"\n```\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.","parameters":["641e54ee-0753-4819-93b2-80b091bef4f1","b1e0aad1-7263-46d7-8bc7-679a8b88852a","1db7b838-9bc0-474f-8079-dcc171ae083e"],"tags":["Time Machine"],"security":["e7d2d2f6-6a5d-4f0a-9a43-550fc957ade1"],"responses":{"200":"85b1f74a-8b67-432b-9517-638e2395c541","400":"a54ea587-d936-48bb-ac87-56e62bbe1bbb","401":"bdbc54b2-901d-473d-96f9-2c531b205462","403":"2b50772d-d6a9-4f07-b45f-9f99eb449139","404":"9f124647-7a9e-4fef-b9a8-32ac157de0db","500":"55e576d9-4303-419b-a8b9-cfced71405d7","504":"2f71690c-bb4b-46a7-8e71-3159f9e635ba"},"method":"get","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/revert-batches/{batchId}","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Inspect a revert batch","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"641e54ee-0753-4819-93b2-80b091bef4f1":{"description":"Batch id returned by a revert call (or from the ledger list)","x-format":{"guid":true},"name":"batchId","in":"path","required":true,"example":"3f2b8c1e-9d4a-4e7b-8a61-0c5d2e9f7a10","schema":{"type":"string","isRequired":true,"description":"Batch id returned by a revert call (or from the ledger list)","uniqueKey":"","typeLabel":"string"}},"b1e0aad1-7263-46d7-8bc7-679a8b88852a":{"description":"Accounts per page in `accounts` (oldest first)","name":"accountsLimit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":1000,"description":"Accounts per page in `accounts` (oldest first)","uniqueKey":"","typeLabel":"integer"}},"1db7b838-9bc0-474f-8079-dcc171ae083e":{"description":"Accounts to skip — page through batches larger than `accountsLimit` with `accountsTotal`","name":"accountsOffset","in":"query","schema":{"type":"integer","minimum":0,"default":0,"description":"Accounts to skip — page through batches larger than `accountsLimit` with `accountsTotal`","uniqueKey":"","typeLabel":"integer"}}},"responses":{"85b1f74a-8b67-432b-9517-638e2395c541":{"description":"Revert batch detail","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","example":{"batchId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","tradingDay":"2026-07-07","reason":"Data feed outage","scope":"single","requestedBy":"ops@example.com","accountCount":1,"undoneCount":0,"undoneAt":null,"undoneBy":null,"undoReason":null,"createdAt":"2026-07-08T14:03:22.000Z","status":"completed","processedCount":1,"failedCount":0,"completedAt":"2026-07-08T14:03:22.000Z","failures":[],"undoTotal":null,"undoProcessedCount":null,"undoFailedCount":null,"undoFailures":[],"job":null,"accountsTotal":1,"accountsLimit":1000,"accountsOffset":0,"accounts":[{"accountId":"7c9e6679-7425-40de-944b-e07fc1f90ae7","accountNumber":"ACC-7845KXPQ","revertedTo":"2026-07-07","balanceBefore":48750,"balanceAfter":51250,"statusBefore":"failed","statusAfter":"in_progress","snapshotsVoided":1,"ordersVoided":14,"positionsClosed":1,"ordersCancelled":2,"undoneAt":null}]},"properties":{"batchId":{"type":"string","uniqueKey":"data.batchId","typeLabel":"string"},"tradingDay":{"type":"string","uniqueKey":"data.tradingDay","typeLabel":"string"},"revertTo":{"type":"string","description":"The instant (ISO, UTC) for a point-in-time batch; null for end-of-day","uniqueKey":"data.revertTo","typeLabel":"string"},"audience":{"type":"object","description":"The audience window that selected the accounts, if any","uniqueKey":"data.audience","typeLabel":"object"},"reason":{"type":"string","uniqueKey":"data.reason","typeLabel":"string"},"scope":{"type":"string","enum":["single","bulk"],"uniqueKey":"data.scope","typeLabel":"enum\u003cstring>"},"requestedBy":{"type":"string","uniqueKey":"data.requestedBy","typeLabel":"string"},"accountCount":{"type":"number","uniqueKey":"data.accountCount","typeLabel":"number"},"undoneCount":{"type":"number","uniqueKey":"data.undoneCount","typeLabel":"number"},"undoneAt":{"type":"string","uniqueKey":"data.undoneAt","typeLabel":"string"},"undoneBy":{"type":"string","uniqueKey":"data.undoneBy","typeLabel":"string"},"undoReason":{"type":"string","uniqueKey":"data.undoReason","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"data.createdAt","typeLabel":"string"},"status":{"type":"string","description":"running = a background revert is still working (also while it resumes after our maintenance) · undoing = a background undo is working · completed = finished · interrupted = a background revert was cancelled (or, for runs started before 18 October 2026, stopped early) before reaching every account","enum":["running","completed","interrupted","undoing"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"processedCount":{"type":"number","description":"Accounts processed so far (reverted + failed)","uniqueKey":"data.processedCount","typeLabel":"number"},"failedCount":{"type":"number","description":"Accounts that could not be reverted","uniqueKey":"data.failedCount","typeLabel":"number"},"completedAt":{"type":"string","description":"When the batch finished; null while running","uniqueKey":"data.completedAt","typeLabel":"string"},"failures":{"type":"array","description":"Up to the first 200 accounts of a background revert that could not be reverted","items":{"type":"object","properties":{"accountId":{"type":"string","uniqueKey":"data.failures.items.[INDEX].accountId","typeLabel":"string"},"code":{"type":"string","uniqueKey":"data.failures.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"data.failures.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"data.failures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.failures","typeLabel":"object[]"},"undoTotal":{"type":"number","description":"Latest background undo: accounts it set out to restore; null when no background undo ran","uniqueKey":"data.undoTotal","typeLabel":"number"},"undoProcessedCount":{"type":"number","description":"Latest background undo: accounts processed so far (restored + failed)","uniqueKey":"data.undoProcessedCount","typeLabel":"number"},"undoFailedCount":{"type":"number","description":"Latest background undo: accounts that could not be restored","uniqueKey":"data.undoFailedCount","typeLabel":"number"},"undoFailures":{"type":"array","description":"Latest background undo: up to the first 200 accounts that could not be restored (codes as in the undo endpoint)","items":{"type":"object","properties":{"accountId":{"type":"string","uniqueKey":"data.undoFailures.items.[INDEX].accountId","typeLabel":"string"},"code":{"type":"string","uniqueKey":"data.undoFailures.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"data.undoFailures.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"data.undoFailures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.undoFailures","typeLabel":"object[]"},"job":{"type":"object","description":"The latest background run of this batch, with per-account progress; null for batches that ran within their request","properties":{"jobId":{"type":"string","uniqueKey":"data.job.jobId","typeLabel":"string"},"kind":{"type":"string","description":"What the background run does: the revert itself, or an undo of it","enum":["revert","undo"],"uniqueKey":"data.job.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"queued = waiting to start · running = working (also while it resumes after maintenance) · completed = every account processed · cancelled = stopped by POST /cancel · failed = stopped by an unexpected error (accounts processed so far keep their new state; retry with POST /retry-failed)","enum":["queued","running","completed","cancelled","failed"],"uniqueKey":"data.job.status","typeLabel":"enum\u003cstring>"},"total":{"type":"number","description":"Accounts in the run","uniqueKey":"data.job.total","typeLabel":"number"},"pendingCount":{"type":"number","description":"Accounts not finished yet (waiting, retrying or in progress)","uniqueKey":"data.job.pendingCount","typeLabel":"number"},"succeededCount":{"type":"number","uniqueKey":"data.job.succeededCount","typeLabel":"number"},"failedCount":{"type":"number","description":"Accounts that could not be processed after their retries","uniqueKey":"data.job.failedCount","typeLabel":"number"},"cancelledCount":{"type":"number","description":"Accounts left untouched because the run was cancelled","uniqueKey":"data.job.cancelledCount","typeLabel":"number"},"retryingCount":{"type":"number","description":"Accounts waiting to retry after a temporary error (part of pendingCount)","uniqueKey":"data.job.retryingCount","typeLabel":"number"},"cancelRequested":{"type":"boolean","uniqueKey":"data.job.cancelRequested","typeLabel":"boolean"},"createdAt":{"type":"string","uniqueKey":"data.job.createdAt","typeLabel":"string"},"startedAt":{"type":"string","uniqueKey":"data.job.startedAt","typeLabel":"string"},"finishedAt":{"type":"string","uniqueKey":"data.job.finishedAt","typeLabel":"string"},"canCancel":{"type":"boolean","description":"POST /revert-batches/{batchId}/cancel is allowed now","uniqueKey":"data.job.canCancel","typeLabel":"boolean"},"canRetryFailed":{"type":"boolean","description":"POST /revert-batches/{batchId}/retry-failed is allowed now","uniqueKey":"data.job.canRetryFailed","typeLabel":"boolean"}},"uniqueKey":"data.job","typeLabel":"object"},"accountsTotal":{"type":"number","description":"Accounts in the batch; `accounts` holds one page of them","uniqueKey":"data.accountsTotal","typeLabel":"number"},"accountsLimit":{"type":"number","description":"Page size used for `accounts`","uniqueKey":"data.accountsLimit","typeLabel":"number"},"accountsOffset":{"type":"number","description":"Offset used for `accounts`","uniqueKey":"data.accountsOffset","typeLabel":"number"},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].accountId","typeLabel":"string"},"accountNumber":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].accountNumber","typeLabel":"string"},"revertedTo":{"type":"string","description":"Trading day restored, the ISO instant for a point-in-time restore, or \"initial_state\"","uniqueKey":"data.accounts.items.[INDEX].revertedTo","typeLabel":"string"},"balanceBefore":{"type":"number","description":"Balance the moment before the revert (what undo restores)","uniqueKey":"data.accounts.items.[INDEX].balanceBefore","typeLabel":"number"},"balanceAfter":{"type":"number","description":"Balance the revert restored","uniqueKey":"data.accounts.items.[INDEX].balanceAfter","typeLabel":"number"},"statusBefore":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].statusBefore","typeLabel":"string"},"statusAfter":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].statusAfter","typeLabel":"string"},"snapshotsVoided":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].snapshotsVoided","typeLabel":"number"},"ordersVoided":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].ordersVoided","typeLabel":"number"},"positionsClosed":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].positionsClosed","typeLabel":"number"},"ordersCancelled":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].ordersCancelled","typeLabel":"number"},"undoneAt":{"type":"string","description":"Set when this account has been restored by an undo","uniqueKey":"data.accounts.items.[INDEX].undoneAt","typeLabel":"string"}},"uniqueKey":"data.accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.accounts","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"batchId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","tradingDay":"2026-07-07","reason":"Data feed outage","scope":"single","requestedBy":"ops@example.com","accountCount":1,"undoneCount":0,"undoneAt":null,"undoneBy":null,"undoReason":null,"createdAt":"2026-07-08T14:03:22.000Z","status":"completed","processedCount":1,"failedCount":0,"completedAt":"2026-07-08T14:03:22.000Z","failures":[],"undoTotal":null,"undoProcessedCount":null,"undoFailedCount":null,"undoFailures":[],"job":null,"accountsTotal":1,"accountsLimit":1000,"accountsOffset":0,"accounts":[{"accountId":"7c9e6679-7425-40de-944b-e07fc1f90ae7","accountNumber":"ACC-7845KXPQ","revertedTo":"2026-07-07","balanceBefore":48750,"balanceAfter":51250,"statusBefore":"failed","statusAfter":"in_progress","snapshotsVoided":1,"ordersVoided":14,"positionsClosed":1,"ordersCancelled":2,"undoneAt":null}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"a54ea587-d936-48bb-ac87-56e62bbe1bbb":{"description":"The request does not match the documented parameters or body; `message` names the field","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"integer","example":400,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"\"limit\" must be less than or equal to 100","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["VALIDATION_ERROR"],"example":"VALIDATION_ERROR","description":"Machine-readable error code — switch on this, not on message text","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":400,"error":"Bad Request","message":"\"limit\" must be less than or equal to 100","code":"VALIDATION_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"bdbc54b2-901d-473d-96f9-2c531b205462":{"description":"Authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":401,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Unauthorized","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Authentication required","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"UNAUTHORIZED","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":401,"error":"Unauthorized","message":"Authentication required","code":"UNAUTHORIZED"}}},"exampleType":"generated"}},"exampleType":"generated"},"2b50772d-d6a9-4f07-b45f-9f99eb449139":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":403,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Forbidden","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Access denied","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"FORBIDDEN","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":403,"error":"Forbidden","message":"Access denied","code":"FORBIDDEN"}}},"exampleType":"generated"}},"exampleType":"generated"},"9f124647-7a9e-4fef-b9a8-32ac157de0db":{"description":"Batch not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","example":"BATCH_NOT_FOUND","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"Revert batch not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"code":"BATCH_NOT_FOUND","message":"Revert batch not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"55e576d9-4303-419b-a8b9-cfced71405d7":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":500,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Internal Server Error","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"An unexpected error occurred","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"INTERNAL_ERROR","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":500,"error":"Internal Server Error","message":"An unexpected error occurred","code":"INTERNAL_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"2f71690c-bb4b-46a7-8e71-3159f9e635ba":{"description":"Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":504,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Gateway Timeout","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"REQUEST_TIMEOUT","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":504,"error":"Gateway Timeout","message":"The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).","code":"REQUEST_TIMEOUT"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e7d2d2f6-6a5d-4f0a-9a43-550fc957ade1":{"X-API-Key":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"}}},"servers":{"b949171f-b56e-4c69-b8a6-d819dee3b071":{"url":"https://api.hyperprop.com/platform","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"},"schema":{"title":"X-API-Key","type":"string","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-API-Key","name":"X-API-Key"}],"title":"X-API-Key"}]},"originalFileLocation":"https://api.hyperprop.com/platform/openapi.json"},"subdomain":"hyperprop-401fc39d","siteName":"Hyperprop Platform API","title":"Inspect a revert batch - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:10.239Z","originalFileLocation":"platform-api/time-machine/inspect-a-revert-batch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone. For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore. Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running: | status | Meaning | |---|---| | running | Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far | | completed | Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted | | interrupted | The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts | A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome. failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response. Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest. Large batches. accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset. Example: bash curl \u0026quot;https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; Access: read-only and full-access API keys. Dashboard members need view access to Operations \u0026amp; time machine.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Inspect a revert batch - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone. For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore. Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running: | status | Meaning | |---|---| | running | Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far | | completed | Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted | | interrupted | The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts | A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome. failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response. Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest. Large batches. accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset. Example: bash curl \u0026quot;https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; Access: read-only and full-access API keys. Dashboard members need view access to Operations \u0026amp; time machine.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Time+Machine\u0026amp;title=Inspect+a+revert+batch\u0026amp;description=Everything+one+revert+batch+did%2C+account+by+account%3A+the+balance+and+status+each+account+had+before+and+after%2C+how+many+snapshots+and+orders+were+voided%2C+whethe\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=61476680564e2a95eaf022b58b8bd0d59e545709242c77c1d4274b48a75fcbb5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Inspect a revert batch - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone. For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore. Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running: | status | Meaning | |---|---| | running | Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far | | completed | Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted | | interrupted | The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts | A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome. failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response. Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest. Large batches. accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset. Example: bash curl \u0026quot;https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; Access: read-only and full-access API keys. Dashboard members need view access to Operations \u0026amp; time machine.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Time+Machine\u0026amp;title=Inspect+a+revert+batch\u0026amp;description=Everything+one+revert+batch+did%2C+account+by+account%3A+the+balance+and+status+each+account+had+before+and+after%2C+how+many+snapshots+and+orders+were+voided%2C+whethe\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=61476680564e2a95eaf022b58b8bd0d59e545709242c77c1d4274b48a75fcbb5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#253CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-api/time-machine/inspect-a-revert-batch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperprop.com/#organization\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperprop.com#website\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch\",\"name\":\"Inspect a revert batch\",\"description\":\"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone. For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore. Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running: | status | Meaning | |---|---| | running | Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far | | completed | Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted | | interrupted | The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts | A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome. failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response. Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest. Large batches. accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset. Example: bash curl \\\"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\\\" \\\\ -H \\\"X-API-Key: hp_live_your_key_here\\\" Access: read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.\",\"dateModified\":\"2026-11-15T15:41:10.239Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform API\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/list-close-all-runs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Time Machine\",\"item\":\"https://docs.hyperprop.com/platform-api/time-machine/list-revert-batches\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Inspect a revert batch\",\"item\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch#apireference\",\"headline\":\"Inspect a revert batch\",\"name\":\"Inspect a revert batch\",\"description\":\"Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone. For each account, balanceBefore/statusBefore is the pre-revert state — exactly what an undo would restore. Following a background revert. A bulk revert that answered 202 keeps running after the response; poll this endpoint (every few seconds is plenty) until status leaves running: | status | Meaning | |---|---| | running | Still working. processedCount of accountCount accounts are done (failedCount of them failed); accounts lists the ones reverted so far | | completed | Finished. accountCount is now the number of accounts reverted; failures lists accounts that could not be reverted | | interrupted | The run was cancelled (POST /revert-batches/{batchId}/cancel) before reaching every account. Accounts already reverted stay reverted and can be undone with this batch; POST /revert-batches/{batchId}/retry-failed reverts the rest. Runs started before 18 October 2026 could also stop early when our service restarted; those cannot be retried, so run the revert again for the remaining accounts | A background run continues through our maintenance and restarts and picks up where it stopped, so status stays running. job shows its progress: succeededCount, failedCount, retryingCount (accounts waiting to retry after a temporary error) and pendingCount of total. GET /revert-batches/{batchId}/items lists every account with its outcome. failures holds up to the first 200 failed accounts (accountId, code, message; codes as in the single-account endpoint); failedCount always counts all of them. Batches that ran within their request are completed with an empty failures list — their failures were in the revert response. Following a background undo. An undo that answered 202 sets status to undoing until it finishes; undoProcessedCount of undoTotal accounts are done (undoFailedCount failed, listed in undoFailures, first 200), and undoneCount grows as accounts are restored. When it finishes, status returns to what it was before the undo (completed, or interrupted for a revert that had stopped early). Like a background revert, a background undo continues through our maintenance and restarts and can be cancelled. A cancelled undo returns the batch to its previous status; the accounts it restored stay restored, and POST /revert-batches/{batchId}/retry-failed or another undo restores the rest. Large batches. accounts lists up to accountsLimit accounts (default and maximum 1000), oldest first; accountsTotal counts all of them. Page with accountsOffset. Example: bash curl \\\"https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890\\\" \\\\ -H \\\"X-API-Key: hp_live_your_key_here\\\" Access: read-only and full-access API keys. Dashboard members need view access to Operations \u0026 time machine.\",\"url\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch#webpage\"},\"dateModified\":\"2026-11-15T15:41:10.239Z\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperprop Platform API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperprop Platform API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform-api/time-machine/inspect-a-revert-batch.md","siteName":"Hyperprop Platform API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Platform API","pages":[{"group":"Trading accounts","pages":[{"title":"List close-all runs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs","href":"/platform-api/trading-accounts/list-close-all-runs"},{"title":"Get trading accounts for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/get-trading-accounts-for-your-organization"},{"title":"Create a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/create-a-trading-account"},{"title":"Get bulk operation details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/bulk-operations/{batchId}","href":"/platform-api/trading-accounts/get-bulk-operation-details"},{"title":"Get a close-all run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs/{runId}","href":"/platform-api/trading-accounts/get-a-close-all-run"},{"title":"Get active traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/active-traders","href":"/platform-api/trading-accounts/get-active-traders"},{"title":"Get daily account and trader activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/activity","href":"/platform-api/trading-accounts/get-daily-account-and-trader-activity"},{"title":"Bulk-create unlinked accounts with import keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk","href":"/platform-api/trading-accounts/bulk-create-unlinked-accounts-with-import-keys"},{"title":"Bulk update trading accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts"},{"title":"Close all positions across accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/flatten","href":"/platform-api/trading-accounts/close-all-positions-across-accounts"},{"title":"Get open positions and equity for many accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions","href":"/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts"},{"title":"Get a specific trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/get-a-specific-trading-account"},{"title":"Update a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/update-a-trading-account"},{"title":"Get an account's event log and session history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/activity","href":"/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history"},{"title":"List an account's balance adjustments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/list-an-accounts-balance-adjustments"},{"title":"Credit or debit a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/credit-or-debit-a-trading-account"},{"title":"Get account change history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/changes","href":"/platform-api/trading-accounts/get-account-change-history"},{"title":"Get an account's daily P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/daily-pnl","href":"/platform-api/trading-accounts/get-an-accounts-daily-p\u0026l"},{"title":"Turn an account off (pause)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/deactivate","href":"/platform-api/trading-accounts/turn-an-account-off-pause"},{"title":"Get an account's equity and unrealized P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/equity","href":"/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p\u0026l"},{"title":"Close all positions on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/flatten","href":"/platform-api/trading-accounts/close-all-positions-on-an-account"},{"title":"Get an account's order event timeline","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/order-events","href":"/platform-api/trading-accounts/get-an-accounts-order-event-timeline"},{"title":"Get an account's order history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/orders","href":"/platform-api/trading-accounts/get-an-accounts-order-history"},{"title":"Get an account's open positions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/positions","href":"/platform-api/trading-accounts/get-an-accounts-open-positions"},{"title":"Turn an account back on","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/reactivate","href":"/platform-api/trading-accounts/turn-an-account-back-on"},{"title":"Unlink a trader (issues a fresh import key)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/unlink","href":"/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key"},{"title":"Get a balance adjustment by reference","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference}","href":"/platform-api/trading-accounts/get-a-balance-adjustment-by-reference"},{"title":"Cancel working orders on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/orders/cancel","href":"/platform-api/trading-accounts/cancel-working-orders-on-an-account"},{"title":"Close one position on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/positions/{contract}/close","href":"/platform-api/trading-accounts/close-one-position-on-an-account"}]},{"group":"Traders","pages":[{"title":"List trader identity bindings (customer ⇄ Hyperprop login)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trader-bindings","href":"/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login"},{"title":"Get traders for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders","href":"/platform-api/traders/get-traders-for-your-organization"},{"title":"Get a specific trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders/{traderId}","href":"/platform-api/traders/get-a-specific-trader"},{"title":"Update a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/traders/{traderId}","href":"/platform-api/traders/update-a-trader"},{"title":"Rebind a customer to a new Hyperprop login (support flow)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trader-bindings/{bindingId}/rebind","href":"/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow"}]},{"group":"Trading plans","pages":[{"title":"Get trading plans for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans","href":"/platform-api/trading-plans/get-trading-plans-for-your-organization"},{"title":"Create a new trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-plans","href":"/platform-api/trading-plans/create-a-new-trading-plan"},{"title":"Get a specific trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/get-a-specific-trading-plan"},{"title":"Delete a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/delete-a-trading-plan"},{"title":"Update a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/update-a-trading-plan"}]},{"group":"Trading rules","pages":[{"title":"Get trading rules for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization"},{"title":"Create a new trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule"},{"title":"Get a specific trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/get-a-specific-trading-rule"},{"title":"Delete a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/delete-a-trading-rule"},{"title":"Update a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/update-a-trading-rule"}]},{"group":"Instruments","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/instruments","href":"/platform-api/instruments/list-instruments"}]},{"group":"Lockouts","pages":[{"title":"List all active lockouts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts","href":"/platform-api/lockouts/list-all-active-lockouts"},{"title":"Create admin lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/lockouts","href":"/platform-api/lockouts/create-admin-lockout"},{"title":"Get daily lockout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/activity","href":"/platform-api/lockouts/get-daily-lockout-activity"},{"title":"Get lockout status for account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/get-lockout-status-for-account"},{"title":"Remove lockout from account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/remove-lockout-from-account"},{"title":"Update active lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/update-active-lockout"}]},{"group":"Payouts","pages":[{"title":"Payout queue — bulk payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payout-eligibility","href":"/platform-api/payouts/payout-queue-—-bulk-payout-eligibility"},{"title":"Get daily payout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payouts/activity","href":"/platform-api/payouts/get-daily-payout-activity"},{"title":"Check payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payout-eligibility","href":"/platform-api/payouts/check-payout-eligibility"},{"title":"List payouts for an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/list-payouts-for-an-account"},{"title":"Execute a payout (balance withdrawal)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/execute-a-payout-balance-withdrawal"},{"title":"Reverse a payout (restore the withdrawn balance)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts/{payoutId}/reverse","href":"/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance"}]},{"group":"Purchases","pages":[{"title":"Get purchases for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases","href":"/platform-api/purchases/get-purchases-for-your-organization"},{"title":"Get a specific purchase","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases/{purchaseId}","href":"/platform-api/purchases/get-a-specific-purchase"}]},{"group":"Time Machine","pages":[{"title":"List revert batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches","href":"/platform-api/time-machine/list-revert-batches"},{"title":"Get revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/time-machine-settings","href":"/platform-api/time-machine/get-revert-settings"},{"title":"Update revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/time-machine-settings","href":"/platform-api/time-machine/update-revert-settings"},{"title":"Bulk revert accounts to a trading day or an instant","description":"**Time Machine, org-wide:** the same operation as the single-account revert, applied to many accounts in one call — built for exchange/platform outages.\n\n**Who** — exactly one of:\n- `accountIds` (max 5000) — a targeted revert;\n- `allAccounts: true` — every account in your organization with activity after the restore point;\n- `audience: { from, to, condition }` — the accounts an outage window actually touched: `traded` (any fill in the window), `loss` (net realized P\u0026L in the window below zero), `failed` (the account failed inside the window), or `failed_or_loss`. Everyone else is left alone.\n\n**To when** — `tradingDay` (end-of-day state of that Chicago trading day) or `revertTo` (exact state at an instant; see the single-account endpoint for how it is reconstructed). With an `audience` and neither given, the accounts go back to `audience.from` — the point at which the issues began.\n\nEach account is processed independently: the response lists per-account results and per-account failures (one bad account never aborts the batch — per-account error codes match the single-account endpoint). An account with a payout, payout reversal, balance adjustment or firm balance change after the close its balance would be rebuilt from is reported with `PAYOUT_OR_ADJUSTMENT_IN_RANGE` and is neither closed out nor changed. All changes share one `batchId` in the audit trail, and the batch records the restore point and the audience that selected it.\n\n**Size, and background runs.** One call may revert up to **5000** accounts. A revert takes roughly half a second per account, so:\n- Up to 1000 accounts without `background`: the call works through every account and answers `200` with the full per-account report (unchanged).\n- More than 1000 accounts, or `\"background\": true` at any size: the call records the batch and answers **`202`** right away with `{ batchId, status: \"running\", total, … }`. The revert keeps going after the response. Poll `GET /revert-batches/{batchId}` for `status` (`running` → `completed`), `processedCount`, `failedCount`, `failures` and `job`. Use `background` for anything beyond a few dozen accounts if your HTTP client or proxy has a short timeout.\n\n**Background runs are durable.** A background revert continues on its own through our maintenance and restarts: it picks up where it stopped and never processes an account twice. Accounts are processed in small groups at a steady pace, so live trading is not slowed down. An account that hits a temporary error is retried automatically (up to 5 attempts, with increasing delays) before it is reported as failed. While it runs you can follow every account with `GET /revert-batches/{batchId}/items`, stop it with `POST /revert-batches/{batchId}/cancel`, and once it has finished, run the failed accounts again with `POST /revert-batches/{batchId}/retry-failed`. A batch can only have one background run at a time, and an account that another background run is working on waits until that run has finished with it.\n\nWhile a batch is running it cannot be undone (`BATCH_RUNNING`); undo it once it has finished.\n\n**Large previews.** A preview reports every account individually up to 1000 matches. Above 1000 it reports the first 100 (or `previewLimit`, at most 1000) and sets `previewTruncated: true`; `total` always carries the full match count. Pass `previewLimit` to keep any preview quick (for example `100` for a confirmation screen).\n\n**Example — an outage at the NY open (09:30–10:00 ET on 8 Sep 2026) failed some accounts and cost others money; put exactly those accounts back to 09:30:**\n```json\n{\n \"audience\": { \"from\": \"2026-09-08T13:30:00Z\", \"to\": \"2026-09-08T14:00:00Z\", \"condition\": \"failed_or_loss\" },\n \"reason\": \"Feed outage at the NY open, 8 Sep\",\n \"preview\": true\n}\n```\n\n**Undoable.** The returned `batchId` is a Time Machine ledger entry (`GET /revert-batches`). If the batch was a mistake, `POST /revert-batches/{batchId}/undo` restores every account in it to its pre-revert state in one call — accounts with new trader activity since the revert are skipped and reported individually.\n\n**Batch-level error codes:**\n| Code | Status | Meaning |\n|------|:---:|---------|\n| `NO_ACCOUNTS` | 400 | Nothing to revert (empty accountIds, or allAccounts found no affected accounts). An empty `audience` is NOT an error: 200 with `reverted: 0` |\n| `TOO_MANY_ACCOUNTS` | 400 | More than 5000 accounts in one call — split into batches. The response carries `matched` (how many accounts matched) and `max` |\n| `AMBIGUOUS_TARGET` | 400 | Not exactly one of accountIds / allAccounts / audience |\n| `INVALID_AUDIENCE_WINDOW` | 400 | audience.from is not before audience.to, or not timestamps |\n| `INVALID_REVERT_POINT` | 400 | Both tradingDay and revertTo, revertTo not a timestamp, or in the future |\n| `AUDIENCE_ERROR` | 500 | Could not read the activity needed to resolve the audience — retry |\n| `TARGETS_ERROR` | 500 | allAccounts: could not read the activity needed to find the affected accounts — retry |\n| `REVERT_START_ERROR` | 500 | Background run: the batch could not be recorded, so nothing was started or changed — retry |\n\n`allAccounts` and `audience` consider every account in your organization. A failure to read any of them is an error; the selection is never silently partial.\n\n**Recommended flow:** run with `\"preview\": true` first — you get the full per-account impact report (balances restored, accounts revived, orders voided) with zero changes — then execute.\n\n**Example — preview an org-wide revert, then execute:**\n```bash\n# 1. Dry run\ncurl -X POST \".../v1/organization/accounts/revert-trading-day\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"tradingDay\": \"2026-07-07\", \"allAccounts\": true, \"reason\": \"Data feed outage\", \"preview\": true }'\n\n# 2. Execute\ncurl -X POST \".../v1/organization/accounts/revert-trading-day\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"tradingDay\": \"2026-07-07\", \"allAccounts\": true, \"reason\": \"Data feed outage\" }'\n```\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Operations \u0026 time machine.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/revert-trading-day","href":"/platform-api/time-machine/bulk-revert-accounts-to-a-trading-day-or-an-instant"},{"title":"Inspect a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}","href":"/platform-api/time-machine/inspect-a-revert-batch"},{"title":"Revert an account to a trading day or an instant","description":"**Time Machine** (outage recovery): restore an account to its **end-of-day state** on the given trading day — or, with `revertTo`, to its **exact state at an instant** (the moment an outage began) — in one call. The reverted period stops existing for the trader.\n\n**Two ways to name the restore point**\n| Field | Restores to | Cutoff (everything after is voided) |\n|---|---|---|\n| `tradingDay` | the end-of-day snapshot of that Chicago trading day (or the latest traded day before it), rolled forward through the fills booked after the snapshot was taken up to that day's close (weekend trading, the hour after the 16:00 snapshot), the same way as for `revertTo` | that day's 17:00 America/Chicago close |\n| `revertTo` | the account's state at that instant: the balance the trader had at that moment, including every fill up to it. The high-water mark follows your firm's Time Machine setting `instantRevertHighWaterMark` (`GET /time-machine-settings`); by default it is the one at the instant (intraday-trailing plans take the highest balance on the way; end-of-day plans keep the base close). The instant's own trading day keeps a snapshot cut at the instant unless the setting `instantRevertDaySnapshot` is `void`. The status is the one in force at the instant (an account that failed later comes back to life). The daily starting balance is the one in force at the instant while that trading session is still open; once a daily close has passed since the instant, the restored balance becomes the starting balance of the current day. | the instant itself |\n\n**What it does — the reverted period stops existing for the trader:**\n1. **Closes any open positions and cancels all working orders first** (reason: \"Trading day reverted by your firm: …\") — no live exposure survives into the reverted world, and the closing fills land inside the voided window so they are erased too. **New orders are refused from just before this step until step 8 is done**: the account carries a temporary lockout (`cause: \"admin\"`, reason \"Your firm is restoring this account…\") that is removed as soon as the trade engine confirms it reloaded the account. A lockout the account already had stays in force. If the engine never confirms the reload (`ENGINE_RELOAD_UNCONFIRMED`), the temporary lockout ends by itself after 15 minutes\n2. Loads the account's end-of-day snapshot for `tradingDay` (or the latest traded day before it — e.g. reverting to a Sunday uses Friday's close)\n3. Restores `currentBalance`, `highWaterMark`, and the daily baseline from that snapshot, with the profit or loss of the fills that are kept (booked after the snapshot, before the cutoff) included in the balance\n4. Restores the snapshot's `status` and `violationReason` — an account failed during the bad day comes back to life\n5. **Voids the daily snapshots after the target day** for this account, so consistency checks and daily-stats endpoints no longer see the reverted days (they are archived, not destroyed) — for a point-in-time restore, the instant's own day is kept cut at the instant by default (see `GET /time-machine-settings`)\n6. **Voids every order and fill after the reverted day's close** (17:00 America/Chicago): they disappear from the trader's journal, order history, and trade blotter, and the account's performance stats (trade count, win rate) are recomputed from the surviving fills. Voided activity is kept for audit — nothing is deleted.\n7. Writes the audit trail (`GET /trading-accounts/{accountId}/changes`), stamps `metadata.last_revert`, and fires `account.updated` (+ status events when the status moved) with `trigger: \"trading_day_revert\"`\n and `account.trading_day_reverted` with the batch, restore point, affected trading days, the day snapshots it changed and the voided fills (fill ids as the fills and reconciliation endpoints return them; up to 500 inline, all of them via `GET /revert-batches/{batchId}/accounts/{accountId}/voided-fills`). `metadata.last_revert` records the restore point, reason, batch id and who ran it as `initiated_by` (`firm_user`, `api_key` or `hyperprop`) — never a person's email\n8. Applies the restored state immediately and updates the trader's open terminal in real time (balances, history, and journal), with an explanatory notice. A bulk revert does this for each group of accounts right after they are written, not once at the end\n\n**When it stops, and what it answers:**\n- `tradingDay` must be a day whose 17:00 America/Chicago close has passed; today (before its close) or a future day answers `400 INVALID_REVERT_POINT`. To go back to a moment earlier today, use `revertTo`.\n- If the trading engine does not confirm that the account's positions and orders were closed, the account is not reverted: `502 FLATTEN_UNCONFIRMED` (in a bulk revert, a `FLATTEN_UNCONFIRMED` failure for that account). Nothing was changed for it; retry.\n- If the revert can't be recorded in the Time Machine ledger (so it could not be undone), nothing is changed: `500 REVERT_START_ERROR`.\n- If the revert was saved but the trading engine did not confirm it reloaded the account after three tries, the answer is `502 ENGINE_RELOAD_UNCONFIRMED` with the usual result under `data` (including `batchId`), so you can undo it or contact support. Undo answers the same way.\n\nIf the account had never traded on or before the target day (e.g. it was created during the outage day itself), it is restored to its **pristine initial state** — starting balance, in_progress, entire order history voided. The account keeps existing; reverting never deletes accounts.\n\n**Payouts and balance adjustments are never undone.** The restored balance is rebuilt from an end-of-day close and the trades after it. If a payout, payout reversal, balance adjustment (including mass credits) or a balance change or reset made by your firm happened after that close (the end-of-day balance is recorded when the session ends at about 16:00 America/Chicago, so this includes the hour before the 17:00 roll), the account is refused with `409 PAYOUT_OR_ADJUSTMENT_IN_RANGE` before anything is closed or changed, and the message names the latest such change. Choose a restore point after the close of the trading day it happened on, or correct the balance with a balance adjustment instead. A preview reports the same refusal.\n\n**Undoable.** Every executed revert returns a `batchId` and appears in the Time Machine ledger (`GET /revert-batches`). Nothing a revert touches is destroyed, so if you reverted by mistake, `POST /revert-batches/{batchId}/undo` puts the account back exactly where it was — as long as the trader hasn't produced new activity since (see that endpoint for the rules).\n\n**Notes:**\n- `preview: true` never touches positions — the flatten only happens on execute.\n- Consistency: reverted days are removed from the day list automatically (their snapshots are voided).\n\n**Recommended flow (calendar UI):** call with `\"preview\": true` first to show the operator what will happen (restored balance, status transition, orders voided), then call again without `preview` to execute.\n\n**Error codes:**\n| Code | Status | Meaning |\n|------|:---:|---------|\n| `INVALID_REVERT_POINT` | 400 | Neither/both of tradingDay and revertTo, revertTo not a timestamp, or revertTo in the future |\n| `ACCOUNT_NOT_FOUND` | 404 | Account does not exist or belongs to a different organization |\n| `PAYOUT_OR_ADJUSTMENT_IN_RANGE` | 409 | A payout, payout reversal, balance adjustment or firm balance change happened after the close the balance would be rebuilt from; nothing was changed |\n| `ACCOUNT_CHANGED` | 409 | The account's balance or status changed while it was being reverted (for example a payout or balance adjustment landed at the same moment); nothing was changed — send the revert again |\n| `LEDGER_READ_ERROR` | 500 | Could not check the account for payouts and balance adjustments — retry |\n| `SNAPSHOT_FETCH_ERROR` | 500 | Could not read the account's daily snapshots — retry |\n| `BALANCE_AT_INSTANT_ERROR` | 500 | Could not read the fills needed to roll the balance forward to revertTo — retry |\n| `ACCOUNT_FETCH_ERROR` | 500 | Could not read the account — retry |\n| `PREVIEW_COUNT_ERROR` | 500 | Preview only: could not count the orders a revert would void — retry |\n| `SNAPSHOT_DELETE_ERROR` | 500 | Failed to void post-revert snapshots — retry (idempotent) |\n| `ORDER_VOID_ERROR` | 500 | Failed to void the order activity after the revert point — retry (idempotent) |\n| `REVERT_UPDATE_ERROR` | 500 | Failed to write the restored account state — retry (idempotent) |\n\nThe revert is safe to retry: every step is idempotent (already-voided rows keep their original stamp, and the state write is absolute). When a step fails after rows were voided, those rows are restored before the error is returned, so a failed account is left as it was.\n\nA successful result can carry `warnings`: parts that did not complete although the account was restored (for example, the undo record could not be written, so this account cannot be undone with its batch).\n\n**Example — preview, then execute:**\n```bash\n# 1. Dry run — nothing changes\ncurl -X POST \".../v1/organization/accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/revert-trading-day\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"tradingDay\": \"2026-07-07\", \"reason\": \"Data feed outage\", \"preview\": true }'\n\n# 2. Execute\ncurl -X POST \".../v1/organization/accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/revert-trading-day\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{ \"tradingDay\": \"2026-07-07\", \"reason\": \"Data feed outage\" }'\n```\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Operations \u0026 time machine.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/revert-trading-day","href":"/platform-api/time-machine/revert-an-account-to-a-trading-day-or-an-instant"},{"title":"Cancel a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/cancel","href":"/platform-api/time-machine/cancel-a-background-run"},{"title":"List the accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/items","href":"/platform-api/time-machine/list-the-accounts-of-a-background-run"},{"title":"Retry the failed accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/retry-failed","href":"/platform-api/time-machine/retry-the-failed-accounts-of-a-background-run"},{"title":"Undo a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/undo","href":"/platform-api/time-machine/undo-a-revert-batch"},{"title":"List the fills a revert voided on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/accounts/{accountId}/voided-fills","href":"/platform-api/time-machine/list-the-fills-a-revert-voided-on-an-account"}]},{"group":"Mass credit","pages":[{"title":"List balance adjustment batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/list-balance-adjustment-batches"},{"title":"Credit back an incident window's losses","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/credit-back-an-incident-windows-losses"},{"title":"List bulk jobs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs","href":"/platform-api/mass-credit/list-bulk-jobs"},{"title":"Preview a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/preview","href":"/platform-api/mass-credit/preview-a-balance-credit"},{"title":"Preview a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews","href":"/platform-api/mass-credit/preview-a-mass-credit"},{"title":"List mass credit templates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/list-mass-credit-templates"},{"title":"Create a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/create-a-mass-credit-template"},{"title":"Get a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/{batchId}","href":"/platform-api/mass-credit/get-a-balance-adjustment-batch"},{"title":"Get a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}","href":"/platform-api/mass-credit/get-a-bulk-job"},{"title":"Delete a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/delete-a-mass-credit-template"},{"title":"Update a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/update-a-mass-credit-template"},{"title":"Retry a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/retry","href":"/platform-api/mass-credit/retry-a-balance-adjustment-batch"},{"title":"Reverse a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/reverse","href":"/platform-api/mass-credit/reverse-a-balance-credit"},{"title":"Cancel a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/cancel","href":"/platform-api/mass-credit/cancel-a-bulk-job"},{"title":"Export a bulk job's items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/export","href":"/platform-api/mass-credit/export-a-bulk-jobs-items-as-csv"},{"title":"List a bulk job's items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/items","href":"/platform-api/mass-credit/list-a-bulk-jobs-items"},{"title":"Pause a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/pause","href":"/platform-api/mass-credit/pause-a-bulk-job"},{"title":"Resume a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/resume","href":"/platform-api/mass-credit/resume-a-bulk-job"},{"title":"Retry a bulk job's failed items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/retry","href":"/platform-api/mass-credit/retry-a-bulk-jobs-failed-items"},{"title":"Reverse a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/jobs/{jobId}/reverse","href":"/platform-api/mass-credit/reverse-a-mass-credit"},{"title":"Confirm a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/confirm","href":"/platform-api/mass-credit/confirm-a-mass-credit"},{"title":"Add accounts to a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/inputs","href":"/platform-api/mass-credit/add-accounts-to-a-draft-preview"},{"title":"Start a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/start","href":"/platform-api/mass-credit/start-a-draft-preview"}]},{"group":"Webhooks","pages":[{"title":"View webhook delivery history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries","href":"/platform-api/webhooks/view-webhook-delivery-history"},{"title":"List all webhooks","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks","href":"/platform-api/webhooks/list-all-webhooks"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks","href":"/platform-api/webhooks/register-a-webhook-endpoint"},{"title":"Get daily webhook delivery activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/activity","href":"/platform-api/webhooks/get-daily-webhook-delivery-activity"},{"title":"Inspect a webhook event and all delivery attempts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/{deliveryId}","href":"/platform-api/webhooks/inspect-a-webhook-event-and-all-delivery-attempts"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/get-webhook-details"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/delete-a-webhook"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhook-deliveries/{deliveryId}/redeliver","href":"/platform-api/webhooks/redeliver-a-webhook-delivery"},{"title":"Get webhook endpoint delivery and latency metrics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}/metrics","href":"/platform-api/webhooks/get-webhook-endpoint-delivery-and-latency-metrics"},{"title":"Rotate signing secret","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/rotate-secret","href":"/platform-api/webhooks/rotate-signing-secret"},{"title":"Simulate any event type (QA fixture)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/simulate","href":"/platform-api/webhooks/simulate-any-event-type-qa-fixture"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/test","href":"/platform-api/webhooks/send-a-test-event"}]},{"group":"Events","pages":[{"title":"List all organization events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events","href":"/platform-api/events/list-all-organization-events"},{"title":"Inspect one event and all its webhook deliveries","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/{eventId}","href":"/platform-api/events/inspect-one-event-and-all-its-webhook-deliveries"}]},{"group":"Real-time streams","pages":[{"title":"Real-time event stream (WebSocket)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/stream","href":"/platform-api/real-time-streams/real-time-event-stream-websocket"},{"title":"Create a trading stream token","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/stream-token","href":"/platform-api/real-time-streams/create-a-trading-stream-token"}]},{"group":"Reconciliation","pages":[{"title":"Get account balances (bulk, reconciliation-friendly)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balances","href":"/platform-api/reconciliation/get-account-balances-bulk-reconciliation-friendly"},{"title":"Reconcile a trading day in one call","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/reconciliation","href":"/platform-api/reconciliation/reconcile-a-trading-day-in-one-call"},{"title":"Get end-of-day account snapshots","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/accounts","href":"/platform-api/reconciliation/get-end-of-day-account-snapshots"},{"title":"Get fills for a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/fills","href":"/platform-api/reconciliation/get-fills-for-a-trading-day"}]},{"group":"Analytics","pages":[{"title":"Get organization analytics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics","href":"/platform-api/analytics/get-organization-analytics"},{"title":"Get hourly activity by weekday","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/hourly","href":"/platform-api/analytics/get-hourly-activity-by-weekday"},{"title":"Get revenue breakdown","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/revenue","href":"/platform-api/analytics/get-revenue-breakdown"},{"title":"Get top traders over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/top-traders","href":"/platform-api/analytics/get-top-traders-over-time"}]},{"group":"Risk","pages":[{"title":"Get your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alert-limits","href":"/platform-api/risk/get-your-alert-limits"},{"title":"Set your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/alert-limits","href":"/platform-api/risk/set-your-alert-limits"},{"title":"List alerts raised by your limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alerts","href":"/platform-api/risk/list-alerts-raised-by-your-limits"},{"title":"Get trader behavior by plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/behavior","href":"/platform-api/risk/get-trader-behavior-by-plan"},{"title":"Get plan performance by purchase month","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/cohorts","href":"/platform-api/risk/get-plan-performance-by-purchase-month"},{"title":"Read exposure and concentration","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure","href":"/platform-api/risk/read-exposure-and-concentration"},{"title":"List exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure-limits","href":"/platform-api/risk/list-exposure-limits"},{"title":"Set exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/exposure-limits","href":"/platform-api/risk/set-exposure-limits"},{"title":"Read the risk flags of accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/flags","href":"/platform-api/risk/read-the-risk-flags-of-accounts"},{"title":"List flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox","href":"/platform-api/risk/list-flagged-traders"},{"title":"List link clearances","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/link-clearances","href":"/platform-api/risk/list-link-clearances"},{"title":"Clear two traders to share a device or address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/link-clearances","href":"/platform-api/risk/clear-two-traders-to-share-a-device-or-address"},{"title":"Get traders linked by a shared device or IP address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/linked-traders","href":"/platform-api/risk/get-traders-linked-by-a-shared-device-or-ip-address"},{"title":"List news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/news-windows","href":"/platform-api/risk/list-news-windows"},{"title":"Add or update news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/news-windows","href":"/platform-api/risk/add-or-update-news-windows"},{"title":"Get a payout forecast for the next 7 and 30 days","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/payout-forecast","href":"/platform-api/risk/get-a-payout-forecast-for-the-next-7-and-30-days"},{"title":"Get per-plan unit economics and sustainability flags","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/plan-economics","href":"/platform-api/risk/get-per-plan-unit-economics-and-sustainability-flags"},{"title":"Get monthly firm P\u0026L (revenue vs payouts vs platform costs)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/pnl","href":"/platform-api/risk/get-monthly-firm-p\u0026l-revenue-vs-payouts-vs-platform-costs"},{"title":"List daily risk reports","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports","href":"/platform-api/risk/list-daily-risk-reports"},{"title":"Get the summary email settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/summary-email","href":"/platform-api/risk/get-the-summary-email-settings"},{"title":"Set the summary email","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/summary-email","href":"/platform-api/risk/set-the-summary-email"},{"title":"List today's provisional risk pairs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/today","href":"/platform-api/risk/list-todays-provisional-risk-pairs"},{"title":"Detect self-hedging, hedging and copy trading","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/trading-patterns","href":"/platform-api/risk/detect-self-hedging-hedging-and-copy-trading"},{"title":"Read the risk money summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/value","href":"/platform-api/risk/read-the-risk-money-summary"},{"title":"Read one risk finding with its proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/findings/{findingId}","href":"/platform-api/risk/read-one-risk-finding-with-its-proof"},{"title":"Count flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox/count","href":"/platform-api/risk/count-flagged-traders"},{"title":"Set the review state of a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/inbox/{traderId}","href":"/platform-api/risk/set-the-review-state-of-a-flagged-trader"},{"title":"Revoke a link clearance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/link-clearances/{clearanceId}","href":"/platform-api/risk/revoke-a-link-clearance"},{"title":"Read a risk match export","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/match-exports/{exportId}","href":"/platform-api/risk/read-a-risk-match-export"},{"title":"Delete a news window","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/news-windows/{windowId}","href":"/platform-api/risk/delete-a-news-window"},{"title":"List stored trading patterns","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/patterns/stored","href":"/platform-api/risk/list-stored-trading-patterns"},{"title":"Read the daily risk report of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}","href":"/platform-api/risk/read-the-daily-risk-report-of-a-trading-day"},{"title":"List every risk match of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}/matches","href":"/platform-api/risk/list-every-risk-match-of-a-trading-day"},{"title":"List the decisions on a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/list-the-decisions-on-a-trader"},{"title":"Record a decision on a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/record-a-decision-on-a-flagged-trader"},{"title":"Read one trader's risk findings with their proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/findings","href":"/platform-api/risk/read-one-traders-risk-findings-with-their-proof"},{"title":"Rebuild the full risk match list of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/reports/{tradingDay}/matches/export","href":"/platform-api/risk/rebuild-the-full-risk-match-list-of-a-trading-day"}]},{"group":"Trader insights","pages":[{"title":"Read trader sentiment over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/sentiment","href":"/platform-api/trader-insights/read-trader-sentiment-over-time"},{"title":"List your top traders by realized performance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/top-traders","href":"/platform-api/trader-insights/list-your-top-traders-by-realized-performance"},{"title":"List the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist","href":"/platform-api/trader-insights/list-the-traders-you-follow"},{"title":"Get live positioning across all accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning","href":"/platform-api/trader-insights/get-live-positioning-across-all-accounts"},{"title":"List the entries and exits of the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist/activity","href":"/platform-api/trader-insights/list-the-entries-and-exits-of-the-traders-you-follow"},{"title":"Follow a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/follow-a-trader"},{"title":"Stop following a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/stop-following-a-trader"},{"title":"Get long vs short positioning over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/history","href":"/platform-api/trader-insights/get-long-vs-short-positioning-over-time"},{"title":"Get live exposure by product and trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/live","href":"/platform-api/trader-insights/get-live-exposure-by-product-and-trader"}]},{"group":"Billing and invoices","pages":[{"title":"Get daily billing activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/activity","href":"/platform-api/billing-and-invoices/get-daily-billing-activity"},{"title":"Get credits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/credits","href":"/platform-api/billing-and-invoices/get-credits"},{"title":"List billing cycles","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles","href":"/platform-api/billing-and-invoices/list-billing-cycles"},{"title":"Get your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/get-your-billing-details"},{"title":"Update your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/update-your-billing-details"},{"title":"List all billing events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/events","href":"/platform-api/billing-and-invoices/list-all-billing-events"},{"title":"Project next month's bill from the current state","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/forecast","href":"/platform-api/billing-and-invoices/project-next-months-bill-from-the-current-state"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices","href":"/platform-api/billing-and-invoices/list-invoices"},{"title":"Get all-months billing aggregates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/monthly","href":"/platform-api/billing-and-invoices/get-all-months-billing-aggregates"},{"title":"Get monthly billing summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/summary","href":"/platform-api/billing-and-invoices/get-monthly-billing-summary"},{"title":"Get this month so far","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/usage","href":"/platform-api/billing-and-invoices/get-this-month-so-far"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}","href":"/platform-api/billing-and-invoices/get-an-invoice"},{"title":"Export a month's line items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/line-items/export","href":"/platform-api/billing-and-invoices/export-a-months-line-items-as-csv"},{"title":"Get events for a billing cycle","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles/{cycleId}/events","href":"/platform-api/billing-and-invoices/get-events-for-a-billing-cycle"},{"title":"Get bank transfer instructions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/payment-instructions","href":"/platform-api/billing-and-invoices/get-bank-transfer-instructions"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/pdf","href":"/platform-api/billing-and-invoices/download-an-invoice-pdf"}]},{"group":"Team and roles","pages":[{"title":"List roles (system presets + your custom roles)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/roles","href":"/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles"},{"title":"Get team members for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team","href":"/platform-api/team-and-roles/get-team-members-for-your-organization"},{"title":"List pending team invitations","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team/invitations","href":"/platform-api/team-and-roles/list-pending-team-invitations"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys","href":"/platform-api/api-keys/list-api-keys"},{"title":"List AI apps connected with your API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys/connections","href":"/platform-api/api-keys/list-ai-apps-connected-with-your-api-keys"}]},{"group":"Logs and health","pages":[{"title":"List API request logs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-logs","href":"/platform-api/logs-and-health/list-api-request-logs"},{"title":"Get organization audit log","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log","href":"/platform-api/logs-and-health/get-organization-audit-log"},{"title":"Get integration health (alerts, errors, insights)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/health","href":"/platform-api/logs-and-health/get-integration-health-alerts-errors-insights"},{"title":"Look up an idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/idempotency-keys","href":"/platform-api/logs-and-health/look-up-an-idempotency-key"},{"title":"List organization audit events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log/events","href":"/platform-api/logs-and-health/list-organization-audit-events"},{"title":"Release a stuck idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/idempotency-keys/release","href":"/platform-api/logs-and-health/release-a-stuck-idempotency-key"}]},{"group":"Organization profile","pages":[{"title":"Get your organization profile","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/profile","href":"/platform-api/organization-profile/get-your-organization-profile"},{"title":"Update your organization profile","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/profile","href":"/platform-api/organization-profile/update-your-organization-profile"},{"title":"Upload organization logo","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/profile/logo","href":"/platform-api/organization-profile/upload-organization-logo"},{"title":"Delete organization logo","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/profile/logo","href":"/platform-api/organization-profile/delete-organization-logo"}]},{"group":"Support","pages":[{"title":"List your support tickets","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets","href":"/platform-api/support/list-your-support-tickets"},{"title":"Create a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets","href":"/platform-api/support/create-a-support-ticket"},{"title":"Get signed upload URLs for ticket attachments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/uploads","href":"/platform-api/support/get-signed-upload-urls-for-ticket-attachments"},{"title":"Get a support ticket with its reply thread","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets/{ticketId}","href":"/platform-api/support/get-a-support-ticket-with-its-reply-thread"},{"title":"Reply on a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets/{ticketId}/comments","href":"/platform-api/support/reply-on-a-support-ticket"}]},{"group":"Partner access","pages":[{"title":"Get order history (keyset-paginated)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/orders","href":"/platform-api/partner-access/get-order-history-keyset-paginated"},{"title":"Get completed round-trip trades (server-derived)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/trades","href":"/platform-api/partner-access/get-completed-round-trip-trades-server-derived"}]}]},{"group":"Trade API","pages":[{"group":"Account","pages":[{"title":"Get current trading account with equity and P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account","href":"/trade-api/account/get-current-trading-account-with-equity-and-p\u0026l"},{"title":"Get account lockout status","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/lockout","href":"/trade-api/account/get-account-lockout-status"},{"title":"Create or update account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/lockout","href":"/trade-api/account/create-or-update-account-lockout"},{"title":"Remove account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/account/lockout","href":"/trade-api/account/remove-account-lockout"},{"title":"Set or clear a trading account's display nickname.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/nickname","href":"/trade-api/account/set-or-clear-a-trading-accounts-display-nickname"},{"title":"Get all trading accounts for the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts","href":"/trade-api/account/get-all-trading-accounts-for-the-authenticated-user"},{"title":"Create a personal API key session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/api-keys/session","href":"/trade-api/account/create-a-personal-api-key-session"},{"title":"List the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/partner/keys","href":"/trade-api/account/list-the-traders-api-keys"},{"title":"Generate a trader API key for third-party access","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/keys","href":"/trade-api/account/generate-a-trader-api-key-for-third-party-access"},{"title":"Revoke one of the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/partner/keys/{key_id}","href":"/trade-api/account/revoke-one-of-the-traders-api-keys"},{"title":"Create a partner session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/session","href":"/trade-api/account/create-a-partner-session"}]},{"group":"Risk","pages":[{"title":"Read the trader's personal risk settings for an account.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/risk-settings","href":"/trade-api/risk/read-the-traders-personal-risk-settings-for-an-account"},{"title":"Update personal risk settings.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/risk-settings","href":"/trade-api/risk/update-personal-risk-settings"}]},{"group":"Accounts","pages":[{"title":"Consistency status for one of the caller's accounts","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts/{account_id}/consistency","href":"/trade-api/accounts/consistency-status-for-one-of-the-callers-accounts"}]},{"group":"Positions","pages":[{"title":"Close all open positions for an account","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/close-all","href":"/trade-api/positions/close-all-open-positions-for-an-account"},{"title":"Flatten account: close positions and cancel orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/flatten","href":"/trade-api/positions/flatten-account:-close-positions-and-cancel-orders"},{"title":"Add margin to an isolated perpetual position, or remove some.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/isolated-margin","href":"/trade-api/positions/add-margin-to-an-isolated-perpetual-position-or-remove-some"},{"title":"Read the account's perpetual margin settings and position margins.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/margin","href":"/trade-api/positions/read-the-accounts-perpetual-margin-settings-and-position-margins"},{"title":"Set a perpetual's margin mode and/or leverage.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/margin","href":"/trade-api/positions/set-a-perpetuals-margin-mode-andor-leverage"},{"title":"Get perpetual mark prices","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/mark","href":"/trade-api/positions/get-perpetual-mark-prices"},{"title":"Close a specific position by contract","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/close","href":"/trade-api/positions/close-a-specific-position-by-contract"},{"title":"Reverse a position (close + open opposite side)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/reverse","href":"/trade-api/positions/reverse-a-position-close-+-open-opposite-side"},{"title":"Set TP/SL at the position level for one (account, contract) pair.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/set-bracket","href":"/trade-api/positions/set-tpsl-at-the-position-level-for-one-account-contract-pair"},{"title":"Get open positions with real-time P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/positions","href":"/trade-api/positions/get-open-positions-with-real-time-p\u0026l"}]},{"group":"Orders","pages":[{"title":"Get command processing status by id","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/commands/{command_id}","href":"/trade-api/orders/get-command-processing-status-by-id"},{"title":"Submit a market, limit, or stop order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order","href":"/trade-api/orders/submit-a-market-limit-or-stop-order"},{"title":"Attach TP/SL bracket to an existing order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/attach-bracket","href":"/trade-api/orders/attach-tpsl-bracket-to-an-existing-order"},{"title":"Cancel a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/cancel","href":"/trade-api/orders/cancel-a-pending-order"},{"title":"Detach TP/SL bracket leg from an order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/detach-bracket","href":"/trade-api/orders/detach-tpsl-bracket-leg-from-an-order"},{"title":"Link a standalone order into the position's OCO group","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/link-oco","href":"/trade-api/orders/link-a-standalone-order-into-the-positions-oco-group"},{"title":"Modify price or quantity of a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/modify","href":"/trade-api/orders/modify-price-or-quantity-of-a-pending-order"},{"title":"Get all orders (filled, pending, cancelled)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders","href":"/trade-api/orders/get-all-orders-filled-pending-cancelled"},{"title":"Cancel all pending orders for an account (keeps live position protection)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/orders/cancel-all","href":"/trade-api/orders/cancel-all-pending-orders-for-an-account-keeps-live-position-protection"},{"title":"Get order history (append-only lifecycle events)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/history","href":"/trade-api/orders/get-order-history-append-only-lifecycle-events"},{"title":"Get active working orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/pending","href":"/trade-api/orders/get-active-working-orders"},{"title":"Get trade execution history","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/trades","href":"/trade-api/orders/get-trade-execution-history"}]},{"group":"Copy Trading","pages":[{"title":"Get copy trading configuration","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/config","href":"/trade-api/copy-trading/get-copy-trading-configuration"},{"title":"Create or update a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config","href":"/trade-api/copy-trading/create-or-update-a-copy-trading-config"},{"title":"Delete a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config","href":"/trade-api/copy-trading/delete-a-copy-trading-config"},{"title":"Toggle copy config active state","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config/active","href":"/trade-api/copy-trading/toggle-copy-config-active-state"},{"title":"Delete all copy trading configs","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config/all","href":"/trade-api/copy-trading/delete-all-copy-trading-configs"},{"title":"Bulk update copy trading group followers","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/group","href":"/trade-api/copy-trading/bulk-update-copy-trading-group-followers"},{"title":"Get copy trading status and positions","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/status","href":"/trade-api/copy-trading/get-copy-trading-status-and-positions"}]},{"group":"WebSocket","pages":[{"title":"Real-time WebSocket for trading events","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/ws","href":"/trade-api/websocket/real-time-websocket-for-trading-events"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Inspect a revert batch - Hyperprop Platform API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}