Retrieve all trading accounts for your organization with powerful filtering and search.
What is a trading account?
A trading account represents a trader’s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.
Account types:
Type
Description
evaluation
Challenge account where trader must hit profit target
sim_funded
Simulated funded account after passing evaluation
Account statuses:
Status
Description
not_started
Account created but trader hasn’t begun trading
in_progress
Trader is actively trading
passed
Trader hit profit target and passed the evaluation
failed
Trader violated a rule (max loss, drawdown, etc.)
expired
Evaluation period ended without passing
What you get for each account:
Account details (number, type, status, balances)
Performance data and high water mark
Trading plan and rules applied
Trader info (your customer’s email and name)
Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys)
Purchase details (what they paid)
Custom metadata (any JSON data you need)
Search:
The search parameter is flexible and matches:
Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K
Trader email (partial match): ?search=john@
Trader name, username or external user ID (partial match): ?search=John
Hyperprop trader ID: ?search=%2300012340 or ?search=12340
Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7
User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111
Metadata is not searched; use ?metadata=key:value to filter by it.
Totals and paging:hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match.
Lookup by your own customer ID:?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.)
Example queries:
# Find all active evaluationsGET /organization/trading-accounts?type=evaluation&status=in_progress# Search for a specific traderGET /organization/trading-accounts?search=john@example.com# Get all passed accounts this monthGET /organization/trading-accounts?status=passed&startDate=2025-01-01&endDate=2025-01-31# Find high-priority accounts that are in progressGET /organization/trading-accounts?metadata=priority:high&status=in_progress# Page through results (page 2, 25 per page)GET /organization/trading-accounts?limit=25&offset=25
Use cases:
Monitor active evaluations in real-time
Find accounts for a specific trader
Generate pass/fail reports
Track VIP or promotional accounts
Audit account history for compliance
Access: read-only and full-access API keys. Dashboard members need view access to Traders & accounts.
GET
/
v1
/
organization
/
trading-accounts
Get trading accounts for your organization
curl --request GET \ --url https://api.hyperprop.com/platform/v1/organization/trading-accounts \ --header 'X-API-Key: <api-key>'
{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}
Authorizations
X-API-Key
string
header
required
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Query Parameters
search
string
Searches the whole organization, not just the current page. Case-insensitive; minimum 2 characters. Matches account number, customer ID, import key and your external purchase ID (full or partial), account ID (full or partial, at least 4 hexadecimal characters), the start of the trader's user ID or organizationUserId, the Hyperprop trader ID ("#00012340" or just the digits), and the trader's email (sign-in email or the one you supplied), full name, username, display name, profile name and external user ID (partial). Metadata is not searched; use the metadata parameter to filter by key:value. Results are ranked: exact account number, account ID, customer ID or import key first, then account number or account ID prefix, then substring, then trader-level matches; the other filters apply to the whole ranked result set, and pagination and total apply to the filtered result (at most 1,000 matches). A search pages with offset; it returns no nextCursor.
type
enum<string>
Filter by account type
Available options:
evaluation,
sim_funded,
competition
status
enum<string>
Filter by account status. inactive = turned off by your firm (see POST /trading-accounts/{accountId}/deactivate).
Available options:
not_started,
in_progress,
inactive,
passed,
failed,
expired
planId
string
Filter by trading plan (the plan the account was purchased under)
metadata
string
Filter by metadata key:value (e.g., "vip:true", "source:affiliate")
customerId
string
Exact match on the customerId you set at account creation (or via PATCH). Deterministic lookup of all accounts belonging to one of your customers.
Maximum string length: 255
externalRef
string
DEPRECATED alias for customerId — use customerId instead.
Maximum string length: 255
unlinked
boolean
true = only accounts with no trader attached yet (their one-time importKey is included in each row, except for read-only API keys); false = only linked accounts. Omit for both.
startDate
string
Only include accounts created from this date onwards
endDate
string
Only include accounts created up to this date
limit
integer
default:50
Results per page (default: 50, max: 100)
Required range: 1 <= x <= 100
offset
integer
default:0
Skip this many results (for pagination)
Required range: x >= 0
cursor
string
Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.
How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.
Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.
A cursor that was not returned by this endpoint, or one from a request with a different sort, is rejected with 400.
Maximum string length: 512
Response
Success - Returns paginated list of trading accounts
{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Hyperprop Platform API","colors":{"primary":"#253CFF","light":"#253CFF","dark":"#253CFF"},"logo":{"light":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3","dark":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/dark.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=1e52fc25e71c2a6a9e047b4fbd60dae4","href":"https://hyperprop.com"},"favicon":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/favicon.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=760656e341413d4cd9dae53925c04cf6","navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://portal.hyperprop.com"}},"footer":{"socials":{"x":"https://x.com/hyperpropcom","github":"https://github.com/Hyperprop-LLC-FZ"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperprop-401fc39d","hasAudioNarration":false,"actualSubdomain":"hyperprop-401fc39d","customDomains":["docs.hyperprop.com"],"gitSource":{"type":"github","owner":"hyperprop-llc-fz","repo":"hyperprop-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9d28c5400fbb020686d90","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":246},{"language":"default","tag":"Platform API","count":202},{"language":"default","tag":"Trade API","count":44},{"language":"default","tag":"Risk","count":39},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Trading accounts","count":29},{"language":"default","tag":"Mass credit","count":23},{"language":"default","tag":"Billing and invoices","count":16},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Webhooks","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar nav-logo img,nav-logo img{height:2rem!important;width:auto}@media (max-width: 640px){pre{max-width:100%;overflow-x:auto}pre code{white-space:pre;word-break:normal}}@media (max-width: 640px){.prose table,#content-area table{display:block;max-width:100%;overflow-x:auto}}html.dark pre.shiki.shiki-themes,html[data-theme=\"dark\"] pre.shiki.shiki-themes{background-color:var(--shiki-dark-bg)!important;color:var(--shiki-dark)!important}html.dark pre.shiki.shiki-themes span,html[data-theme=\"dark\"] pre.shiki.shiki-themes span{color:var(--shiki-dark)!important;font-style:var(--shiki-dark-font-style)!important;font-weight:var(--shiki-dark-font-weight)!important;text-decoration:var(--shiki-dark-text-decoration)!important}"}],"page":{"pagePath":"platform-api/trading-accounts/get-trading-accounts-for-your-organization","slug":"/platform-api/trading-accounts/get-trading-accounts-for-your-organization","pageMetadata":{"title":"Get trading accounts for your organization","description":"Retrieve all trading accounts for your organization with powerful filtering and search.\n\n**What is a trading account?**\nA trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.\n\n**Account types:**\n\n| Type | Description |\n|------|-------------|\n| `evaluation` | Challenge account where trader must hit profit target |\n| `sim_funded` | Simulated funded account after passing evaluation |\n\n**Account statuses:**\n\n| Status | Description |\n|--------|-------------|\n| `not_started` | Account created but trader hasn't begun trading |\n| `in_progress` | Trader is actively trading |\n| `passed` | Trader hit profit target and passed the evaluation |\n| `failed` | Trader violated a rule (max loss, drawdown, etc.) |\n| `expired` | Evaluation period ended without passing |\n\n**What you get for each account:**\n- Account details (number, type, status, balances)\n- Performance data and high water mark\n- Trading plan and rules applied\n- Trader info (your customer's email and name)\n- Linked Hyperprop user (or the one-time `importKey` while still unlinked; null for read-only API keys)\n- Purchase details (what they paid)\n- Custom metadata (any JSON data you need)\n\n**Search:**\nThe `search` parameter is flexible and matches:\n- Account number, customer ID, import key or your external purchase ID (partial match): `?search=ACME-100K`\n- Trader email (partial match): `?search=john@`\n- Trader name, username or external user ID (partial match): `?search=John`\n- Hyperprop trader ID: `?search=%2300012340` or `?search=12340`\n- Account ID (full or partial): `?search=7c9e6679-7425-40de-944b-e07fc1f90ae7`\n- User ID (full, or its first characters): `?search=11111111-1111-4111-8111-111111111111`\n\nMetadata is not searched; use `?metadata=key:value` to filter by it.\n\n**Totals and paging:**\n`hasMore` and `nextCursor` always reflect the list as it is now. Without `search`, `pagination.total` is an exact count that may be reused for up to 60 seconds for the same filters; `pagination.totalCountedAt` says when it was taken. When an offset page reaches the end of the list, `total` is counted from that page and is current. With `search`, `total` is the number of ranked matches, at most 1,000; `totalCapped: true` means the limit was reached and more accounts may match.\n\n**Lookup by your own customer ID:**\n`?customerId=acme-cust-4471` returns all accounts of the customer whose `customerId` you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (`?externalRef=` still works as a deprecated alias.)\n\n**Example queries:**\n```http\n# Find all active evaluations\nGET /organization/trading-accounts?type=evaluation\u0026status=in_progress\n\n# Search for a specific trader\nGET /organization/trading-accounts?search=john@example.com\n\n# Get all passed accounts this month\nGET /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31\n\n# Find high-priority accounts that are in progress\nGET /organization/trading-accounts?metadata=priority:high\u0026status=in_progress\n\n# Page through results (page 2, 25 per page)\nGET /organization/trading-accounts?limit=25\u0026offset=25\n```\n\n**Use cases:**\n- Monitor active evaluations in real-time\n- Find accounts for a specific trader\n- Generate pass/fail reports\n- Track VIP or promotional accounts\n- Audit account history for compliance\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.","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","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: [_jsx(_components.p, {\n children: \"Retrieve all trading accounts for your organization with powerful filtering and search.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"What is a trading account?\"\n }), \"\\nA trading account represents a trader’s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Account types:\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Type\"\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: \"evaluation\"\n })\n }), _jsx(_components.td, {\n children: \"Challenge account where trader must hit profit target\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sim_funded\"\n })\n }), _jsx(_components.td, {\n children: \"Simulated funded account after passing evaluation\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Account statuses:\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Status\"\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: \"not_started\"\n })\n }), _jsx(_components.td, {\n children: \"Account created but trader hasn’t begun trading\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"in_progress\"\n })\n }), _jsx(_components.td, {\n children: \"Trader is actively trading\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"passed\"\n })\n }), _jsx(_components.td, {\n children: \"Trader hit profit target and passed the evaluation\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"failed\"\n })\n }), _jsx(_components.td, {\n children: \"Trader violated a rule (max loss, drawdown, etc.)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"expired\"\n })\n }), _jsx(_components.td, {\n children: \"Evaluation period ended without passing\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"What you get for each account:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Account details (number, type, status, balances)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Performance data and high water mark\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Trading plan and rules applied\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Trader info (your customer’s email and name)\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Linked Hyperprop user (or the one-time \", _jsx(_components.code, {\n children: \"importKey\"\n }), \" while still unlinked; null for read-only API keys)\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Purchase details (what they paid)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Custom metadata (any JSON data you need)\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Search:\"\n }), \"\\nThe \", _jsx(_components.code, {\n children: \"search\"\n }), \" parameter is flexible and matches:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Account number, customer ID, import key or your external purchase ID (partial match): \", _jsx(_components.code, {\n children: \"?search=ACME-100K\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Trader email (partial match): \", _jsx(_components.code, {\n children: \"?search=john@\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Trader name, username or external user ID (partial match): \", _jsx(_components.code, {\n children: \"?search=John\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Hyperprop trader ID: \", _jsx(_components.code, {\n children: \"?search=%2300012340\"\n }), \" or \", _jsx(_components.code, {\n children: \"?search=12340\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Account ID (full or partial): \", _jsx(_components.code, {\n children: \"?search=7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"User ID (full, or its first characters): \", _jsx(_components.code, {\n children: \"?search=11111111-1111-4111-8111-111111111111\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Metadata is not searched; use \", _jsx(_components.code, {\n children: \"?metadata=key:value\"\n }), \" to filter by it.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Totals and paging:\"\n }), \"\\n\", _jsx(_components.code, {\n children: \"hasMore\"\n }), \" and \", _jsx(_components.code, {\n children: \"nextCursor\"\n }), \" always reflect the list as it is now. Without \", _jsx(_components.code, {\n children: \"search\"\n }), \", \", _jsx(_components.code, {\n children: \"pagination.total\"\n }), \" is an exact count that may be reused for up to 60 seconds for the same filters; \", _jsx(_components.code, {\n children: \"pagination.totalCountedAt\"\n }), \" says when it was taken. When an offset page reaches the end of the list, \", _jsx(_components.code, {\n children: \"total\"\n }), \" is counted from that page and is current. With \", _jsx(_components.code, {\n children: \"search\"\n }), \", \", _jsx(_components.code, {\n children: \"total\"\n }), \" is the number of ranked matches, at most 1,000; \", _jsx(_components.code, {\n children: \"totalCapped: true\"\n }), \" means the limit was reached and more accounts may match.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Lookup by your own customer ID:\"\n }), \"\\n\", _jsx(_components.code, {\n children: \"?customerId=acme-cust-4471\"\n }), \" returns all accounts of the customer whose \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (\", _jsx(_components.code, {\n children: \"?externalRef=\"\n }), \" still works as a deprecated alias.)\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example queries:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"14\",\n language: \"http\",\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: \"http\",\n children: _jsxs(_components.code, {\n language: \"http\",\n numberOfLines: \"14\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#6E7781\",\n \"--shiki-dark\": \"#6A9955\"\n },\n children: \"# Find all active evaluations\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#C586C0\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" /organization/trading-accounts?type=evaluation\u0026status=in_progress\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#6E7781\",\n \"--shiki-dark\": \"#6A9955\"\n },\n children: \"# Search for a specific trader\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#C586C0\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" /organization/trading-accounts?search=john@example.com\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#6E7781\",\n \"--shiki-dark\": \"#6A9955\"\n },\n children: \"# Get all passed accounts this month\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#C586C0\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#6E7781\",\n \"--shiki-dark\": \"#6A9955\"\n },\n children: \"# Find high-priority accounts that are in progress\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#C586C0\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" /organization/trading-accounts?metadata=priority:high\u0026status=in_progress\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#6E7781\",\n \"--shiki-dark\": \"#6A9955\"\n },\n children: \"# Page through results (page 2, 25 per page)\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#CF222E\",\n \"--shiki-dark\": \"#C586C0\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" /organization/trading-accounts?limit=25\u0026offset=25\"\n })]\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Use cases:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Monitor active evaluations in real-time\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Find accounts for a specific trader\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Generate pass/fail reports\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Track VIP or promotional accounts\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Audit account history for compliance\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.\"]\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":"Get trading accounts for your organization","description":"Retrieve all trading accounts for your organization with powerful filtering and search.\n\n**What is a trading account?**\nA trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.\n\n**Account types:**\n\n| Type | Description |\n|------|-------------|\n| `evaluation` | Challenge account where trader must hit profit target |\n| `sim_funded` | Simulated funded account after passing evaluation |\n\n**Account statuses:**\n\n| Status | Description |\n|--------|-------------|\n| `not_started` | Account created but trader hasn't begun trading |\n| `in_progress` | Trader is actively trading |\n| `passed` | Trader hit profit target and passed the evaluation |\n| `failed` | Trader violated a rule (max loss, drawdown, etc.) |\n| `expired` | Evaluation period ended without passing |\n\n**What you get for each account:**\n- Account details (number, type, status, balances)\n- Performance data and high water mark\n- Trading plan and rules applied\n- Trader info (your customer's email and name)\n- Linked Hyperprop user (or the one-time `importKey` while still unlinked; null for read-only API keys)\n- Purchase details (what they paid)\n- Custom metadata (any JSON data you need)\n\n**Search:**\nThe `search` parameter is flexible and matches:\n- Account number, customer ID, import key or your external purchase ID (partial match): `?search=ACME-100K`\n- Trader email (partial match): `?search=john@`\n- Trader name, username or external user ID (partial match): `?search=John`\n- Hyperprop trader ID: `?search=%2300012340` or `?search=12340`\n- Account ID (full or partial): `?search=7c9e6679-7425-40de-944b-e07fc1f90ae7`\n- User ID (full, or its first characters): `?search=11111111-1111-4111-8111-111111111111`\n\nMetadata is not searched; use `?metadata=key:value` to filter by it.\n\n**Totals and paging:**\n`hasMore` and `nextCursor` always reflect the list as it is now. Without `search`, `pagination.total` is an exact count that may be reused for up to 60 seconds for the same filters; `pagination.totalCountedAt` says when it was taken. When an offset page reaches the end of the list, `total` is counted from that page and is current. With `search`, `total` is the number of ranked matches, at most 1,000; `totalCapped: true` means the limit was reached and more accounts may match.\n\n**Lookup by your own customer ID:**\n`?customerId=acme-cust-4471` returns all accounts of the customer whose `customerId` you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (`?externalRef=` still works as a deprecated alias.)\n\n**Example queries:**\n```http\n# Find all active evaluations\nGET /organization/trading-accounts?type=evaluation\u0026status=in_progress\n\n# Search for a specific trader\nGET /organization/trading-accounts?search=john@example.com\n\n# Get all passed accounts this month\nGET /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31\n\n# Find high-priority accounts that are in progress\nGET /organization/trading-accounts?metadata=priority:high\u0026status=in_progress\n\n# Page through results (page 2, 25 per page)\nGET /organization/trading-accounts?limit=25\u0026offset=25\n```\n\n**Use cases:**\n- Monitor active evaluations in real-time\n- Find accounts for a specific trader\n- Generate pass/fail reports\n- Track VIP or promotional accounts\n- Audit account history for compliance\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get trading accounts for your organization","operationId":"getV1OrganizationTradingaccounts","description":"Retrieve all trading accounts for your organization with powerful filtering and search.\n\n**What is a trading account?**\nA trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.\n\n**Account types:**\n\n| Type | Description |\n|------|-------------|\n| `evaluation` | Challenge account where trader must hit profit target |\n| `sim_funded` | Simulated funded account after passing evaluation |\n\n**Account statuses:**\n\n| Status | Description |\n|--------|-------------|\n| `not_started` | Account created but trader hasn't begun trading |\n| `in_progress` | Trader is actively trading |\n| `passed` | Trader hit profit target and passed the evaluation |\n| `failed` | Trader violated a rule (max loss, drawdown, etc.) |\n| `expired` | Evaluation period ended without passing |\n\n**What you get for each account:**\n- Account details (number, type, status, balances)\n- Performance data and high water mark\n- Trading plan and rules applied\n- Trader info (your customer's email and name)\n- Linked Hyperprop user (or the one-time `importKey` while still unlinked; null for read-only API keys)\n- Purchase details (what they paid)\n- Custom metadata (any JSON data you need)\n\n**Search:**\nThe `search` parameter is flexible and matches:\n- Account number, customer ID, import key or your external purchase ID (partial match): `?search=ACME-100K`\n- Trader email (partial match): `?search=john@`\n- Trader name, username or external user ID (partial match): `?search=John`\n- Hyperprop trader ID: `?search=%2300012340` or `?search=12340`\n- Account ID (full or partial): `?search=7c9e6679-7425-40de-944b-e07fc1f90ae7`\n- User ID (full, or its first characters): `?search=11111111-1111-4111-8111-111111111111`\n\nMetadata is not searched; use `?metadata=key:value` to filter by it.\n\n**Totals and paging:**\n`hasMore` and `nextCursor` always reflect the list as it is now. Without `search`, `pagination.total` is an exact count that may be reused for up to 60 seconds for the same filters; `pagination.totalCountedAt` says when it was taken. When an offset page reaches the end of the list, `total` is counted from that page and is current. With `search`, `total` is the number of ranked matches, at most 1,000; `totalCapped: true` means the limit was reached and more accounts may match.\n\n**Lookup by your own customer ID:**\n`?customerId=acme-cust-4471` returns all accounts of the customer whose `customerId` you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (`?externalRef=` still works as a deprecated alias.)\n\n**Example queries:**\n```http\n# Find all active evaluations\nGET /organization/trading-accounts?type=evaluation\u0026status=in_progress\n\n# Search for a specific trader\nGET /organization/trading-accounts?search=john@example.com\n\n# Get all passed accounts this month\nGET /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31\n\n# Find high-priority accounts that are in progress\nGET /organization/trading-accounts?metadata=priority:high\u0026status=in_progress\n\n# Page through results (page 2, 25 per page)\nGET /organization/trading-accounts?limit=25\u0026offset=25\n```\n\n**Use cases:**\n- Monitor active evaluations in real-time\n- Find accounts for a specific trader\n- Generate pass/fail reports\n- Track VIP or promotional accounts\n- Audit account history for compliance\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.","parameters":["284eff7b-ff8a-4254-b00a-ba53f08d0825","5270d9f8-cde7-4465-92f5-175cc437cba5","4662333d-aa4e-4998-ab32-5611d7dfd5fb","3ff4ee37-2b88-40bd-8143-b9a2fa845322","2dd5d9e2-1a6e-454b-a621-bcc3423ca2d0","fac66359-cefe-44cb-8fca-e2953a6d293b","a5f88504-7ea3-4076-8855-854bf2005438","b68c70bd-1c88-4738-ae80-397f57e0ed61","3ace59d5-d785-46b4-8aad-4d273147e103","efc2f558-9c05-473a-b07e-1a72c240286c","53f59206-233c-43b7-b4f6-a8f73e38288a","5924882b-22b3-4002-93b4-e8d5b5af6f8f","ce27d567-bdf5-45ad-ba04-faf14eeb26d2"],"tags":["Trading accounts"],"security":["3ba990b1-0f89-4ad3-ad52-ab106e2a8108"],"responses":{"200":"ccfad784-70e3-4856-a264-7287bc8692dc","400":"ba7ea034-1fb8-4dd7-9ca3-e55c620c2952","401":"81658e04-b1e8-46c3-8bf0-73f664b19e98","403":"d773ea99-54b0-4e1c-a638-e92753adb670","500":"f1ed9fac-4b2a-4edc-bfa0-c0d0aca6ebae","504":"60041ec3-d702-4253-8314-526d085ee7c6"},"method":"get","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/trading-accounts","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Get trading accounts for your organization","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"284eff7b-ff8a-4254-b00a-ba53f08d0825":{"description":"Searches the whole organization, not just the current page. Case-insensitive; minimum 2 characters. Matches account number, customer ID, import key and your external purchase ID (full or partial), account ID (full or partial, at least 4 hexadecimal characters), the start of the trader's user ID or organizationUserId, the Hyperprop trader ID (\"#00012340\" or just the digits), and the trader's email (sign-in email or the one you supplied), full name, username, display name, profile name and external user ID (partial). Metadata is not searched; use the metadata parameter to filter by key:value. Results are ranked: exact account number, account ID, customer ID or import key first, then account number or account ID prefix, then substring, then trader-level matches; the other filters apply to the whole ranked result set, and pagination and total apply to the filtered result (at most 1,000 matches). A search pages with offset; it returns no nextCursor.","name":"search","in":"query","required":false,"example":"ACME-100K","schema":{"type":"string","isRequired":false,"description":"Searches the whole organization, not just the current page. Case-insensitive; minimum 2 characters. Matches account number, customer ID, import key and your external purchase ID (full or partial), account ID (full or partial, at least 4 hexadecimal characters), the start of the trader's user ID or organizationUserId, the Hyperprop trader ID (\"#00012340\" or just the digits), and the trader's email (sign-in email or the one you supplied), full name, username, display name, profile name and external user ID (partial). Metadata is not searched; use the metadata parameter to filter by key:value. Results are ranked: exact account number, account ID, customer ID or import key first, then account number or account ID prefix, then substring, then trader-level matches; the other filters apply to the whole ranked result set, and pagination and total apply to the filtered result (at most 1,000 matches). A search pages with offset; it returns no nextCursor.","uniqueKey":"","typeLabel":"string"}},"5270d9f8-cde7-4465-92f5-175cc437cba5":{"description":"Filter by account type","name":"type","in":"query","required":false,"example":"evaluation","schema":{"type":"string","enum":["evaluation","sim_funded","competition"],"isRequired":false,"description":"Filter by account type","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"4662333d-aa4e-4998-ab32-5611d7dfd5fb":{"description":"Filter by account status. `inactive` = turned off by your firm (see POST /trading-accounts/{accountId}/deactivate).","name":"status","in":"query","required":false,"example":"in_progress","schema":{"type":"string","enum":["not_started","in_progress","inactive","passed","failed","expired"],"isRequired":false,"description":"Filter by account status. `inactive` = turned off by your firm (see POST /trading-accounts/{accountId}/deactivate).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"3ff4ee37-2b88-40bd-8143-b9a2fa845322":{"description":"Filter by trading plan (the plan the account was purchased under)","x-format":{"guid":true},"name":"planId","in":"query","required":false,"example":"88888888-8888-4888-8888-888888888881","schema":{"type":"string","isRequired":false,"description":"Filter by trading plan (the plan the account was purchased under)","uniqueKey":"","typeLabel":"string"}},"2dd5d9e2-1a6e-454b-a621-bcc3423ca2d0":{"description":"Filter by metadata key:value (e.g., \"vip:true\", \"source:affiliate\")","name":"metadata","in":"query","required":false,"example":"priority:high","schema":{"type":"string","isRequired":false,"description":"Filter by metadata key:value (e.g., \"vip:true\", \"source:affiliate\")","uniqueKey":"","typeLabel":"string"}},"fac66359-cefe-44cb-8fca-e2953a6d293b":{"description":"Exact match on the customerId you set at account creation (or via PATCH). Deterministic lookup of all accounts belonging to one of your customers.","name":"customerId","in":"query","required":false,"example":"acme-cust-4471","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Exact match on the customerId you set at account creation (or via PATCH). Deterministic lookup of all accounts belonging to one of your customers.","uniqueKey":"","typeLabel":"string"}},"a5f88504-7ea3-4076-8855-854bf2005438":{"description":"DEPRECATED alias for customerId — use customerId instead.","name":"externalRef","in":"query","required":false,"example":"acme-cust-4471","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"DEPRECATED alias for customerId — use customerId instead.","uniqueKey":"","typeLabel":"string"}},"b68c70bd-1c88-4738-ae80-397f57e0ed61":{"description":"true = only accounts with no trader attached yet (their one-time importKey is included in each row, except for read-only API keys); false = only linked accounts. Omit for both.","name":"unlinked","in":"query","required":false,"example":true,"schema":{"type":"boolean","isRequired":false,"description":"true = only accounts with no trader attached yet (their one-time importKey is included in each row, except for read-only API keys); false = only linked accounts. Omit for both.","uniqueKey":"","typeLabel":"boolean"}},"3ace59d5-d785-46b4-8aad-4d273147e103":{"description":"Only include accounts created from this date onwards","x-format":{"isoDate":true},"name":"startDate","in":"query","required":false,"example":"2025-01-01","schema":{"type":"string","isRequired":false,"description":"Only include accounts created from this date onwards","uniqueKey":"","typeLabel":"string"}},"efc2f558-9c05-473a-b07e-1a72c240286c":{"description":"Only include accounts created up to this date","x-format":{"isoDate":true},"name":"endDate","in":"query","required":false,"example":"2025-01-31","schema":{"type":"string","isRequired":false,"description":"Only include accounts created up to this date","uniqueKey":"","typeLabel":"string"}},"53f59206-233c-43b7-b4f6-a8f73e38288a":{"description":"Results per page (default: 50, max: 100)","name":"limit","in":"query","example":50,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Results per page (default: 50, max: 100)","uniqueKey":"","typeLabel":"integer"}},"5924882b-22b3-4002-93b4-e8d5b5af6f8f":{"description":"Skip this many results (for pagination)","name":"offset","in":"query","example":0,"schema":{"type":"integer","minimum":0,"default":0,"description":"Skip this many results (for pagination)","uniqueKey":"","typeLabel":"integer"}},"ce27d567-bdf5-45ad-ba04-faf14eeb26d2":{"description":"Cursor for pagination. Pass the `nextCursor` value from the previous response to get the next page. When using cursor, do not send `offset` — it will be ignored.\n\n**How it works:** The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.\n\n**Backwards compatible:** If you don't send a cursor, offset/limit pagination works as before.\n\nA cursor that was not returned by this endpoint, or one from a request with a different `sort`, is rejected with 400.","name":"cursor","in":"query","required":false,"example":"ZXhhbXBsZS1jdXJzb3ItNi1vcGFxdWUtZG8tbm90LXBhcnNl","schema":{"type":"string","maxLength":512,"isRequired":false,"description":"Cursor for pagination. Pass the `nextCursor` value from the previous response to get the next page. When using cursor, do not send `offset` — it will be ignored.\n\n**How it works:** The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.\n\n**Backwards compatible:** If you don't send a cursor, offset/limit pagination works as before.\n\nA cursor that was not returned by this endpoint, or one from a request with a different `sort`, is rejected with 400.","uniqueKey":"","typeLabel":"string"}}},"responses":{"ccfad784-70e3-4856-a264-7287bc8692dc":{"description":"Success - Returns paginated list of trading accounts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","example":{"organizationId":"55555555-5555-4555-8555-555555555555","organizationName":"FakePropFirm","accounts":[{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","accountNumber":"ACC-7845KXPQ","type":"evaluation","status":"in_progress","initialBalance":50000,"currentBalance":52150,"highWaterMark":53200,"dailyStartingBalance":51800,"startedAt":"2026-02-01T09:00:00.000Z","completedAt":null,"violationReason":null,"metadata":{"source":"affiliate_program"},"userId":"11111111-1111-4111-8111-111111111111","userEmail":"trader@example.com","userAvatarUrl":"https://api.dicebear.com/9.x/glass/svg?seed=trader","tradingPlan":{"id":"88888888-8888-4888-8888-888888888881","name":"50K Challenge","accountSize":50000},"tradingRule":{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","profitTarget":4000,"maxLoss":2500,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null},"trader":{"email":"john.smith@example.com","name":"John Smith"},"purchase":{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","purchaseDate":"2026-01-28T10:00:00.000Z","pricePaid":299,"currency":"USD","metadata":{"paymentId":"pay_3ABC123"}},"createdAt":"2026-01-28T10:00:00.000Z","updatedAt":"2026-02-17T14:30:00.000Z"}],"pagination":{"total":142,"limit":50,"offset":0,"hasMore":true,"totalCapped":false,"totalCountedAt":"2026-10-12T09:14:03.000Z"}},"properties":{"organizationId":{"type":"string","description":"Your organization ID","uniqueKey":"data.organizationId","typeLabel":"string"},"organizationName":{"type":"string","description":"Your organization name","uniqueKey":"data.organizationName","typeLabel":"string"},"accounts":{"type":"array","description":"Array of trading accounts","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique account ID","uniqueKey":"data.accounts.items.[INDEX].id","typeLabel":"string"},"accountNumber":{"type":"string","description":"Human-readable account number","uniqueKey":"data.accounts.items.[INDEX].accountNumber","typeLabel":"string"},"type":{"type":"string","description":"Account type (evaluation, sim_funded, competition)","uniqueKey":"data.accounts.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","description":"Current account status","uniqueKey":"data.accounts.items.[INDEX].status","typeLabel":"string"},"initialBalance":{"type":"number","description":"Starting balance","uniqueKey":"data.accounts.items.[INDEX].initialBalance","typeLabel":"number"},"currentBalance":{"type":"number","description":"Current balance","uniqueKey":"data.accounts.items.[INDEX].currentBalance","typeLabel":"number"},"highWaterMark":{"type":"number","description":"Highest balance achieved","uniqueKey":"data.accounts.items.[INDEX].highWaterMark","typeLabel":"number"},"dailyStartingBalance":{"type":"number","description":"Balance at start of trading day","uniqueKey":"data.accounts.items.[INDEX].dailyStartingBalance","typeLabel":"number"},"startedAt":{"type":"string","description":"When trading started","uniqueKey":"data.accounts.items.[INDEX].startedAt","typeLabel":"string"},"completedAt":{"type":"string","description":"When completed/failed","uniqueKey":"data.accounts.items.[INDEX].completedAt","typeLabel":"string"},"violationReason":{"type":"string","description":"Reason for failure","uniqueKey":"data.accounts.items.[INDEX].violationReason","typeLabel":"string"},"metadata":{"type":"object","description":"Custom metadata","uniqueKey":"data.accounts.items.[INDEX].metadata","typeLabel":"object"},"userId":{"type":"string","description":"Hyperprop user ID","uniqueKey":"data.accounts.items.[INDEX].userId","typeLabel":"string"},"userEmail":{"type":"string","description":"Hyperprop user email","uniqueKey":"data.accounts.items.[INDEX].userEmail","typeLabel":"string"},"userAvatarUrl":{"type":"string","description":"User avatar URL","uniqueKey":"data.accounts.items.[INDEX].userAvatarUrl","typeLabel":"string"},"timeLimitExtension":{"type":"object","description":"One-time time-limit extension (rule timeLimitExtensionDays), null until granted","properties":{"extendedAt":{"type":"string","description":"When the extension was granted (ISO 8601)","uniqueKey":"data.accounts.items.[INDEX].timeLimitExtension.extendedAt","typeLabel":"string"},"extensionDays":{"type":"integer","description":"Calendar days it added to the time limit","uniqueKey":"data.accounts.items.[INDEX].timeLimitExtension.extensionDays","typeLabel":"integer"}},"uniqueKey":"data.accounts.items.[INDEX].timeLimitExtension","typeLabel":"object"},"dailyLossOff":{"type":"object","description":"Set while the rule's daily loss limit is switched off for this account (dailyLossOffThreshold reached at a daily close); null while it is enforced. A reset turns it back on.","properties":{"offSince":{"type":"string","description":"When the daily close switched the limit off (ISO 8601); not enforced from the next trading day","example":"2026-10-27T21:00:04.000Z","uniqueKey":"data.accounts.items.[INDEX].dailyLossOff.offSince","typeLabel":"string"},"targetBalance":{"type":"number","description":"End-of-day balance that switched it off: starting balance + dailyLossOffThreshold","example":25500,"uniqueKey":"data.accounts.items.[INDEX].dailyLossOff.targetBalance","typeLabel":"number"},"mode":{"type":"string","description":"while_above or permanent","example":"while_above","enum":["while_above","permanent"],"uniqueKey":"data.accounts.items.[INDEX].dailyLossOff.mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.accounts.items.[INDEX].dailyLossOff","typeLabel":"object"},"tradingPlan":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].tradingPlan.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].tradingPlan.name","typeLabel":"string"},"accountSize":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].tradingPlan.accountSize","typeLabel":"number"}},"uniqueKey":"data.accounts.items.[INDEX].tradingPlan","typeLabel":"object"},"tradingRule":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].tradingRule.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].tradingRule.name","typeLabel":"string"},"profitTarget":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].tradingRule.profitTarget","typeLabel":"number"},"maxLoss":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].tradingRule.maxLoss","typeLabel":"number"},"maxDrawdown":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].tradingRule.maxDrawdown","typeLabel":"number"},"drawdownType":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].tradingRule.drawdownType","typeLabel":"string"},"drawdownDenomination":{"type":"string","description":"Unit of maxDrawdown: \"percent\" of the reference (default) or \"dollars\", a fixed dollar amount below it","example":"dollars","enum":["percent","dollars"],"uniqueKey":"data.accounts.items.[INDEX].tradingRule.drawdownDenomination","typeLabel":"enum\u003cstring>"},"drawdownTrailCeiling":{"type":"number","description":"Trailing floor lock level, dollars above initial balance (null = trails forever)","example":null,"uniqueKey":"data.accounts.items.[INDEX].tradingRule.drawdownTrailCeiling","typeLabel":"number"}},"uniqueKey":"data.accounts.items.[INDEX].tradingRule","typeLabel":"object"},"trader":{"type":"object","properties":{"email":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].trader.email","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].trader.name","typeLabel":"string"}},"uniqueKey":"data.accounts.items.[INDEX].trader","typeLabel":"object"},"purchase":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].purchase.id","typeLabel":"string"},"purchaseDate":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].purchase.purchaseDate","typeLabel":"string"},"pricePaid":{"type":"number","uniqueKey":"data.accounts.items.[INDEX].purchase.pricePaid","typeLabel":"number"},"currency":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].purchase.currency","typeLabel":"string"},"metadata":{"type":"object","uniqueKey":"data.accounts.items.[INDEX].purchase.metadata","typeLabel":"object"}},"uniqueKey":"data.accounts.items.[INDEX].purchase","typeLabel":"object"},"createdAt":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"data.accounts.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"data.accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.accounts","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Accounts matching the filters (see totalCountedAt), or ranked search matches","uniqueKey":"data.pagination.total","typeLabel":"number"},"limit":{"type":"number","uniqueKey":"data.pagination.limit","typeLabel":"number"},"offset":{"type":"number","uniqueKey":"data.pagination.offset","typeLabel":"number"},"hasMore":{"type":"boolean","description":"Whether another page exists, determined from the current list","uniqueKey":"data.pagination.hasMore","typeLabel":"boolean"},"nextCursor":{"type":"string","description":"Cursor for the next page. Pass as ?cursor= to get the next set of results. Null if no more results.","uniqueKey":"data.pagination.nextCursor","typeLabel":"string"},"totalCapped":{"type":"boolean","description":"True when a search reached its 1,000-match limit: total is then 1,000 and more accounts may match. Always false without search.","example":false,"uniqueKey":"data.pagination.totalCapped","typeLabel":"boolean"},"totalCountedAt":{"type":"string","description":"When total was counted. Without search, a count may be reused for up to 60 seconds for the same filters, so total can briefly lag accounts created or changed since then.","example":"2026-10-12T09:14:03.000Z","x-format":{"isoDate":true},"uniqueKey":"data.pagination.totalCountedAt","typeLabel":"string"}},"uniqueKey":"data.pagination","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"organizationId":"55555555-5555-4555-8555-555555555555","organizationName":"FakePropFirm","accounts":[{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","accountNumber":"ACC-7845KXPQ","type":"evaluation","status":"in_progress","initialBalance":50000,"currentBalance":52150,"highWaterMark":53200,"dailyStartingBalance":51800,"startedAt":"2026-02-01T09:00:00.000Z","completedAt":null,"violationReason":null,"metadata":{"source":"affiliate_program"},"userId":"11111111-1111-4111-8111-111111111111","userEmail":"trader@example.com","userAvatarUrl":"https://api.dicebear.com/9.x/glass/svg?seed=trader","tradingPlan":{"id":"88888888-8888-4888-8888-888888888881","name":"50K Challenge","accountSize":50000},"tradingRule":{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","profitTarget":4000,"maxLoss":2500,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null},"trader":{"email":"john.smith@example.com","name":"John Smith"},"purchase":{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","purchaseDate":"2026-01-28T10:00:00.000Z","pricePaid":299,"currency":"USD","metadata":{"paymentId":"pay_3ABC123"}},"createdAt":"2026-01-28T10:00:00.000Z","updatedAt":"2026-02-17T14:30:00.000Z"}],"pagination":{"total":142,"limit":50,"offset":0,"hasMore":true,"totalCapped":false,"totalCountedAt":"2026-10-12T09:14:03.000Z"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ba7ea034-1fb8-4dd7-9ca3-e55c620c2952":{"description":"The request does not match the documented parameters or body; `message` names the field","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"integer","example":400,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"\"limit\" must be less than or equal to 100","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["VALIDATION_ERROR"],"example":"VALIDATION_ERROR","description":"Machine-readable error code — switch on this, not on message text","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":400,"error":"Bad Request","message":"\"limit\" must be less than or equal to 100","code":"VALIDATION_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"81658e04-b1e8-46c3-8bf0-73f664b19e98":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":401,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Unauthorized","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Invalid or expired session","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"error":"Unauthorized","message":"Invalid or expired session"}}},"exampleType":"generated"}},"exampleType":"generated"},"d773ea99-54b0-4e1c-a638-e92753adb670":{"description":"Forbidden - Your account is not associated with an organization","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":403,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Forbidden","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"This endpoint is only available for organization users","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"NOT_ORGANIZATION_USER","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"error":"Forbidden","message":"This endpoint is only available for organization users","code":"NOT_ORGANIZATION_USER"}}},"exampleType":"generated"}},"exampleType":"generated"},"f1ed9fac-4b2a-4edc-bfa0-c0d0aca6ebae":{"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"},"60041ec3-d702-4253-8314-526d085ee7c6":{"description":"Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":504,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Gateway Timeout","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"REQUEST_TIMEOUT","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":504,"error":"Gateway Timeout","message":"The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).","code":"REQUEST_TIMEOUT"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3ba990b1-0f89-4ad3-ad52-ab106e2a8108":{"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":"Get trading accounts for your organization - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:09.140Z","originalFileLocation":"platform-api/trading-accounts/get-trading-accounts-for-your-organization.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=\"Retrieve all trading accounts for your organization with powerful filtering and search. What is a trading account? A trading account represents a trader\u0026#x27;s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. Account types: | Type | Description | |------|-------------| | evaluation | Challenge account where trader must hit profit target | | sim_funded | Simulated funded account after passing evaluation | Account statuses: | Status | Description | |--------|-------------| | not_started | Account created but trader hasn\u0026#x27;t begun trading | | in_progress | Trader is actively trading | | passed | Trader hit profit target and passed the evaluation | | failed | Trader violated a rule (max loss, drawdown, etc.) | | expired | Evaluation period ended without passing | What you get for each account: - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer\u0026#x27;s email and name) - Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys) - Purchase details (what they paid) - Custom metadata (any JSON data you need) Search: The search parameter is flexible and matches: - Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K - Trader email (partial match): ?search=john@ - Trader name, username or external user ID (partial match): ?search=John - Hyperprop trader ID: ?search=%2300012340 or ?search=12340 - Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7 - User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111 Metadata is not searched; use ?metadata=key:value to filter by it. Totals and paging: hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match. Lookup by your own customer ID: ?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.) Example queries: http # Find all active evaluations GET /organization/trading-accounts?type=evaluation\u0026amp;status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed\u0026amp;startDate=2025-01-01\u0026amp;endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high\u0026amp;status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25\u0026amp;offset=25 Use cases: - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance Access: read-only and full-access API keys. Dashboard members need view access to Traders \u0026amp; accounts.\">\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=\"Get trading accounts for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all trading accounts for your organization with powerful filtering and search. What is a trading account? A trading account represents a trader\u0026#x27;s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. Account types: | Type | Description | |------|-------------| | evaluation | Challenge account where trader must hit profit target | | sim_funded | Simulated funded account after passing evaluation | Account statuses: | Status | Description | |--------|-------------| | not_started | Account created but trader hasn\u0026#x27;t begun trading | | in_progress | Trader is actively trading | | passed | Trader hit profit target and passed the evaluation | | failed | Trader violated a rule (max loss, drawdown, etc.) | | expired | Evaluation period ended without passing | What you get for each account: - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer\u0026#x27;s email and name) - Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys) - Purchase details (what they paid) - Custom metadata (any JSON data you need) Search: The search parameter is flexible and matches: - Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K - Trader email (partial match): ?search=john@ - Trader name, username or external user ID (partial match): ?search=John - Hyperprop trader ID: ?search=%2300012340 or ?search=12340 - Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7 - User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111 Metadata is not searched; use ?metadata=key:value to filter by it. Totals and paging: hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match. Lookup by your own customer ID: ?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.) Example queries: http # Find all active evaluations GET /organization/trading-accounts?type=evaluation\u0026amp;status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed\u0026amp;startDate=2025-01-01\u0026amp;endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high\u0026amp;status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25\u0026amp;offset=25 Use cases: - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance Access: read-only and full-access API keys. Dashboard members need view access to Traders \u0026amp; accounts.\">\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/get-trading-accounts-for-your-organization\">\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=Get+trading+accounts+for+your+organization\u0026amp;description=Retrieve+all+trading+accounts+for+your+organization+with+powerful+filtering+and+search.%0A%0A**What+is+a+trading+account%3F**%0AA+trading+account+represents+a+trader%27s+\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=eabe7dd87b21ce5bd1bb8a4aa87259fd125aaf3a2b9ec6245981711be4cc9c3a\">\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=\"Get trading accounts for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all trading accounts for your organization with powerful filtering and search. What is a trading account? A trading account represents a trader\u0026#x27;s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. Account types: | Type | Description | |------|-------------| | evaluation | Challenge account where trader must hit profit target | | sim_funded | Simulated funded account after passing evaluation | Account statuses: | Status | Description | |--------|-------------| | not_started | Account created but trader hasn\u0026#x27;t begun trading | | in_progress | Trader is actively trading | | passed | Trader hit profit target and passed the evaluation | | failed | Trader violated a rule (max loss, drawdown, etc.) | | expired | Evaluation period ended without passing | What you get for each account: - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer\u0026#x27;s email and name) - Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys) - Purchase details (what they paid) - Custom metadata (any JSON data you need) Search: The search parameter is flexible and matches: - Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K - Trader email (partial match): ?search=john@ - Trader name, username or external user ID (partial match): ?search=John - Hyperprop trader ID: ?search=%2300012340 or ?search=12340 - Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7 - User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111 Metadata is not searched; use ?metadata=key:value to filter by it. Totals and paging: hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match. Lookup by your own customer ID: ?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.) Example queries: http # Find all active evaluations GET /organization/trading-accounts?type=evaluation\u0026amp;status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed\u0026amp;startDate=2025-01-01\u0026amp;endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high\u0026amp;status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25\u0026amp;offset=25 Use cases: - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance Access: read-only and full-access API keys. Dashboard members need view access to Traders \u0026amp; accounts.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Trading+accounts\u0026amp;title=Get+trading+accounts+for+your+organization\u0026amp;description=Retrieve+all+trading+accounts+for+your+organization+with+powerful+filtering+and+search.%0A%0A**What+is+a+trading+account%3F**%0AA+trading+account+represents+a+trader%27s+\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=eabe7dd87b21ce5bd1bb8a4aa87259fd125aaf3a2b9ec6245981711be4cc9c3a\">\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/get-trading-accounts-for-your-organization\">\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/get-trading-accounts-for-your-organization.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/get-trading-accounts-for-your-organization#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization\",\"name\":\"Get trading accounts for your organization\",\"description\":\"Retrieve all trading accounts for your organization with powerful filtering and search. What is a trading account? A trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. Account types: | Type | Description | |------|-------------| | evaluation | Challenge account where trader must hit profit target | | sim_funded | Simulated funded account after passing evaluation | Account statuses: | Status | Description | |--------|-------------| | not_started | Account created but trader hasn't begun trading | | in_progress | Trader is actively trading | | passed | Trader hit profit target and passed the evaluation | | failed | Trader violated a rule (max loss, drawdown, etc.) | | expired | Evaluation period ended without passing | What you get for each account: - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer's email and name) - Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys) - Purchase details (what they paid) - Custom metadata (any JSON data you need) Search: The search parameter is flexible and matches: - Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K - Trader email (partial match): ?search=john@ - Trader name, username or external user ID (partial match): ?search=John - Hyperprop trader ID: ?search=%2300012340 or ?search=12340 - Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7 - User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111 Metadata is not searched; use ?metadata=key:value to filter by it. Totals and paging: hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match. Lookup by your own customer ID: ?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.) Example queries: http # Find all active evaluations GET /organization/trading-accounts?type=evaluation\u0026status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high\u0026status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25\u0026offset=25 Use cases: - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance Access: read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.\",\"dateModified\":\"2026-11-15T15:41:09.140Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization#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\":\"Get trading accounts for your organization\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization#apireference\",\"headline\":\"Get trading accounts for your organization\",\"name\":\"Get trading accounts for your organization\",\"description\":\"Retrieve all trading accounts for your organization with powerful filtering and search. What is a trading account? A trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. Account types: | Type | Description | |------|-------------| | evaluation | Challenge account where trader must hit profit target | | sim_funded | Simulated funded account after passing evaluation | Account statuses: | Status | Description | |--------|-------------| | not_started | Account created but trader hasn't begun trading | | in_progress | Trader is actively trading | | passed | Trader hit profit target and passed the evaluation | | failed | Trader violated a rule (max loss, drawdown, etc.) | | expired | Evaluation period ended without passing | What you get for each account: - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer's email and name) - Linked Hyperprop user (or the one-time importKey while still unlinked; null for read-only API keys) - Purchase details (what they paid) - Custom metadata (any JSON data you need) Search: The search parameter is flexible and matches: - Account number, customer ID, import key or your external purchase ID (partial match): ?search=ACME-100K - Trader email (partial match): ?search=john@ - Trader name, username or external user ID (partial match): ?search=John - Hyperprop trader ID: ?search=%2300012340 or ?search=12340 - Account ID (full or partial): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7 - User ID (full, or its first characters): ?search=11111111-1111-4111-8111-111111111111 Metadata is not searched; use ?metadata=key:value to filter by it. Totals and paging: hasMore and nextCursor always reflect the list as it is now. Without search, pagination.total is an exact count that may be reused for up to 60 seconds for the same filters; pagination.totalCountedAt says when it was taken. When an offset page reaches the end of the list, total is counted from that page and is current. With search, total is the number of ranked matches, at most 1,000; totalCapped: true means the limit was reached and more accounts may match. Lookup by your own customer ID: ?customerId=acme-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.) Example queries: http # Find all active evaluations GET /organization/trading-accounts?type=evaluation\u0026status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed\u0026startDate=2025-01-01\u0026endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high\u0026status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25\u0026offset=25 Use cases: - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance Access: read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-accounts/get-trading-accounts-for-your-organization#webpage\"},\"dateModified\":\"2026-11-15T15:41:09.140Z\",\"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/get-trading-accounts-for-your-organization.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","description":"Every close-all run of your organization, newest first, with its progress counters. Use `GET /organization/flatten-runs/{runId}` for the affected accounts and failures of one run.\n\nRequires **view** permission on traders.\n\n```bash\ncurl \"https://api.hyperprop.com/platform/v1/organization/flatten-runs?limit=20\" \\\n -H \"X-API-Key: hp_live_your_key_here\"\n```\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Traders \u0026 accounts.","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","description":"Create a new trading account for a trader. This is the main endpoint for provisioning accounts after a purchase.\n\n**Identify the trader by `traderId` OR `email` (exactly one).** If you have the Hyperprop user ID, pass `traderId`. If you only have the trader's email, pass `email` and it's resolved to their Hyperprop user ID server-side. Either way, the trader's email and name are auto-resolved — you don't need to pass name.\n\n**What happens:**\n1. The trader is looked up by their Hyperprop user ID (or by email, which is resolved to a user ID)\n2. A purchase record is created to track the transaction\n3. A trading account is created with `not_started` status\n4. The account is immediately visible in the trader's Hyperprop dashboard\n\n**Account types:**\n\n| Type | Description |\n|------|-------------|\n| `evaluation` | Challenge account — trader must hit profit target to pass |\n| `sim_funded` | Simulated funded account (post-evaluation) |\n| `competition` | Competition account — traders compete against each other |\n\n**Required fields:**\n| Field | Description |\n|-------|-------------|\n| `type` | Account type: `evaluation`, `sim_funded`, or `competition` |\n| `tradingPlanId` | Which plan this account is for (get IDs from GET /trading-plans) |\n| `customerId` | Your customer's ID in YOUR system — stable per customer, not per order (see soulbound identities below) |\n| `traderId` **or** `email` **or** `unassigned` | How to identify the trader — provide **exactly one** (see below) |\n\n**Identifying the trader — three modes (provide exactly one):**\n- `traderId` — the Hyperprop user ID (UUID) of a trader who **already has an account with your firm** or is bound to one of your customers. Any other ID gets `404 TRADER_NOT_FOUND`, whether or not the user exists.\n- `email` — the email of a trader who **already has an account with your firm**. It's resolved to the user ID server-side. Any other email gets `404 TRADER_NOT_FOUND`, whether or not it has a Hyperprop login: for a new customer use `unassigned: true` with `claimEmail`, and the account links to them when they sign in with that verified email.\n- `unassigned: true` (optionally with `claimEmail`) — **import-key mode.** The account is created with no trader and the response contains a one-time `importKey` (serial-key style, e.g. `HP-7K3QF-9XT2M-4WHRD`). The same key is in the `account.created` webhook (`data.importKey`) so you can recover it if you miss the response. Hand the key to your customer — order-confirmation email, member area, wherever — and they redeem it inside the Hyperprop app under **Trading Accounts → Import**. When they do, the account links to their user, an `account.imported` webhook fires with their email + the key + a timestamp for your verification, and billing + CME entitlement start at that moment (not at creation). For many accounts at once use `POST /trading-accounts/bulk`.\n\n**Automatic linking by email (`claimEmail`, optional with `unassigned: true`):**\nPass your customer's email as `claimEmail` and they don't need the import key at all. The account links automatically to the Hyperprop user whose **verified** login email equals `claimEmail`:\n- **When it links:** when the signed-in user is loaded (`GET /platform/v1/auth/me`). The Hyperprop app does this every time it opens and right after the user signs in, so a customer using the app needs to do nothing. The sign-in API call on its own (`POST /platform/v1/auth/signin`) does not link anything.\n- **API-driven flows and tests:** after signing the user in, call `GET /platform/v1/auth/me` or `POST /platform/v1/user/trading-accounts/claim-pending` with their access token. `claim-pending` returns the accounts it `claimed`, the ones it `refused`, and a `skipped` reason when it did nothing (`email_not_verified`, `no_email`, `organization_login`).\n- Matching is exact and case-insensitive (`claimEmail` is stored lowercased and trimmed). There is no partial or pattern matching.\n- The user's email address must be **verified**. A user who signed up but has not confirmed their email claims nothing until they confirm. Linking happens the next time the signed-in user is loaded after confirming.\n- Only unclaimed accounts are linked, and each account is claimed at most once. If the import key was redeemed first, the claim email has no effect.\n- Soulbound identities still apply: if your `customerId` is already bound to a different Hyperprop login, the account is not linked by email and you receive `account.claim_refused` (code `TRADER_ALREADY_BOUND`, with the `bindingId` and the Hyperprop user that tried), once per account and user.\n- Linking by email is the same event as redeeming the key: the `account.imported` webhook fires (with `trigger: \"claim_email\"` and `import.claimedVia: \"claim_email\"`), and billing and market-data entitlement start at that moment.\n- **Customers who already had a Hyperprop login:** if the login existed before you entered the claim email, the account is not linked until the customer confirms it in the app. Until then `claimStatus` is `waiting`, the same as for a customer who has not signed up yet. If they decline, nothing is linked, `claimStatus` becomes `declined` and you receive `account.claim_refused` with code `TRADER_DECLINED` (without a user id). Changing the claim email offers the account again; the import key keeps working.\n- The `importKey` stays valid as a fallback, for example if the customer signs up with a different email.\n- Account responses show `claimEmail`, `claimedVia` (`direct`, `import_key`, `claim_email`, or `null` while unclaimed) and `claimStatus` (`waiting`, `declined` or `null`). Unlinking an account clears its `claimEmail`, so it is not claimed straight back.\n\nAccounts created without `claimEmail` behave exactly as before.\n\n**Prefilling the customer's profile (`traderProfile`, optional with `claimEmail`):**\nBefore live market data, every trader completes an identity and address form in the Hyperprop app. If you already hold these details, send them as `traderProfile` (`firstName`, `lastName`, `dateOfBirth`, `nationality`, `country`, `address1`, `address2`, `city`, `region`, `postalCode`; any subset, at least one):\n- Values are used only when the account is linked through `claimEmail` (the customer's verified email). They are not used when the import key is redeemed, because a key can be passed to someone else.\n- **First time only, all or nothing.** The values are applied only if the customer's profile has no identity or address field set at all and no firm has ever prefilled it. If the customer (or an earlier prefill from any firm) has set anything, nothing is applied. A prefill never changes data the customer or another firm entered.\n- If you send every required field (all except `address2`), the customer does not need to fill in the identity form. Otherwise it opens with your values and they complete the rest. The CME market data agreement is never prefilled; the customer always accepts it themselves.\n- `dateOfBirth` is `YYYY-MM-DD` and the customer must be at least 18. `nationality` and `country` are ISO 3166-1 alpha-2 codes (e.g. `US`). Names allow letters and accents of any script plus spaces, apostrophes, hyphens and periods (e.g. `José`, `Smith Jr.`), up to 50 characters, stored in Unicode NFC form.\n- `traderProfile` is never returned in responses or webhooks, and is discarded once the account is linked.\n\n**Soulbound identities (keyed on `customerId` — always active):**\nEvery account carries your `customerId`, and each customer is pinned to exactly ONE Hyperprop login (a *binding*):\n- **Unassigned accounts:** the FIRST import-key redemption for a `customerId` creates the binding. Every later import for the same customer must be redeemed by that same login — a different login is refused with `409 TRADER_ALREADY_BOUND` and shown a masked hint of the correct email.\n- **Directly-linked accounts (`traderId`/`email`):** creating the account creates the binding. If the `customerId` is ALREADY bound to a different Hyperprop login, the create is refused with `409 CUSTOMER_ALREADY_BOUND` — link the account to the bound login instead, or rebind the customer first.\n\nResult: one customer, one Hyperprop identity, all their accounts in one place — no clashes. You learn the bound login from the `account.imported` webhook (`import.importedEmail`); `import.loginAlreadyBoundToOtherCustomer` tells you when that login already belonged to another of your customers. Inspect bindings via `GET /trader-bindings`; a customer who lost their Hyperprop login is moved to a new one via `POST /trader-bindings/{bindingId}/rebind` (which also fails all still-active accounts on the old login — a binding is never left dangling).\n\nFor `traderId`/`email`, display name and avatar are resolved automatically from the trader's Hyperprop profile.\n\nThe response's `importKey` field is `null` for directly-linked accounts and holds the redemption key for unlinked ones. An unlinked account can be reissued a fresh key with `POST /trading-accounts/{accountId}/unlink` — but only before trading starts.\n\n**Where to get the `traderId`:**\n- From GET /organization/traders → the `userId` field (for traders who already have accounts with you)\n- From the `account.imported` webhook, once a new customer redeemed an import key or claimed an account\n- Or skip it entirely and just pass the trader's `email`.\n\n**Optional fields:**\n| Field | Description |\n|-------|-------------|\n| `markets` | Markets this account trades. Omit it to use the plan's `markets`, or the complete CME Group bundle (`CME`, `CBOT`, `NYMEX`, `COMEX`) when the plan sets none. Any CME Group exchange grants the whole bundle; `BINANCE` adds crypto perpetuals, `HYPERLIQUID` index and commodity perpetuals and `HDL` Hyperprop Deep Liquidity crypto perpetuals. |\n| `tradingRuleId` | Override the plan's default rules |\n| `accountNumber` | Your own account number (e.g., `ACME-100K-7845`): up to 64 letters, digits, `.`, `_` and `-`, starting with a letter or digit. The prefixes `SIM-BOT`, `PRACTICE-` and `DEMO-` are reserved (`400 VALIDATION_ERROR`). If omitted, auto-generated as `ACC-XXXXXXXX` |\n| `initialBalance` | Override the plan's default balance; `0` is kept (an account that starts at 0) |\n| `traderExternalId` | **Queryable external reference for the trader.** Filter later with `GET /traders?externalUserId=...`; returned as `trader.externalUserId` |\n| `metadata` | Add notes, tags, or any custom data |\n| `purchase` | Payment details (price paid, currency, payment IDs) |\n\n**customerId vs metadata:**\n`metadata` is stored verbatim but only filterable by exact key:value. `customerId` (account) and `traderExternalId` (trader) are first-class fields you can filter by directly — use them to reconcile webhooks and imports against your own IDs without email round-trips or metadata scanning. Both also appear in every webhook payload (`data.customerId`, `data.trader.externalUserId`). Webhook payloads also carry `data.externalRef` (same value) for integrations built before the rename — treat it as deprecated.\n\n**Markets \u0026 billing:**\nCME Group depth-of-book market data is one inseparable bundle. Every account\nreceives access to CME, CBOT, NYMEX, and COMEX. Partners cannot select or pay\nfor individual exchanges.\n\nBilling is:\n\n`platform_price_per_user + market_data_price_cme`\n\nThe `market_data_price_cme` organization setting is the price of the **full\nCME Group bundle**, despite the legacy column name. CBOT, NYMEX, and COMEX are\nnot added as separate line items. The cycle price snapshot uses:\n\n```json\n{ \"platform\": 0.25, \"CME_GROUP\": 6.75 }\n```\n\nThe legacy `markets` request field remains accepted to avoid breaking older\nintegrations, but any partial input such as `[\"CME\"]` is normalized to\n`[\"CME\", \"CBOT\", \"NYMEX\", \"COMEX\"]` in the stored account and response.\n\n**Minimal example (4 fields, all markets):**\n```json\n{\n \"type\": \"evaluation\",\n \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"customerId\": \"your-customer-4471\"\n}\n```\n\n**Legacy input normalization example:**\n```json\n{\n \"type\": \"evaluation\",\n \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"traderId\": \"11111111-1111-4111-8111-111111111111\",\n \"markets\": [\"CME\"]\n}\n```\n\nThe account still receives the full four-exchange bundle. New integrations\nshould omit `markets` and set them on the plan instead.\n\n**Example identifying the trader by email (instead of traderId):**\n```json\n{\n \"type\": \"evaluation\",\n \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"john@example.com\",\n \"customerId\": \"cust_abc123\"\n}\n```\n\n**Full example with purchase:**\n```json\n{\n \"type\": \"evaluation\",\n \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"john@example.com\",\n \"customerId\": \"cust_abc123\",\n \"accountNumber\": \"ACME-100K-7845\",\n \"metadata\": {\n \"notes\": \"Referred by Mike - 10% discount\",\n \"tags\": [\"referral\", \"discount\"]\n },\n \"purchase\": {\n \"pricePaid\": 449,\n \"currency\": \"USD\",\n \"metadata\": {\n \"paymentId\": \"pay_3ABC123\",\n \"discountCode\": \"MIKE10\"\n }\n }\n}\n```\n\n**Permissions:**\nOnly organization **admins** can create accounts.\n\n**Error responses:**\nEvery error returns the same shape — `{ statusCode, error, message, code }` — so you can switch on `code`:\n\n| Status | `code` | When |\n|:---:|------|------|\n| 400 | `VALIDATION_ERROR` | Payload failed validation — including a missing `customerId`, sending more than one (or none) of `traderId` / `email` / `unassigned`, a malformed email, `claimEmail` without `unassigned: true`, `traderProfile` without `claimEmail`, or an invalid `traderProfile` field (for example an unknown country code, or a `dateOfBirth` under 18) |\n| 400 | `PLAN_NOT_ACTIVE` | The trading plan exists but is not active |\n| 400 | `NO_TRADING_RULE` | No `tradingRuleId` was given and the plan has no default rule |\n| 401 | `UNAUTHORIZED` | Missing/invalid API key or session |\n| 403 | `INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN` | The API key (or user) lacks admin/write permission |\n| 404 | `TRADER_NOT_FOUND` | The `traderId` doesn't match a Hyperprop user, or the `email` isn't one of your firm's traders (use `unassigned: true` with `claimEmail`) |\n| 404 | `PLAN_NOT_FOUND` | `tradingPlanId` not found for your organization |\n| 404 | `RULE_NOT_FOUND` | `tradingRuleId` not found for your organization |\n| 409 | `CUSTOMER_ALREADY_BOUND` | The `customerId` is already soulbound to a DIFFERENT Hyperprop login than the `traderId`/`email` you sent. Link the account to the bound login, or rebind the customer first (`POST /trader-bindings/{bindingId}/rebind`) |\n| 500 | `PURCHASE_CREATE_ERROR` / `ACCOUNT_CREATE_ERROR` / `TRADER_PROFILE_STORE_ERROR` | Unexpected server error while provisioning; no account was created, so retry |\n\nNote: `traderId`, `email`, and `unassigned` are mutually exclusive — send exactly one. Sending several, or none, is a `400 VALIDATION_ERROR`. `customerId` is always required (`externalRef` is accepted as a deprecated alias).\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","href":"/platform-api/trading-accounts/create-a-trading-account"},{"title":"Get bulk operation details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/bulk-operations/{batchId}","href":"/platform-api/trading-accounts/get-bulk-operation-details"},{"title":"Get a close-all run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs/{runId}","href":"/platform-api/trading-accounts/get-a-close-all-run"},{"title":"Get active traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/active-traders","href":"/platform-api/trading-accounts/get-active-traders"},{"title":"Get daily account and trader activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/activity","href":"/platform-api/trading-accounts/get-daily-account-and-trader-activity"},{"title":"Bulk-create unlinked accounts with import keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk","href":"/platform-api/trading-accounts/bulk-create-unlinked-accounts-with-import-keys"},{"title":"Bulk update trading accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts"},{"title":"Close all positions across accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/flatten","href":"/platform-api/trading-accounts/close-all-positions-across-accounts"},{"title":"Get open positions and equity for many accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions","href":"/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts"},{"title":"Get a specific trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/get-a-specific-trading-account"},{"title":"Update a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/update-a-trading-account"},{"title":"Get an account's event log and session history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/activity","href":"/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history"},{"title":"List an account's balance adjustments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/list-an-accounts-balance-adjustments"},{"title":"Credit or debit a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/credit-or-debit-a-trading-account"},{"title":"Get account change history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/changes","href":"/platform-api/trading-accounts/get-account-change-history"},{"title":"Get an account's daily P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/daily-pnl","href":"/platform-api/trading-accounts/get-an-accounts-daily-p\u0026l"},{"title":"Turn an account off (pause)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/deactivate","href":"/platform-api/trading-accounts/turn-an-account-off-pause"},{"title":"Get an account's equity and unrealized P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/equity","href":"/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p\u0026l"},{"title":"Close all positions on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/flatten","href":"/platform-api/trading-accounts/close-all-positions-on-an-account"},{"title":"Get an account's order event timeline","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/order-events","href":"/platform-api/trading-accounts/get-an-accounts-order-event-timeline"},{"title":"Get an account's order history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/orders","href":"/platform-api/trading-accounts/get-an-accounts-order-history"},{"title":"Get an account's open positions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/positions","href":"/platform-api/trading-accounts/get-an-accounts-open-positions"},{"title":"Turn an account back on","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/reactivate","href":"/platform-api/trading-accounts/turn-an-account-back-on"},{"title":"Unlink a trader (issues a fresh import key)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/unlink","href":"/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key"},{"title":"Get a balance adjustment by reference","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference}","href":"/platform-api/trading-accounts/get-a-balance-adjustment-by-reference"},{"title":"Cancel working orders on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/orders/cancel","href":"/platform-api/trading-accounts/cancel-working-orders-on-an-account"},{"title":"Close one position on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/positions/{contract}/close","href":"/platform-api/trading-accounts/close-one-position-on-an-account"}]},{"group":"Traders","pages":[{"title":"List trader identity bindings (customer ⇄ Hyperprop login)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trader-bindings","href":"/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login"},{"title":"Get traders for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders","href":"/platform-api/traders/get-traders-for-your-organization"},{"title":"Get a specific trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders/{traderId}","href":"/platform-api/traders/get-a-specific-trader"},{"title":"Update a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/traders/{traderId}","href":"/platform-api/traders/update-a-trader"},{"title":"Rebind a customer to a new Hyperprop login (support flow)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trader-bindings/{bindingId}/rebind","href":"/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow"}]},{"group":"Trading plans","pages":[{"title":"Get trading plans for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans","href":"/platform-api/trading-plans/get-trading-plans-for-your-organization"},{"title":"Create a new trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-plans","href":"/platform-api/trading-plans/create-a-new-trading-plan"},{"title":"Get a specific trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/get-a-specific-trading-plan"},{"title":"Delete a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/delete-a-trading-plan"},{"title":"Update a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/update-a-trading-plan"}]},{"group":"Trading rules","pages":[{"title":"Get trading rules for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization"},{"title":"Create a new trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule"},{"title":"Get a specific trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/get-a-specific-trading-rule"},{"title":"Delete a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/delete-a-trading-rule"},{"title":"Update a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/update-a-trading-rule"}]},{"group":"Instruments","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/instruments","href":"/platform-api/instruments/list-instruments"}]},{"group":"Lockouts","pages":[{"title":"List all active lockouts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts","href":"/platform-api/lockouts/list-all-active-lockouts"},{"title":"Create admin lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/lockouts","href":"/platform-api/lockouts/create-admin-lockout"},{"title":"Get daily lockout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/activity","href":"/platform-api/lockouts/get-daily-lockout-activity"},{"title":"Get lockout status for account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/get-lockout-status-for-account"},{"title":"Remove lockout from account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/remove-lockout-from-account"},{"title":"Update active lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/update-active-lockout"}]},{"group":"Payouts","pages":[{"title":"Payout queue — bulk payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payout-eligibility","href":"/platform-api/payouts/payout-queue-—-bulk-payout-eligibility"},{"title":"Get daily payout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payouts/activity","href":"/platform-api/payouts/get-daily-payout-activity"},{"title":"Check payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payout-eligibility","href":"/platform-api/payouts/check-payout-eligibility"},{"title":"List payouts for an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/list-payouts-for-an-account"},{"title":"Execute a payout (balance withdrawal)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/execute-a-payout-balance-withdrawal"},{"title":"Reverse a payout (restore the withdrawn balance)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts/{payoutId}/reverse","href":"/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance"}]},{"group":"Purchases","pages":[{"title":"Get purchases for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases","href":"/platform-api/purchases/get-purchases-for-your-organization"},{"title":"Get a specific purchase","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases/{purchaseId}","href":"/platform-api/purchases/get-a-specific-purchase"}]},{"group":"Time Machine","pages":[{"title":"List revert batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches","href":"/platform-api/time-machine/list-revert-batches"},{"title":"Get revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/time-machine-settings","href":"/platform-api/time-machine/get-revert-settings"},{"title":"Update revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/time-machine-settings","href":"/platform-api/time-machine/update-revert-settings"},{"title":"Bulk revert accounts to a trading day or an instant","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":"Get trading accounts for your organization - 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"]}