Bulk update multiple trading accounts at once. Admin only.
All changes are logged to the audit trail with the batch ID for easy tracking.
Filters (at least one required):
Filter
Description
accountIds
Specific account IDs to update (1 to 500; an empty list is refused)
allAccounts
true to select every account of the organization; required when no other filter is given, and not combinable with accountIds
status
Filter by current status
createdAfter / createdBefore
Filter by creation date
startedAfter / startedBefore
Filter by start timestamp
tradingPlanId
Filter by trading plan
userId
Filter by user ID
Updates (at least one required):
Update
Description
status
Change status
currentBalance
Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below)
highWaterMark
Set new high water mark
dailyStartingBalance
Set new daily starting balance
violationReason
Set or clear (null) violation reason
performanceData
Replace performance data (trade counts as whole numbers, other figures as numbers)
metadata
Replace metadata
resetToInitial
Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays)
Safety:
A reason is required for all bulk updates
Max 100 accounts without specifying accountIds
Max 500 accountIds per call — split larger sets into several calls
No filter narrows the selection and allAccounts is not true
NO_ACCOUNTS_FOUND
No accounts match the filters
VALIDATION_ERROR
An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field
TOO_MANY_ACCOUNTS
Over 100 accounts without specific IDs
NO_FIELDS_TO_UPDATE
No valid update fields provided
NEGATIVE_BALANCE_NOT_ALLOWED
currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them)
CLOSE_NOT_CONFIRMED (502)
Trading confirmed the close for none of the accounts; nothing was changed
BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409)
Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader’s first trade; nothing was changed (data.accountIds lists up to 100 of them)
Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account’s open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well.
Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved.
Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account’s live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account’s balance adjustments, fires account.balance_adjusted, and does not count toward the day’s profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Operations & time machine.
{
"statusCode": 404,
"error": "Not Found",
"message": "No accounts match the specified filters",
"code": "NO_ACCOUNTS_FOUND"
}
{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}
{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
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.
Headers
Idempotency-Key
string
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
{
"statusCode": 404,
"error": "Not Found",
"message": "No accounts match the specified filters",
"code": "NO_ACCOUNTS_FOUND"
}
{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}
{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
{"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/trading-accounts/bulk-update-trading-accounts","slug":"/platform-api/trading-accounts/bulk-update-trading-accounts","pageMetadata":{"title":"Bulk update trading accounts","description":"Bulk update multiple trading accounts at once. **Admin only**.\n\nAll changes are logged to the audit trail with the batch ID for easy tracking.\n\n**Filters (at least one required):**\n| Filter | Description |\n|--------|-------------|\n| `accountIds` | Specific account IDs to update (1 to 500; an empty list is refused) |\n| `allAccounts` | `true` to select every account of the organization; required when no other filter is given, and not combinable with `accountIds` |\n| `status` | Filter by current status |\n| `createdAfter` / `createdBefore` | Filter by creation date |\n| `startedAfter` / `startedBefore` | Filter by start timestamp |\n| `tradingPlanId` | Filter by trading plan |\n| `userId` | Filter by user ID |\n\n**Updates (at least one required):**\n| Update | Description |\n|--------|-------------|\n| `status` | Change status |\n| `currentBalance` | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) |\n| `highWaterMark` | Set new high water mark |\n| `dailyStartingBalance` | Set new daily starting balance |\n| `violationReason` | Set or clear (null) violation reason |\n| `performanceData` | Replace performance data (trade counts as whole numbers, other figures as numbers) |\n| `metadata` | Replace metadata |\n| `resetToInitial` | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) |\n\n**Safety:**\n- A reason is required for all bulk updates\n- Max 100 accounts without specifying accountIds\n- Max 500 `accountIds` per call — split larger sets into several calls\n- All changes are logged with before/after values\n\n**Example - Reset failed accounts after outage:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"filters\": {\n \"status\": \"failed\",\n \"startedAfter\": \"2026-01-15T14:00:00Z\",\n \"startedBefore\": \"2026-01-15T16:00:00Z\"\n },\n \"updates\": {\n \"resetToInitial\": true\n },\n \"reason\": \"Outage compensation\"\n }'\n```\n\n**Example - Bulk fail accounts:**\n```bash\ncurl -X POST \".../bulk-update\" \\\n -d '{\n \"filters\": { \"accountIds\": [\"id1\", \"id2\", \"id3\"] },\n \"updates\": { \"status\": \"failed\", \"violationReason\": \"Terms of service violation\" },\n \"reason\": \"ToS violation - detected automated trading\"\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `REASON_REQUIRED` | Reason must be at least 3 characters |\n| `FILTERS_REQUIRED` | No filter narrows the selection and `allAccounts` is not `true` |\n| `NO_ACCOUNTS_FOUND` | No accounts match the filters |\n| `VALIDATION_ERROR` | An empty or over-500 `accountIds` list, `accountIds` together with `allAccounts`, or another invalid field |\n| `TOO_MANY_ACCOUNTS` | Over 100 accounts without specific IDs |\n| `NO_FIELDS_TO_UPDATE` | No valid update fields provided |\n| `NEGATIVE_BALANCE_NOT_ALLOWED` | `currentBalance` is below zero and a selected live account starts above 0; nothing was changed (`data.accountIds` lists up to 50 of them) |\n| `CLOSE_NOT_CONFIRMED` (502) | Trading confirmed the close for none of the accounts; nothing was changed |\n| `BALANCE_AT_OR_BELOW_LOCKED_FLOOR` (409) | Without `resetToInitial`, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader's first trade; nothing was changed (`data.accountIds` lists up to 100 of them) |\n\n**Closing first:** when the status moves to `passed`, `failed`, `expired` or `not_started`, or with `resetToInitial`, each account's open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in `closeNotConfirmed`. Once accounts have `passed`, `failed` or `expired`, anything opened in the meantime is closed as well.\n\n**Large updates:** accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in `notUpdated`; the response is `500` only when no account could be saved.\n\n**Balance on live accounts:** for an account that is not `passed`, `failed` or `expired` after the update, `currentBalance` is applied as a balance adjustment of the difference to the account's live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account's balance adjustments, fires `account.balance_adjusted`, and does not count toward the day's profit or loss (the daily starting balance moves with it unless the request also sets `dailyStartingBalance`). An account whose adjustment was not applied is listed in `balanceNotApplied` with a code (`OUTCOME_UNKNOWN`: check the balance before sending again; `BALANCE_EDIT_IN_PROGRESS`, `ACCOUNT_CLOSED`, `INSUFFICIENT_BALANCE`, `ADJUSTMENT_NOT_APPLIED`); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly.\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/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts","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 li: \"li\",\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 ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Bulk update multiple trading accounts at once. \", _jsx(_components.strong, {\n children: \"Admin only\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"All changes are logged to the audit trail with the batch ID for easy tracking.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Filters (at least one required):\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Filter\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"accountIds\"\n })\n }), _jsx(_components.td, {\n children: \"Specific account IDs to update (1 to 500; an empty list is refused)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"allAccounts\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"true\"\n }), \" to select every account of the organization; required when no other filter is given, and not combinable with \", _jsx(_components.code, {\n children: \"accountIds\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"status\"\n })\n }), _jsx(_components.td, {\n children: \"Filter by current status\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"createdAfter\"\n }), \" / \", _jsx(_components.code, {\n children: \"createdBefore\"\n })]\n }), _jsx(_components.td, {\n children: \"Filter by creation date\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"startedAfter\"\n }), \" / \", _jsx(_components.code, {\n children: \"startedBefore\"\n })]\n }), _jsx(_components.td, {\n children: \"Filter by start timestamp\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"tradingPlanId\"\n })\n }), _jsx(_components.td, {\n children: \"Filter by trading plan\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"userId\"\n })\n }), _jsx(_components.td, {\n children: \"Filter by user ID\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Updates (at least one required):\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Update\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"status\"\n })\n }), _jsx(_components.td, {\n children: \"Change status\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"currentBalance\"\n })\n }), _jsx(_components.td, {\n children: \"Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"highWaterMark\"\n })\n }), _jsx(_components.td, {\n children: \"Set new high water mark\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"dailyStartingBalance\"\n })\n }), _jsx(_components.td, {\n children: \"Set new daily starting balance\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"violationReason\"\n })\n }), _jsx(_components.td, {\n children: \"Set or clear (null) violation reason\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"performanceData\"\n })\n }), _jsx(_components.td, {\n children: \"Replace performance data (trade counts as whole numbers, other figures as numbers)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"metadata\"\n })\n }), _jsx(_components.td, {\n children: \"Replace metadata\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"resetToInitial\"\n })\n }), _jsx(_components.td, {\n children: \"Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays)\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Safety:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"A reason is required for all bulk updates\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Max 100 accounts without specifying accountIds\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Max 500 \", _jsx(_components.code, {\n children: \"accountIds\"\n }), \" per call — split larger sets into several calls\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"All changes are logged with before/after values\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Reset failed accounts after outage:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"14\",\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: \"14\",\n children: [_jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#953800\",\n \"--shiki-dark\": \"#DCDCAA\"\n },\n children: \"curl\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \" -X\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" POST\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#D7BA7D\"\n },\n children: \" \\\\\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\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 }), _jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#D7BA7D\"\n },\n children: \" \\\\\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \" -H\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"Content-Type: application/json\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#D7BA7D\"\n },\n children: \" \\\\\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \" -d\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" '{\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"filters\\\": {\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"status\\\": \\\"failed\\\",\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"startedAfter\\\": \\\"2026-01-15T14:00:00Z\\\",\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"startedBefore\\\": \\\"2026-01-15T16:00:00Z\\\"\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" },\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"updates\\\": {\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"resetToInitial\\\": true\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" },\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"reason\\\": \\\"Outage compensation\\\"\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" }'\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Bulk fail accounts:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"6\",\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: \"6\",\n children: [_jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#953800\",\n \"--shiki-dark\": \"#DCDCAA\"\n },\n children: \"curl\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \" -X\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" POST\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\".../bulk-update\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#D7BA7D\"\n },\n children: \" \\\\\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \" -d\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" '{\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"filters\\\": { \\\"accountIds\\\": [\\\"id1\\\", \\\"id2\\\", \\\"id3\\\"] },\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"updates\\\": { \\\"status\\\": \\\"failed\\\", \\\"violationReason\\\": \\\"Terms of service violation\\\" },\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" \\\"reason\\\": \\\"ToS violation - detected automated trading\\\"\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \" }'\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Error Codes:\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Code\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"REASON_REQUIRED\"\n })\n }), _jsx(_components.td, {\n children: \"Reason must be at least 3 characters\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"FILTERS_REQUIRED\"\n })\n }), _jsxs(_components.td, {\n children: [\"No filter narrows the selection and \", _jsx(_components.code, {\n children: \"allAccounts\"\n }), \" is not \", _jsx(_components.code, {\n children: \"true\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"NO_ACCOUNTS_FOUND\"\n })\n }), _jsx(_components.td, {\n children: \"No accounts match the filters\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"VALIDATION_ERROR\"\n })\n }), _jsxs(_components.td, {\n children: [\"An empty or over-500 \", _jsx(_components.code, {\n children: \"accountIds\"\n }), \" list, \", _jsx(_components.code, {\n children: \"accountIds\"\n }), \" together with \", _jsx(_components.code, {\n children: \"allAccounts\"\n }), \", or another invalid field\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"TOO_MANY_ACCOUNTS\"\n })\n }), _jsx(_components.td, {\n children: \"Over 100 accounts without specific IDs\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"NO_FIELDS_TO_UPDATE\"\n })\n }), _jsx(_components.td, {\n children: \"No valid update fields provided\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"NEGATIVE_BALANCE_NOT_ALLOWED\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"currentBalance\"\n }), \" is below zero and a selected live account starts above 0; nothing was changed (\", _jsx(_components.code, {\n children: \"data.accountIds\"\n }), \" lists up to 50 of them)\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"CLOSE_NOT_CONFIRMED\"\n }), \" (502)\"]\n }), _jsx(_components.td, {\n children: \"Trading confirmed the close for none of the accounts; nothing was changed\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"BALANCE_AT_OR_BELOW_LOCKED_FLOOR\"\n }), \" (409)\"]\n }), _jsxs(_components.td, {\n children: [\"Without \", _jsx(_components.code, {\n children: \"resetToInitial\"\n }), \", the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader’s first trade; nothing was changed (\", _jsx(_components.code, {\n children: \"data.accountIds\"\n }), \" lists up to 100 of them)\"]\n })]\n })]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Closing first:\"\n }), \" when the status moves to \", _jsx(_components.code, {\n children: \"passed\"\n }), \", \", _jsx(_components.code, {\n children: \"failed\"\n }), \", \", _jsx(_components.code, {\n children: \"expired\"\n }), \" or \", _jsx(_components.code, {\n children: \"not_started\"\n }), \", or with \", _jsx(_components.code, {\n children: \"resetToInitial\"\n }), \", each account’s open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in \", _jsx(_components.code, {\n children: \"closeNotConfirmed\"\n }), \". Once accounts have \", _jsx(_components.code, {\n children: \"passed\"\n }), \", \", _jsx(_components.code, {\n children: \"failed\"\n }), \" or \", _jsx(_components.code, {\n children: \"expired\"\n }), \", anything opened in the meantime is closed as well.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Large updates:\"\n }), \" accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in \", _jsx(_components.code, {\n children: \"notUpdated\"\n }), \"; the response is \", _jsx(_components.code, {\n children: \"500\"\n }), \" only when no account could be saved.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Balance on live accounts:\"\n }), \" for an account that is not \", _jsx(_components.code, {\n children: \"passed\"\n }), \", \", _jsx(_components.code, {\n children: \"failed\"\n }), \" or \", _jsx(_components.code, {\n children: \"expired\"\n }), \" after the update, \", _jsx(_components.code, {\n children: \"currentBalance\"\n }), \" is applied as a balance adjustment of the difference to the account’s live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account’s balance adjustments, fires \", _jsx(_components.code, {\n children: \"account.balance_adjusted\"\n }), \", and does not count toward the day’s profit or loss (the daily starting balance moves with it unless the request also sets \", _jsx(_components.code, {\n children: \"dailyStartingBalance\"\n }), \"). An account whose adjustment was not applied is listed in \", _jsx(_components.code, {\n children: \"balanceNotApplied\"\n }), \" with a code (\", _jsx(_components.code, {\n children: \"OUTCOME_UNKNOWN\"\n }), \": check the balance before sending again; \", _jsx(_components.code, {\n children: \"BALANCE_EDIT_IN_PROGRESS\"\n }), \", \", _jsx(_components.code, {\n children: \"ACCOUNT_CLOSED\"\n }), \", \", _jsx(_components.code, {\n children: \"INSUFFICIENT_BALANCE\"\n }), \", \", _jsx(_components.code, {\n children: \"ADJUSTMENT_NOT_APPLIED\"\n }), \"); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" full-access API keys only (a read-only key gets \", _jsx(_components.code, {\n children: \"403 READ_ONLY_KEY\"\n }), \"). Dashboard members need manage 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":"Bulk update trading accounts","description":"Bulk update multiple trading accounts at once. **Admin only**.\n\nAll changes are logged to the audit trail with the batch ID for easy tracking.\n\n**Filters (at least one required):**\n| Filter | Description |\n|--------|-------------|\n| `accountIds` | Specific account IDs to update (1 to 500; an empty list is refused) |\n| `allAccounts` | `true` to select every account of the organization; required when no other filter is given, and not combinable with `accountIds` |\n| `status` | Filter by current status |\n| `createdAfter` / `createdBefore` | Filter by creation date |\n| `startedAfter` / `startedBefore` | Filter by start timestamp |\n| `tradingPlanId` | Filter by trading plan |\n| `userId` | Filter by user ID |\n\n**Updates (at least one required):**\n| Update | Description |\n|--------|-------------|\n| `status` | Change status |\n| `currentBalance` | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) |\n| `highWaterMark` | Set new high water mark |\n| `dailyStartingBalance` | Set new daily starting balance |\n| `violationReason` | Set or clear (null) violation reason |\n| `performanceData` | Replace performance data (trade counts as whole numbers, other figures as numbers) |\n| `metadata` | Replace metadata |\n| `resetToInitial` | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) |\n\n**Safety:**\n- A reason is required for all bulk updates\n- Max 100 accounts without specifying accountIds\n- Max 500 `accountIds` per call — split larger sets into several calls\n- All changes are logged with before/after values\n\n**Example - Reset failed accounts after outage:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"filters\": {\n \"status\": \"failed\",\n \"startedAfter\": \"2026-01-15T14:00:00Z\",\n \"startedBefore\": \"2026-01-15T16:00:00Z\"\n },\n \"updates\": {\n \"resetToInitial\": true\n },\n \"reason\": \"Outage compensation\"\n }'\n```\n\n**Example - Bulk fail accounts:**\n```bash\ncurl -X POST \".../bulk-update\" \\\n -d '{\n \"filters\": { \"accountIds\": [\"id1\", \"id2\", \"id3\"] },\n \"updates\": { \"status\": \"failed\", \"violationReason\": \"Terms of service violation\" },\n \"reason\": \"ToS violation - detected automated trading\"\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `REASON_REQUIRED` | Reason must be at least 3 characters |\n| `FILTERS_REQUIRED` | No filter narrows the selection and `allAccounts` is not `true` |\n| `NO_ACCOUNTS_FOUND` | No accounts match the filters |\n| `VALIDATION_ERROR` | An empty or over-500 `accountIds` list, `accountIds` together with `allAccounts`, or another invalid field |\n| `TOO_MANY_ACCOUNTS` | Over 100 accounts without specific IDs |\n| `NO_FIELDS_TO_UPDATE` | No valid update fields provided |\n| `NEGATIVE_BALANCE_NOT_ALLOWED` | `currentBalance` is below zero and a selected live account starts above 0; nothing was changed (`data.accountIds` lists up to 50 of them) |\n| `CLOSE_NOT_CONFIRMED` (502) | Trading confirmed the close for none of the accounts; nothing was changed |\n| `BALANCE_AT_OR_BELOW_LOCKED_FLOOR` (409) | Without `resetToInitial`, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader's first trade; nothing was changed (`data.accountIds` lists up to 100 of them) |\n\n**Closing first:** when the status moves to `passed`, `failed`, `expired` or `not_started`, or with `resetToInitial`, each account's open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in `closeNotConfirmed`. Once accounts have `passed`, `failed` or `expired`, anything opened in the meantime is closed as well.\n\n**Large updates:** accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in `notUpdated`; the response is `500` only when no account could be saved.\n\n**Balance on live accounts:** for an account that is not `passed`, `failed` or `expired` after the update, `currentBalance` is applied as a balance adjustment of the difference to the account's live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account's balance adjustments, fires `account.balance_adjusted`, and does not count toward the day's profit or loss (the daily starting balance moves with it unless the request also sets `dailyStartingBalance`). An account whose adjustment was not applied is listed in `balanceNotApplied` with a code (`OUTCOME_UNKNOWN`: check the balance before sending again; `BALANCE_EDIT_IN_PROGRESS`, `ACCOUNT_CLOSED`, `INSUFFICIENT_BALANCE`, `ADJUSTMENT_NOT_APPLIED`); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly.\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/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Bulk update trading accounts","operationId":"postV1OrganizationTradingaccountsBulkupdate","description":"Bulk update multiple trading accounts at once. **Admin only**.\n\nAll changes are logged to the audit trail with the batch ID for easy tracking.\n\n**Filters (at least one required):**\n| Filter | Description |\n|--------|-------------|\n| `accountIds` | Specific account IDs to update (1 to 500; an empty list is refused) |\n| `allAccounts` | `true` to select every account of the organization; required when no other filter is given, and not combinable with `accountIds` |\n| `status` | Filter by current status |\n| `createdAfter` / `createdBefore` | Filter by creation date |\n| `startedAfter` / `startedBefore` | Filter by start timestamp |\n| `tradingPlanId` | Filter by trading plan |\n| `userId` | Filter by user ID |\n\n**Updates (at least one required):**\n| Update | Description |\n|--------|-------------|\n| `status` | Change status |\n| `currentBalance` | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) |\n| `highWaterMark` | Set new high water mark |\n| `dailyStartingBalance` | Set new daily starting balance |\n| `violationReason` | Set or clear (null) violation reason |\n| `performanceData` | Replace performance data (trade counts as whole numbers, other figures as numbers) |\n| `metadata` | Replace metadata |\n| `resetToInitial` | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) |\n\n**Safety:**\n- A reason is required for all bulk updates\n- Max 100 accounts without specifying accountIds\n- Max 500 `accountIds` per call — split larger sets into several calls\n- All changes are logged with before/after values\n\n**Example - Reset failed accounts after outage:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"filters\": {\n \"status\": \"failed\",\n \"startedAfter\": \"2026-01-15T14:00:00Z\",\n \"startedBefore\": \"2026-01-15T16:00:00Z\"\n },\n \"updates\": {\n \"resetToInitial\": true\n },\n \"reason\": \"Outage compensation\"\n }'\n```\n\n**Example - Bulk fail accounts:**\n```bash\ncurl -X POST \".../bulk-update\" \\\n -d '{\n \"filters\": { \"accountIds\": [\"id1\", \"id2\", \"id3\"] },\n \"updates\": { \"status\": \"failed\", \"violationReason\": \"Terms of service violation\" },\n \"reason\": \"ToS violation - detected automated trading\"\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `REASON_REQUIRED` | Reason must be at least 3 characters |\n| `FILTERS_REQUIRED` | No filter narrows the selection and `allAccounts` is not `true` |\n| `NO_ACCOUNTS_FOUND` | No accounts match the filters |\n| `VALIDATION_ERROR` | An empty or over-500 `accountIds` list, `accountIds` together with `allAccounts`, or another invalid field |\n| `TOO_MANY_ACCOUNTS` | Over 100 accounts without specific IDs |\n| `NO_FIELDS_TO_UPDATE` | No valid update fields provided |\n| `NEGATIVE_BALANCE_NOT_ALLOWED` | `currentBalance` is below zero and a selected live account starts above 0; nothing was changed (`data.accountIds` lists up to 50 of them) |\n| `CLOSE_NOT_CONFIRMED` (502) | Trading confirmed the close for none of the accounts; nothing was changed |\n| `BALANCE_AT_OR_BELOW_LOCKED_FLOOR` (409) | Without `resetToInitial`, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader's first trade; nothing was changed (`data.accountIds` lists up to 100 of them) |\n\n**Closing first:** when the status moves to `passed`, `failed`, `expired` or `not_started`, or with `resetToInitial`, each account's open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in `closeNotConfirmed`. Once accounts have `passed`, `failed` or `expired`, anything opened in the meantime is closed as well.\n\n**Large updates:** accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in `notUpdated`; the response is `500` only when no account could be saved.\n\n**Balance on live accounts:** for an account that is not `passed`, `failed` or `expired` after the update, `currentBalance` is applied as a balance adjustment of the difference to the account's live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account's balance adjustments, fires `account.balance_adjusted`, and does not count toward the day's profit or loss (the daily starting balance moves with it unless the request also sets `dailyStartingBalance`). An account whose adjustment was not applied is listed in `balanceNotApplied` with a code (`OUTCOME_UNKNOWN`: check the balance before sending again; `BALANCE_EDIT_IN_PROGRESS`, `ACCOUNT_CLOSED`, `INSUFFICIENT_BALANCE`, `ADJUSTMENT_NOT_APPLIED`); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly.\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.","parameters":["a76b407c-8138-4941-a970-9a18ab918500"],"requestBody":"7a1714d5-c847-47fd-9282-2954c4f0f0c6","tags":["Trading accounts"],"security":["2701fa73-9611-4ed2-87ad-ea4b9bb0888d"],"responses":{"200":"fa2d1ce0-152a-4f5d-82ae-89e24dd22936","400":"11b956d5-b538-4ead-9d36-0029d2455c58","401":"b9733d57-14be-4b76-9a60-680aee0c682d","403":"f7305105-6516-491b-b480-34be1ad0bac4","404":"7ca8ffa0-9e29-4f75-ac7e-4b32822a6317","409":"c8865eb3-d277-4719-b78d-feeff845dde8","429":"b1256164-daf9-46bf-b411-3a94256b7a85","500":"75110645-3aa2-4fb1-91f8-e8eac50a4671","503":"3c7cdee0-c2ad-4cd3-ace6-b2d278defc6e"},"method":"post","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/trading-accounts/bulk-update","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Bulk update trading accounts","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a76b407c-8138-4941-a970-9a18ab918500":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","example":"crm-sync-8814-attempt-1","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"object","description":"Filters to select which accounts to update","properties":{"accountIds":{"type":"array","description":"Specific account IDs to update (1 to 500 per call). An empty list is refused.","minItems":1,"maxItems":500,"items":{"type":"string","x-format":{"guid":true},"uniqueKey":"filters.accountIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filters.accountIds","typeLabel":"string[]"},"allAccounts":{"type":"boolean","description":"Select every account of the organization (still at most 100 per call). Required when no other filter is given.","enum":[true],"uniqueKey":"filters.allAccounts","typeLabel":"enum\u003cboolean>"},"status":{"type":"string","description":"Filter by current status","enum":["not_started","in_progress","passed","failed","expired"],"uniqueKey":"filters.status","typeLabel":"enum\u003cstring>"},"createdAfter":{"type":"string","description":"Accounts created after this date","x-format":{"isoDate":true},"uniqueKey":"filters.createdAfter","typeLabel":"string"},"createdBefore":{"type":"string","description":"Accounts created before this date","x-format":{"isoDate":true},"uniqueKey":"filters.createdBefore","typeLabel":"string"},"startedAfter":{"type":"string","description":"Accounts started after this timestamp","x-format":{"isoDate":true},"uniqueKey":"filters.startedAfter","typeLabel":"string"},"startedBefore":{"type":"string","description":"Accounts started before this timestamp","x-format":{"isoDate":true},"uniqueKey":"filters.startedBefore","typeLabel":"string"},"tradingPlanId":{"type":"string","description":"Filter by trading plan","x-format":{"guid":true},"uniqueKey":"filters.tradingPlanId","typeLabel":"string"},"userId":{"type":"string","description":"Filter by user ID","x-format":{"guid":true},"uniqueKey":"filters.userId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filters","typeLabel":"object"},"updates":{"type":"object","description":"Updates to apply","properties":{"status":{"type":"string","description":"New status","enum":["not_started","in_progress","passed","failed","expired"],"uniqueKey":"updates.status","typeLabel":"enum\u003cstring>"},"currentBalance":{"type":"number","description":"New current balance. Below zero only for accounts that start at 0 (a live account that starts above 0 is refused with NEGATIVE_BALANCE_NOT_ALLOWED).","minimum":-100000000,"maximum":100000000,"x-constraint":{"precision":2},"uniqueKey":"updates.currentBalance","typeLabel":"number"},"highWaterMark":{"type":"number","description":"New high water mark","minimum":-100000000,"maximum":100000000,"x-constraint":{"precision":2},"uniqueKey":"updates.highWaterMark","typeLabel":"number"},"dailyStartingBalance":{"type":"number","description":"New daily starting balance","minimum":-100000000,"maximum":100000000,"x-constraint":{"precision":2},"uniqueKey":"updates.dailyStartingBalance","typeLabel":"number"},"violationReason":{"type":"string","description":"Set or clear violation reason","maxLength":1000,"uniqueKey":"updates.violationReason","typeLabel":"string"},"performanceData":{"type":"object","description":"New performance data (replaces existing). Only these fields: total_trades, winning_trades, losing_trades (whole numbers, 0 or more), win_rate (0-100), total_pnl, largest_win, largest_loss, current_drawdown, max_drawdown (numbers). Any other field or a value of another type is refused with 400.","example":{"total_trades":12,"winning_trades":7,"losing_trades":5,"total_pnl":1250.5,"largest_win":600,"largest_loss":-320,"current_drawdown":0,"max_drawdown":480},"properties":{"total_trades":{"type":"integer","minimum":0,"maximum":4294967295,"uniqueKey":"updates.performanceData.total_trades","typeLabel":"integer"},"winning_trades":{"type":"integer","minimum":0,"maximum":4294967295,"uniqueKey":"updates.performanceData.winning_trades","typeLabel":"integer"},"losing_trades":{"type":"integer","minimum":0,"maximum":4294967295,"uniqueKey":"updates.performanceData.losing_trades","typeLabel":"integer"},"win_rate":{"type":"number","minimum":0,"maximum":100,"uniqueKey":"updates.performanceData.win_rate","typeLabel":"number"},"total_pnl":{"type":"number","minimum":-100000000,"maximum":100000000,"uniqueKey":"updates.performanceData.total_pnl","typeLabel":"number"},"largest_win":{"type":"number","minimum":-100000000,"maximum":100000000,"uniqueKey":"updates.performanceData.largest_win","typeLabel":"number"},"largest_loss":{"type":"number","minimum":-100000000,"maximum":100000000,"uniqueKey":"updates.performanceData.largest_loss","typeLabel":"number"},"current_drawdown":{"type":"number","minimum":-100000000,"maximum":100000000,"uniqueKey":"updates.performanceData.current_drawdown","typeLabel":"number"},"max_drawdown":{"type":"number","minimum":-100000000,"maximum":100000000,"uniqueKey":"updates.performanceData.max_drawdown","typeLabel":"number"}},"uniqueKey":"updates.performanceData","typeLabel":"object"},"metadata":{"type":"object","description":"New metadata (replaces existing). At most 16 KB as JSON, 50 top-level keys and 5 levels of nesting; larger metadata returns `400 METADATA_TOO_LARGE`.","uniqueKey":"updates.metadata","typeLabel":"object"},"resetToInitial":{"type":"boolean","description":"Reset accounts to initial balance and in_progress status. A daily loss limit switched off at its balance target (dailyLossOffThreshold) is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts; the payout count stays.","uniqueKey":"updates.resetToInitial","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"updates","typeLabel":"object"},"reason":{"type":"string","description":"Reason for the bulk update (required for audit)","example":"Goodwill credit","minLength":3,"maxLength":1000,"isRequired":true,"uniqueKey":"reason","typeLabel":"string"}},"required":["filters","updates","reason"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"filters":{"accountIds":["\u003cstring>"],"allAccounts":true,"createdAfter":"\u003cstring>","createdBefore":"\u003cstring>","startedAfter":"\u003cstring>","startedBefore":"\u003cstring>","tradingPlanId":"\u003cstring>","userId":"\u003cstring>"},"updates":{"currentBalance":0,"highWaterMark":0,"dailyStartingBalance":0,"violationReason":"\u003cstring>","performanceData":{"total_trades":12,"winning_trades":7,"losing_trades":5,"total_pnl":1250.5,"largest_win":600,"largest_loss":-320,"current_drawdown":0,"max_drawdown":480},"metadata":{},"resetToInitial":true},"reason":"Goodwill credit"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fa2d1ce0-152a-4f5d-82ae-89e24dd22936":{"description":"Bulk update successful","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Successfully updated 15 accounts","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","example":{"batchId":"e4f5a6b7-c8d9-0123-efab-456789012345","accountsUpdated":15,"accountsTotal":15,"engineNotConfirmed":[],"closeNotConfirmed":[],"balanceNotApplied":[],"notUpdated":[],"filters":{"status":"failed","startDate":"2026-02-01"},"updates":{"status":"in_progress","resetToInitial":true},"reason":"Server maintenance compensation - resetting failed accounts"},"properties":{"batchId":{"type":"string","description":"Batch ID for tracking this operation","x-format":{"guid":true},"uniqueKey":"data.batchId","typeLabel":"string"},"accountsUpdated":{"type":"number","uniqueKey":"data.accountsUpdated","typeLabel":"number"},"accountsTotal":{"type":"number","uniqueKey":"data.accountsTotal","typeLabel":"number"},"engineNotConfirmed":{"type":"array","description":"Accounts whose change was saved but not yet confirmed by trading; send the same update for them again. Empty when every account is confirmed.","items":{"type":"string","x-format":{"guid":true},"uniqueKey":"data.engineNotConfirmed.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.engineNotConfirmed","typeLabel":"string[]"},"closeNotConfirmed":{"type":"array","description":"Accounts left unchanged because trading did not confirm that their positions and orders were closed first; send the update for them again. Empty when every close was confirmed.","items":{"type":"string","x-format":{"guid":true},"uniqueKey":"data.closeNotConfirmed.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.closeNotConfirmed","typeLabel":"string[]"},"balanceNotApplied":{"type":"array","description":"Live accounts whose currentBalance adjustment was not applied, with the reason; their other changes were saved. Empty when every adjustment was applied or no balance was set.","items":{"type":"object","properties":{"accountId":{"type":"string","x-format":{"guid":true},"uniqueKey":"data.balanceNotApplied.items.[INDEX].accountId","typeLabel":"string"},"code":{"type":"string","example":"OUTCOME_UNKNOWN","uniqueKey":"data.balanceNotApplied.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"data.balanceNotApplied.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"data.balanceNotApplied.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.balanceNotApplied","typeLabel":"object[]"},"notUpdated":{"type":"array","description":"Accounts left unchanged because saving the change failed for their group of accounts; send the update for them again. The other accounts were updated, with their change history and events. Empty when every account was saved.","items":{"type":"string","x-format":{"guid":true},"uniqueKey":"data.notUpdated.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.notUpdated","typeLabel":"string[]"},"filters":{"type":"object","uniqueKey":"data.filters","typeLabel":"object"},"updates":{"type":"object","uniqueKey":"data.updates","typeLabel":"object"},"reason":{"type":"string","uniqueKey":"data.reason","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Successfully updated 15 accounts","data":{"batchId":"e4f5a6b7-c8d9-0123-efab-456789012345","accountsUpdated":15,"accountsTotal":15,"engineNotConfirmed":[],"closeNotConfirmed":[],"balanceNotApplied":[],"notUpdated":[],"filters":{"status":"failed","startDate":"2026-02-01"},"updates":{"status":"in_progress","resetToInitial":true},"reason":"Server maintenance compensation - resetting failed accounts"}}}},"exampleType":"generated"}},"exampleType":"generated"},"11b956d5-b538-4ead-9d36-0029d2455c58":{"description":"Bad Request - missing reason, an empty `accountIds` list, or no narrowing filter without `allAccounts: true`; a reason over its length limit (`VALIDATION_ERROR`), metadata over the size limits (`METADATA_TOO_LARGE`), or a balance below zero for a live account that starts above 0 (`NEGATIVE_BALANCE_NOT_ALLOWED`)","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":400,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"No filter narrows the selection. Pass accountIds, another filter, or allAccounts: true.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"FILTERS_REQUIRED","enum":["REASON_REQUIRED","FILTERS_REQUIRED","VALIDATION_ERROR","TOO_MANY_ACCOUNTS","METADATA_TOO_LARGE","NEGATIVE_BALANCE_NOT_ALLOWED"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"accountIds":{"type":"array","description":"With NEGATIVE_BALANCE_NOT_ALLOWED: up to 50 of the live accounts that start above 0","items":{"type":"string","x-format":{"guid":true},"uniqueKey":"data.accountIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.accountIds","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"error":"Bad Request","message":"No filter narrows the selection. Pass accountIds, another filter, or allAccounts: true.","code":"FILTERS_REQUIRED","data":{"accountIds":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"b9733d57-14be-4b76-9a60-680aee0c682d":{"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"},"f7305105-6516-491b-b480-34be1ad0bac4":{"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"},"7ca8ffa0-9e29-4f75-ac7e-4b32822a6317":{"description":"No accounts match filters","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":404,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Not Found","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"No accounts match the specified filters","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"NO_ACCOUNTS_FOUND","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"error":"Not Found","message":"No accounts match the specified filters","code":"NO_ACCOUNTS_FOUND"}}},"exampleType":"generated"}},"exampleType":"generated"},"c8865eb3-d277-4719-b78d-feeff845dde8":{"description":"The `Idempotency-Key` was used with a different body (`IDEMPOTENCY_KEY_REUSED`), a request with the same key is still running (`IDEMPOTENCY_KEY_IN_PROGRESS`), or the request with this key already completed and its response is not available again (`IDEMPOTENCY_KEY_COMPLETED`)","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":409,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Conflict","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"This Idempotency-Key was already used with a different request body. Use a new key for a different request.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_COMPLETED"],"example":"IDEMPOTENCY_KEY_REUSED","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":409,"error":"Conflict","message":"This Idempotency-Key was already used with a different request body. Use a new key for a different request.","code":"IDEMPOTENCY_KEY_REUSED"}}},"exampleType":"generated"}},"exampleType":"generated"},"b1256164-daf9-46bf-b411-3a94256b7a85":{"description":"Too many requests: this endpoint allows 20 calls per minute per organization. Wait the number of seconds in the `Retry-After` header.","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":429,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Too Many Requests","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Too many requests to this endpoint. Try again in 12 second(s).","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["RATE_LIMITED"],"example":"RATE_LIMITED","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":429,"error":"Too Many Requests","message":"Too many requests to this endpoint. Try again in 12 second(s).","code":"RATE_LIMITED"}}},"exampleType":"generated"}},"exampleType":"generated"},"75110645-3aa2-4fb1-91f8-e8eac50a4671":{"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"},"3c7cdee0-c2ad-4cd3-ace6-b2d278defc6e":{"description":"The `Idempotency-Key` could not be recorded, so the request was not run (`IDEMPOTENCY_UNAVAILABLE`). Retry with the same key after the `Retry-After` seconds.","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":503,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Service Unavailable","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["IDEMPOTENCY_UNAVAILABLE"],"example":"IDEMPOTENCY_UNAVAILABLE","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":503,"error":"Service Unavailable","message":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","code":"IDEMPOTENCY_UNAVAILABLE"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2701fa73-9611-4ed2-87ad-ea4b9bb0888d":{"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":"Bulk update trading accounts - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:09.273Z","originalFileLocation":"platform-api/trading-accounts/bulk-update-trading-accounts.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=\"Bulk update multiple trading accounts at once. Admin only. All changes are logged to the audit trail with the batch ID for easy tracking. Filters (at least one required): | Filter | Description | |--------|-------------| | accountIds | Specific account IDs to update (1 to 500; an empty list is refused) | | allAccounts | true to select every account of the organization; required when no other filter is given, and not combinable with accountIds | | status | Filter by current status | | createdAfter / createdBefore | Filter by creation date | | startedAfter / startedBefore | Filter by start timestamp | | tradingPlanId | Filter by trading plan | | userId | Filter by user ID | Updates (at least one required): | Update | Description | |--------|-------------| | status | Change status | | currentBalance | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) | | highWaterMark | Set new high water mark | | dailyStartingBalance | Set new daily starting balance | | violationReason | Set or clear (null) violation reason | | performanceData | Replace performance data (trade counts as whole numbers, other figures as numbers) | | metadata | Replace metadata | | resetToInitial | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) | Safety: - A reason is required for all bulk updates - Max 100 accounts without specifying accountIds - Max 500 accountIds per call — split larger sets into several calls - All changes are logged with before/after values Example - Reset failed accounts after outage: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;startedAfter\u0026quot;: \u0026quot;2026-01-15T14:00:00Z\u0026quot;, \u0026quot;startedBefore\u0026quot;: \u0026quot;2026-01-15T16:00:00Z\u0026quot; }, \u0026quot;updates\u0026quot;: { \u0026quot;resetToInitial\u0026quot;: true }, \u0026quot;reason\u0026quot;: \u0026quot;Outage compensation\u0026quot; }\u0026#x27; Example - Bulk fail accounts: bash curl -X POST \u0026quot;.../bulk-update\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;accountIds\u0026quot;: [\u0026quot;id1\u0026quot;, \u0026quot;id2\u0026quot;, \u0026quot;id3\u0026quot;] }, \u0026quot;updates\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;violationReason\u0026quot;: \u0026quot;Terms of service violation\u0026quot; }, \u0026quot;reason\u0026quot;: \u0026quot;ToS violation - detected automated trading\u0026quot; }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | REASON_REQUIRED | Reason must be at least 3 characters | | FILTERS_REQUIRED | No filter narrows the selection and allAccounts is not true | | NO_ACCOUNTS_FOUND | No accounts match the filters | | VALIDATION_ERROR | An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field | | TOO_MANY_ACCOUNTS | Over 100 accounts without specific IDs | | NO_FIELDS_TO_UPDATE | No valid update fields provided | | NEGATIVE_BALANCE_NOT_ALLOWED | currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them) | | CLOSE_NOT_CONFIRMED (502) | Trading confirmed the close for none of the accounts; nothing was changed | | BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409) | Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader\u0026#x27;s first trade; nothing was changed (data.accountIds lists up to 100 of them) | Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account\u0026#x27;s open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well. Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved. Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account\u0026#x27;s live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account\u0026#x27;s balance adjustments, fires account.balance_adjusted, and does not count toward the day\u0026#x27;s profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage 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=\"Bulk update trading accounts - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bulk update multiple trading accounts at once. Admin only. All changes are logged to the audit trail with the batch ID for easy tracking. Filters (at least one required): | Filter | Description | |--------|-------------| | accountIds | Specific account IDs to update (1 to 500; an empty list is refused) | | allAccounts | true to select every account of the organization; required when no other filter is given, and not combinable with accountIds | | status | Filter by current status | | createdAfter / createdBefore | Filter by creation date | | startedAfter / startedBefore | Filter by start timestamp | | tradingPlanId | Filter by trading plan | | userId | Filter by user ID | Updates (at least one required): | Update | Description | |--------|-------------| | status | Change status | | currentBalance | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) | | highWaterMark | Set new high water mark | | dailyStartingBalance | Set new daily starting balance | | violationReason | Set or clear (null) violation reason | | performanceData | Replace performance data (trade counts as whole numbers, other figures as numbers) | | metadata | Replace metadata | | resetToInitial | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) | Safety: - A reason is required for all bulk updates - Max 100 accounts without specifying accountIds - Max 500 accountIds per call — split larger sets into several calls - All changes are logged with before/after values Example - Reset failed accounts after outage: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;startedAfter\u0026quot;: \u0026quot;2026-01-15T14:00:00Z\u0026quot;, \u0026quot;startedBefore\u0026quot;: \u0026quot;2026-01-15T16:00:00Z\u0026quot; }, \u0026quot;updates\u0026quot;: { \u0026quot;resetToInitial\u0026quot;: true }, \u0026quot;reason\u0026quot;: \u0026quot;Outage compensation\u0026quot; }\u0026#x27; Example - Bulk fail accounts: bash curl -X POST \u0026quot;.../bulk-update\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;accountIds\u0026quot;: [\u0026quot;id1\u0026quot;, \u0026quot;id2\u0026quot;, \u0026quot;id3\u0026quot;] }, \u0026quot;updates\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;violationReason\u0026quot;: \u0026quot;Terms of service violation\u0026quot; }, \u0026quot;reason\u0026quot;: \u0026quot;ToS violation - detected automated trading\u0026quot; }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | REASON_REQUIRED | Reason must be at least 3 characters | | FILTERS_REQUIRED | No filter narrows the selection and allAccounts is not true | | NO_ACCOUNTS_FOUND | No accounts match the filters | | VALIDATION_ERROR | An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field | | TOO_MANY_ACCOUNTS | Over 100 accounts without specific IDs | | NO_FIELDS_TO_UPDATE | No valid update fields provided | | NEGATIVE_BALANCE_NOT_ALLOWED | currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them) | | CLOSE_NOT_CONFIRMED (502) | Trading confirmed the close for none of the accounts; nothing was changed | | BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409) | Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader\u0026#x27;s first trade; nothing was changed (data.accountIds lists up to 100 of them) | Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account\u0026#x27;s open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well. Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved. Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account\u0026#x27;s live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account\u0026#x27;s balance adjustments, fires account.balance_adjusted, and does not count toward the day\u0026#x27;s profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage 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/trading-accounts/bulk-update-trading-accounts\">\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=Trading+accounts\u0026amp;title=Bulk+update+trading+accounts\u0026amp;description=Bulk+update+multiple+trading+accounts+at+once.+**Admin+only**.%0A%0AAll+changes+are+logged+to+the+audit+trail+with+the+batch+ID+for+easy+tracking.%0A%0A**Filters+%28at+le\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=94f54ea16add6e9607419483e34f33342006544720bb7c9ca9d7e66be111134a\">\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=\"Bulk update trading accounts - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bulk update multiple trading accounts at once. Admin only. All changes are logged to the audit trail with the batch ID for easy tracking. Filters (at least one required): | Filter | Description | |--------|-------------| | accountIds | Specific account IDs to update (1 to 500; an empty list is refused) | | allAccounts | true to select every account of the organization; required when no other filter is given, and not combinable with accountIds | | status | Filter by current status | | createdAfter / createdBefore | Filter by creation date | | startedAfter / startedBefore | Filter by start timestamp | | tradingPlanId | Filter by trading plan | | userId | Filter by user ID | Updates (at least one required): | Update | Description | |--------|-------------| | status | Change status | | currentBalance | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) | | highWaterMark | Set new high water mark | | dailyStartingBalance | Set new daily starting balance | | violationReason | Set or clear (null) violation reason | | performanceData | Replace performance data (trade counts as whole numbers, other figures as numbers) | | metadata | Replace metadata | | resetToInitial | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) | Safety: - A reason is required for all bulk updates - Max 100 accounts without specifying accountIds - Max 500 accountIds per call — split larger sets into several calls - All changes are logged with before/after values Example - Reset failed accounts after outage: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;startedAfter\u0026quot;: \u0026quot;2026-01-15T14:00:00Z\u0026quot;, \u0026quot;startedBefore\u0026quot;: \u0026quot;2026-01-15T16:00:00Z\u0026quot; }, \u0026quot;updates\u0026quot;: { \u0026quot;resetToInitial\u0026quot;: true }, \u0026quot;reason\u0026quot;: \u0026quot;Outage compensation\u0026quot; }\u0026#x27; Example - Bulk fail accounts: bash curl -X POST \u0026quot;.../bulk-update\u0026quot; \\ -d \u0026#x27;{ \u0026quot;filters\u0026quot;: { \u0026quot;accountIds\u0026quot;: [\u0026quot;id1\u0026quot;, \u0026quot;id2\u0026quot;, \u0026quot;id3\u0026quot;] }, \u0026quot;updates\u0026quot;: { \u0026quot;status\u0026quot;: \u0026quot;failed\u0026quot;, \u0026quot;violationReason\u0026quot;: \u0026quot;Terms of service violation\u0026quot; }, \u0026quot;reason\u0026quot;: \u0026quot;ToS violation - detected automated trading\u0026quot; }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | REASON_REQUIRED | Reason must be at least 3 characters | | FILTERS_REQUIRED | No filter narrows the selection and allAccounts is not true | | NO_ACCOUNTS_FOUND | No accounts match the filters | | VALIDATION_ERROR | An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field | | TOO_MANY_ACCOUNTS | Over 100 accounts without specific IDs | | NO_FIELDS_TO_UPDATE | No valid update fields provided | | NEGATIVE_BALANCE_NOT_ALLOWED | currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them) | | CLOSE_NOT_CONFIRMED (502) | Trading confirmed the close for none of the accounts; nothing was changed | | BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409) | Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader\u0026#x27;s first trade; nothing was changed (data.accountIds lists up to 100 of them) | Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account\u0026#x27;s open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well. Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved. Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account\u0026#x27;s live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account\u0026#x27;s balance adjustments, fires account.balance_adjusted, and does not count toward the day\u0026#x27;s profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Operations \u0026amp; time machine.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Trading+accounts\u0026amp;title=Bulk+update+trading+accounts\u0026amp;description=Bulk+update+multiple+trading+accounts+at+once.+**Admin+only**.%0A%0AAll+changes+are+logged+to+the+audit+trail+with+the+batch+ID+for+easy+tracking.%0A%0A**Filters+%28at+le\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=94f54ea16add6e9607419483e34f33342006544720bb7c9ca9d7e66be111134a\">\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/trading-accounts/bulk-update-trading-accounts\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-api/trading-accounts/bulk-update-trading-accounts.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/trading-accounts/bulk-update-trading-accounts#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts\",\"name\":\"Bulk update trading accounts\",\"description\":\"Bulk update multiple trading accounts at once. Admin only. All changes are logged to the audit trail with the batch ID for easy tracking. Filters (at least one required): | Filter | Description | |--------|-------------| | accountIds | Specific account IDs to update (1 to 500; an empty list is refused) | | allAccounts | true to select every account of the organization; required when no other filter is given, and not combinable with accountIds | | status | Filter by current status | | createdAfter / createdBefore | Filter by creation date | | startedAfter / startedBefore | Filter by start timestamp | | tradingPlanId | Filter by trading plan | | userId | Filter by user ID | Updates (at least one required): | Update | Description | |--------|-------------| | status | Change status | | currentBalance | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) | | highWaterMark | Set new high water mark | | dailyStartingBalance | Set new daily starting balance | | violationReason | Set or clear (null) violation reason | | performanceData | Replace performance data (trade counts as whole numbers, other figures as numbers) | | metadata | Replace metadata | | resetToInitial | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) | Safety: - A reason is required for all bulk updates - Max 100 accounts without specifying accountIds - Max 500 accountIds per call — split larger sets into several calls - All changes are logged with before/after values Example - Reset failed accounts after outage: bash curl -X POST \\\"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\\\" \\\\ -H \\\"X-API-Key: hp_live_your_key_here\\\" \\\\ -H \\\"Content-Type: application/json\\\" \\\\ -d '{ \\\"filters\\\": { \\\"status\\\": \\\"failed\\\", \\\"startedAfter\\\": \\\"2026-01-15T14:00:00Z\\\", \\\"startedBefore\\\": \\\"2026-01-15T16:00:00Z\\\" }, \\\"updates\\\": { \\\"resetToInitial\\\": true }, \\\"reason\\\": \\\"Outage compensation\\\" }' Example - Bulk fail accounts: bash curl -X POST \\\".../bulk-update\\\" \\\\ -d '{ \\\"filters\\\": { \\\"accountIds\\\": [\\\"id1\\\", \\\"id2\\\", \\\"id3\\\"] }, \\\"updates\\\": { \\\"status\\\": \\\"failed\\\", \\\"violationReason\\\": \\\"Terms of service violation\\\" }, \\\"reason\\\": \\\"ToS violation - detected automated trading\\\" }' Error Codes: | Code | Description | |------|-------------| | REASON_REQUIRED | Reason must be at least 3 characters | | FILTERS_REQUIRED | No filter narrows the selection and allAccounts is not true | | NO_ACCOUNTS_FOUND | No accounts match the filters | | VALIDATION_ERROR | An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field | | TOO_MANY_ACCOUNTS | Over 100 accounts without specific IDs | | NO_FIELDS_TO_UPDATE | No valid update fields provided | | NEGATIVE_BALANCE_NOT_ALLOWED | currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them) | | CLOSE_NOT_CONFIRMED (502) | Trading confirmed the close for none of the accounts; nothing was changed | | BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409) | Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader's first trade; nothing was changed (data.accountIds lists up to 100 of them) | Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account's open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well. Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved. Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account's live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account's balance adjustments, fires account.balance_adjusted, and does not count toward the day's profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly. 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.\",\"dateModified\":\"2026-11-15T15:41:09.273Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts#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\":\"Trading accounts\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/list-close-all-runs\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bulk update trading accounts\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts#apireference\",\"headline\":\"Bulk update trading accounts\",\"name\":\"Bulk update trading accounts\",\"description\":\"Bulk update multiple trading accounts at once. Admin only. All changes are logged to the audit trail with the batch ID for easy tracking. Filters (at least one required): | Filter | Description | |--------|-------------| | accountIds | Specific account IDs to update (1 to 500; an empty list is refused) | | allAccounts | true to select every account of the organization; required when no other filter is given, and not combinable with accountIds | | status | Filter by current status | | createdAfter / createdBefore | Filter by creation date | | startedAfter / startedBefore | Filter by start timestamp | | tradingPlanId | Filter by trading plan | | userId | Filter by user ID | Updates (at least one required): | Update | Description | |--------|-------------| | status | Change status | | currentBalance | Set new balance. Below zero only on accounts that start at 0, unless the account is or becomes passed, failed or expired. On an account that is not passed, failed or expired after the update, the change is applied as a balance adjustment, as on a single account edit (see below) | | highWaterMark | Set new high water mark | | dailyStartingBalance | Set new daily starting balance | | violationReason | Set or clear (null) violation reason | | performanceData | Replace performance data (trade counts as whole numbers, other figures as numbers) | | metadata | Replace metadata | | resetToInitial | Reset to initial balance + in_progress status; a daily loss limit switched off at its balance target is enforced again, a loss floor locked by a payout is cleared and a new payout cycle starts (the payout count stays) | Safety: - A reason is required for all bulk updates - Max 100 accounts without specifying accountIds - Max 500 accountIds per call — split larger sets into several calls - All changes are logged with before/after values Example - Reset failed accounts after outage: bash curl -X POST \\\"https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk-update\\\" \\\\ -H \\\"X-API-Key: hp_live_your_key_here\\\" \\\\ -H \\\"Content-Type: application/json\\\" \\\\ -d '{ \\\"filters\\\": { \\\"status\\\": \\\"failed\\\", \\\"startedAfter\\\": \\\"2026-01-15T14:00:00Z\\\", \\\"startedBefore\\\": \\\"2026-01-15T16:00:00Z\\\" }, \\\"updates\\\": { \\\"resetToInitial\\\": true }, \\\"reason\\\": \\\"Outage compensation\\\" }' Example - Bulk fail accounts: bash curl -X POST \\\".../bulk-update\\\" \\\\ -d '{ \\\"filters\\\": { \\\"accountIds\\\": [\\\"id1\\\", \\\"id2\\\", \\\"id3\\\"] }, \\\"updates\\\": { \\\"status\\\": \\\"failed\\\", \\\"violationReason\\\": \\\"Terms of service violation\\\" }, \\\"reason\\\": \\\"ToS violation - detected automated trading\\\" }' Error Codes: | Code | Description | |------|-------------| | REASON_REQUIRED | Reason must be at least 3 characters | | FILTERS_REQUIRED | No filter narrows the selection and allAccounts is not true | | NO_ACCOUNTS_FOUND | No accounts match the filters | | VALIDATION_ERROR | An empty or over-500 accountIds list, accountIds together with allAccounts, or another invalid field | | TOO_MANY_ACCOUNTS | Over 100 accounts without specific IDs | | NO_FIELDS_TO_UPDATE | No valid update fields provided | | NEGATIVE_BALANCE_NOT_ALLOWED | currentBalance is below zero and a selected live account starts above 0; nothing was changed (data.accountIds lists up to 50 of them) | | CLOSE_NOT_CONFIRMED (502) | Trading confirmed the close for none of the accounts; nothing was changed | | BALANCE_AT_OR_BELOW_LOCKED_FLOOR (409) | Without resetToInitial, the change would leave an account open at or below the loss floor a payout locked, where it would fail at the trader's first trade; nothing was changed (data.accountIds lists up to 100 of them) | Closing first: when the status moves to passed, failed, expired or not_started, or with resetToInitial, each account's open positions are closed at market and its working orders cancelled before the change is written. An account for which trading does not confirm that is left unchanged and listed in closeNotConfirmed. Once accounts have passed, failed or expired, anything opened in the meantime is closed as well. Large updates: accounts are saved in groups of 200. If saving fails for a group, the other groups are still updated completely (trading, change history and events) and the accounts of the failed group are listed in notUpdated; the response is 500 only when no account could be saved. Balance on live accounts: for an account that is not passed, failed or expired after the update, currentBalance is applied as a balance adjustment of the difference to the account's live balance, after the other changes in the request, exactly like a single account edit. It is recorded in the account's balance adjustments, fires account.balance_adjusted, and does not count toward the day's profit or loss (the daily starting balance moves with it unless the request also sets dailyStartingBalance). An account whose adjustment was not applied is listed in balanceNotApplied with a code (OUTCOME_UNKNOWN: check the balance before sending again; BALANCE_EDIT_IN_PROGRESS, ACCOUNT_CLOSED, INSUFFICIENT_BALANCE, ADJUSTMENT_NOT_APPLIED); the other changes for it are kept. Passed, failed and expired accounts get the balance written directly. 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.\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/bulk-update-trading-accounts#webpage\"},\"dateModified\":\"2026-11-15T15:41:09.273Z\",\"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/trading-accounts/bulk-update-trading-accounts.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","description":"Create up to **100 unlinked accounts** in one call — for giveaways, competitions, or pre-provisioning inventory.\n\nEvery account is created with:\n- no trader attached (`userId: null`)\n- its own one-time **`importKey`** (serial-key style, e.g. `HP-7K3QF-9XT2M-4WHRD`)\n- `not_started` status\n- **no billing and no CME entitlement** — both start only when a key is redeemed\n\nHand each `importKey` to a customer; they redeem it inside the Hyperprop app under **Trading Accounts → Import**. Each redemption fires an `account.imported` webhook with the redeemer's email, the key, and a timestamp — your verification trail.\n\n`customerIdPrefix` is **required**: each account gets a sequential customerId (`promo-summer-001`, `promo-summer-002`, ...) you can query later via `GET /trading-accounts?customerId=...`. Numbering continues after the highest number the prefix already has in your organization, so a second call with the same prefix starts at `-101` after a first call of 100.\n\n**Soulbound note:** identity bindings are keyed on `customerId`, and sequential prefix ids give every account a *different* placeholder customer — right for giveaways where each key goes to a different winner (each redemption creates its own binding). If several accounts in a batch are for the SAME customer, `PATCH` their `customerId` to that customer's real ID after creation so all their imports enforce one shared Hyperprop login.\n\nList remaining unredeemed accounts (keys included) anytime with `GET /trading-accounts?unlinked=true`.\n\nAn `account.created` webhook fires for each account with `data.importKey`, `data.metadata.unlinked: true`, and a shared `batch_id`.\n\n**Permissions:** organization **admins** only.\n\n**Error codes:** `VALIDATION_ERROR`, `PLAN_NOT_FOUND`, `PLAN_NOT_ACTIVE`, `NO_TRADING_RULE`, `RULE_NOT_FOUND`, `BULK_CREATE_ERROR`.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Traders \u0026 accounts.","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","description":"The kill switch for outages and incidents. Closes every open position at market and cancels every working order on every tradable account of your organization (`allAccounts: true`), or on the accounts you list (`accountIds`).\n\n**This does not lock accounts.** Statuses do not change and traders can place new orders straight away. To stop trading as well, add a lockout with `POST /organization/lockouts` for the accounts concerned.\n\nThe run continues in the background and the call returns `202` with a `runId` at once. Follow it with `GET /organization/flatten-runs/{runId}` until `status` is `completed`: it reports accounts handled, positions closed, orders cancelled, and any account that could not be confirmed. Accounts that are already flat are left alone, so running it again is safe and covers anything that failed.\n\n`allAccounts` covers accounts that are not started or in progress. Passed, failed, expired and turned-off accounts cannot trade; to close something left on one of them, list it in `accountIds`.\n\nThe resulting orders carry reason `Admin flatten: \u003cwho> — \u003cyour reason>` (trigger `admin_flatten`). Each account where something was closed or cancelled gets an `ACCOUNT_UPDATED` event with the counts; accounts with nothing to close get no event.\n\nSend `preview: true` first to see how many accounts the run would cover. One run per organization at a time.\n\nRequires **manage** permission on traders.\n\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-accounts/flatten\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"allAccounts\": true, \"reason\": \"Market data 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 Traders \u0026 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","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","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":"Bulk update trading accounts - 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"]}