Retrieve all trading plans configured for your organization.
What is a trading plan?
A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your “evaluation challenge” or “funded account” offering.
What you get for each plan:
Plan details (name, description, price, currency)
Account size and evaluation duration
Default trading rules (profit target, max loss, drawdown limits)
Active/inactive status
Custom metadata (any JSON data you need)
Example plans:
“50K Challenge” - 299,30days,50,000 account
“100K Challenge” - 499,30days,100,000 account
“200K Pro” - 999,45days,200,000 account
Filtering by metadata:
Filter plans by any key:value in your metadata:
# Find plans for beginnersGET /organization/trading-plans?metadata=targetAudience:beginner# Find promotional plansGET /organization/trading-plans?metadata=promo:true# Find plans by internal codeGET /organization/trading-plans?metadata=internalCode:PLAN-100K
Supports strings, numbers, and booleans. Uses fast GIN index.
Filtering archived plans:
By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans:
GET /organization/trading-plans?isActive=true
Use cases:
Display available plans on your website
Validate plan IDs before creating accounts
Check which rules are attached to each plan
Audit your product offerings
Access: read-only and full-access API keys. Dashboard members need view access to Plans & rules.
GET
/
v1
/
organization
/
trading-plans
Get trading plans for your organization
curl --request GET \ --url https://api.hyperprop.com/platform/v1/organization/trading-plans \ --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
metadata
string
Filter by metadata key:value (e.g., "priority:high", "active:true")
isActive
boolean
Filter by active status. Use isActive=true to exclude archived plans, isActive=false for archived only. Omit to get all plans.
limit
integer
default:50
Results per page (default: 50, max: 100)
Required range: 1 <= x <= 100
offset
integer
default:0
Pagination offset
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.
{
"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-plans/get-trading-plans-for-your-organization","slug":"/platform-api/trading-plans/get-trading-plans-for-your-organization","pageMetadata":{"title":"Get trading plans for your organization","description":"Retrieve all trading plans configured for your organization.\n\n**What is a trading plan?**\nA trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \"evaluation challenge\" or \"funded account\" offering.\n\n**What you get for each plan:**\n- Plan details (name, description, price, currency)\n- Account size and evaluation duration\n- Default trading rules (profit target, max loss, drawdown limits)\n- Active/inactive status\n- Custom metadata (any JSON data you need)\n\n**Example plans:**\n- \"50K Challenge\" - $299, 30 days, $50,000 account\n- \"100K Challenge\" - $499, 30 days, $100,000 account\n- \"200K Pro\" - $999, 45 days, $200,000 account\n\n**Filtering by metadata:**\nFilter plans by any key:value in your metadata:\n```http\n# Find plans for beginners\nGET /organization/trading-plans?metadata=targetAudience:beginner\n\n# Find promotional plans\nGET /organization/trading-plans?metadata=promo:true\n\n# Find plans by internal code\nGET /organization/trading-plans?metadata=internalCode:PLAN-100K\n```\nSupports strings, numbers, and booleans. Uses fast GIN index.\n\n**Filtering archived plans:**\nBy default all plans are returned, including archived ones (`isActive: false`). For plan pickers and storefronts, request only live plans:\n```http\nGET /organization/trading-plans?isActive=true\n```\n\n**Use cases:**\n- Display available plans on your website\n- Validate plan IDs before creating accounts\n- Check which rules are attached to each plan\n- Audit your product offerings\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","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","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 annotation: \"annotation\",\n code: \"code\",\n li: \"li\",\n math: \"math\",\n mi: \"mi\",\n mn: \"mn\",\n mo: \"mo\",\n mrow: \"mrow\",\n p: \"p\",\n pre: \"pre\",\n semantics: \"semantics\",\n span: \"span\",\n strong: \"strong\",\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 plans configured for your organization.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"What is a trading plan?\"\n }), \"\\nA trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your “evaluation challenge” or “funded account” offering.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"What you get for each plan:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Plan details (name, description, price, currency)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Account size and evaluation duration\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Default trading rules (profit target, max loss, drawdown limits)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Active/inactive status\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Custom metadata (any JSON data you need)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example plans:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"“50K Challenge” - \", _jsxs(_components.span, {\n className: \"katex\",\n children: [_jsx(_components.span, {\n className: \"katex-mathml\",\n children: _jsx(_components.math, {\n xmlns: \"http://www.w3.org/1998/Math/MathML\",\n children: _jsxs(_components.semantics, {\n children: [_jsxs(_components.mrow, {\n children: [_jsx(_components.mn, {\n children: \"299\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n }), _jsx(_components.mn, {\n children: \"30\"\n }), _jsx(_components.mi, {\n children: \"d\"\n }), _jsx(_components.mi, {\n children: \"a\"\n }), _jsx(_components.mi, {\n children: \"y\"\n }), _jsx(_components.mi, {\n children: \"s\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n })]\n }), _jsx(_components.annotation, {\n encoding: \"application/x-tex\",\n children: \"299, 30 days, \"\n })]\n })\n })\n }), _jsx(_components.span, {\n className: \"katex-html\",\n \"aria-hidden\": \"true\",\n children: _jsxs(_components.span, {\n className: \"base\",\n children: [_jsx(_components.span, {\n className: \"strut\",\n style: {\n height: \"0.8889em\",\n verticalAlign: \"-0.1944em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"299\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n }), _jsx(_components.span, {\n className: \"mspace\",\n style: {\n marginRight: \"0.1667em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"30\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"d\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"a\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n style: {\n marginRight: \"0.0359em\"\n },\n children: \"y\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"s\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n })]\n })\n })]\n }), \"50,000 account\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"“100K Challenge” - \", _jsxs(_components.span, {\n className: \"katex\",\n children: [_jsx(_components.span, {\n className: \"katex-mathml\",\n children: _jsx(_components.math, {\n xmlns: \"http://www.w3.org/1998/Math/MathML\",\n children: _jsxs(_components.semantics, {\n children: [_jsxs(_components.mrow, {\n children: [_jsx(_components.mn, {\n children: \"499\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n }), _jsx(_components.mn, {\n children: \"30\"\n }), _jsx(_components.mi, {\n children: \"d\"\n }), _jsx(_components.mi, {\n children: \"a\"\n }), _jsx(_components.mi, {\n children: \"y\"\n }), _jsx(_components.mi, {\n children: \"s\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n })]\n }), _jsx(_components.annotation, {\n encoding: \"application/x-tex\",\n children: \"499, 30 days, \"\n })]\n })\n })\n }), _jsx(_components.span, {\n className: \"katex-html\",\n \"aria-hidden\": \"true\",\n children: _jsxs(_components.span, {\n className: \"base\",\n children: [_jsx(_components.span, {\n className: \"strut\",\n style: {\n height: \"0.8889em\",\n verticalAlign: \"-0.1944em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"499\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n }), _jsx(_components.span, {\n className: \"mspace\",\n style: {\n marginRight: \"0.1667em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"30\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"d\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"a\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n style: {\n marginRight: \"0.0359em\"\n },\n children: \"y\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"s\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n })]\n })\n })]\n }), \"100,000 account\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"“200K Pro” - \", _jsxs(_components.span, {\n className: \"katex\",\n children: [_jsx(_components.span, {\n className: \"katex-mathml\",\n children: _jsx(_components.math, {\n xmlns: \"http://www.w3.org/1998/Math/MathML\",\n children: _jsxs(_components.semantics, {\n children: [_jsxs(_components.mrow, {\n children: [_jsx(_components.mn, {\n children: \"999\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n }), _jsx(_components.mn, {\n children: \"45\"\n }), _jsx(_components.mi, {\n children: \"d\"\n }), _jsx(_components.mi, {\n children: \"a\"\n }), _jsx(_components.mi, {\n children: \"y\"\n }), _jsx(_components.mi, {\n children: \"s\"\n }), _jsx(_components.mo, {\n separator: \"true\",\n children: \",\"\n })]\n }), _jsx(_components.annotation, {\n encoding: \"application/x-tex\",\n children: \"999, 45 days, \"\n })]\n })\n })\n }), _jsx(_components.span, {\n className: \"katex-html\",\n \"aria-hidden\": \"true\",\n children: _jsxs(_components.span, {\n className: \"base\",\n children: [_jsx(_components.span, {\n className: \"strut\",\n style: {\n height: \"0.8889em\",\n verticalAlign: \"-0.1944em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"999\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n }), _jsx(_components.span, {\n className: \"mspace\",\n style: {\n marginRight: \"0.1667em\"\n }\n }), _jsx(_components.span, {\n className: \"mord\",\n children: \"45\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"d\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"a\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n style: {\n marginRight: \"0.0359em\"\n },\n children: \"y\"\n }), _jsx(_components.span, {\n className: \"mord mathnormal\",\n children: \"s\"\n }), _jsx(_components.span, {\n className: \"mpunct\",\n children: \",\"\n })]\n })\n })]\n }), \"200,000 account\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Filtering by metadata:\"\n }), \"\\nFilter plans by any key:value in your metadata:\"]\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"8\",\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: \"8\",\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 plans for beginners\"\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-plans?metadata=targetAudience:beginner\"\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 promotional plans\"\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-plans?metadata=promo:true\"\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 plans by internal code\"\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-plans?metadata=internalCode:PLAN-100K\"\n })]\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"Supports strings, numbers, and booleans. Uses fast GIN index.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Filtering archived plans:\"\n }), \"\\nBy default all plans are returned, including archived ones (\", _jsx(_components.code, {\n children: \"isActive: false\"\n }), \"). For plan pickers and storefronts, request only live plans:\"]\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"1\",\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: \"1\",\n children: [_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-plans?isActive=true\"\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: \"Display available plans on your website\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validate plan IDs before creating accounts\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Check which rules are attached to each plan\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Audit your product offerings\"\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 Plans \u0026 rules.\"]\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 plans for your organization","description":"Retrieve all trading plans configured for your organization.\n\n**What is a trading plan?**\nA trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \"evaluation challenge\" or \"funded account\" offering.\n\n**What you get for each plan:**\n- Plan details (name, description, price, currency)\n- Account size and evaluation duration\n- Default trading rules (profit target, max loss, drawdown limits)\n- Active/inactive status\n- Custom metadata (any JSON data you need)\n\n**Example plans:**\n- \"50K Challenge\" - $299, 30 days, $50,000 account\n- \"100K Challenge\" - $499, 30 days, $100,000 account\n- \"200K Pro\" - $999, 45 days, $200,000 account\n\n**Filtering by metadata:**\nFilter plans by any key:value in your metadata:\n```http\n# Find plans for beginners\nGET /organization/trading-plans?metadata=targetAudience:beginner\n\n# Find promotional plans\nGET /organization/trading-plans?metadata=promo:true\n\n# Find plans by internal code\nGET /organization/trading-plans?metadata=internalCode:PLAN-100K\n```\nSupports strings, numbers, and booleans. Uses fast GIN index.\n\n**Filtering archived plans:**\nBy default all plans are returned, including archived ones (`isActive: false`). For plan pickers and storefronts, request only live plans:\n```http\nGET /organization/trading-plans?isActive=true\n```\n\n**Use cases:**\n- Display available plans on your website\n- Validate plan IDs before creating accounts\n- Check which rules are attached to each plan\n- Audit your product offerings\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get trading plans for your organization","operationId":"getV1OrganizationTradingplans","description":"Retrieve all trading plans configured for your organization.\n\n**What is a trading plan?**\nA trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \"evaluation challenge\" or \"funded account\" offering.\n\n**What you get for each plan:**\n- Plan details (name, description, price, currency)\n- Account size and evaluation duration\n- Default trading rules (profit target, max loss, drawdown limits)\n- Active/inactive status\n- Custom metadata (any JSON data you need)\n\n**Example plans:**\n- \"50K Challenge\" - $299, 30 days, $50,000 account\n- \"100K Challenge\" - $499, 30 days, $100,000 account\n- \"200K Pro\" - $999, 45 days, $200,000 account\n\n**Filtering by metadata:**\nFilter plans by any key:value in your metadata:\n```http\n# Find plans for beginners\nGET /organization/trading-plans?metadata=targetAudience:beginner\n\n# Find promotional plans\nGET /organization/trading-plans?metadata=promo:true\n\n# Find plans by internal code\nGET /organization/trading-plans?metadata=internalCode:PLAN-100K\n```\nSupports strings, numbers, and booleans. Uses fast GIN index.\n\n**Filtering archived plans:**\nBy default all plans are returned, including archived ones (`isActive: false`). For plan pickers and storefronts, request only live plans:\n```http\nGET /organization/trading-plans?isActive=true\n```\n\n**Use cases:**\n- Display available plans on your website\n- Validate plan IDs before creating accounts\n- Check which rules are attached to each plan\n- Audit your product offerings\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","parameters":["457b8646-66b9-4563-b913-169ac5fe4d53","0576ab7d-5a2a-46f1-8838-6370befdb486","5ccd76e0-5d6c-466f-b74f-908bc9952817","44c69ce2-7396-4add-81ee-77ca77bbabba","f9076105-a1e5-4749-914a-275677ee3632"],"tags":["Trading plans"],"security":["202f6242-ffed-469e-8dd1-1a2a454b7aa2"],"responses":{"200":"10fdcaa9-85dd-4398-956d-72168f9eaf4a","400":"938a275f-810e-4c1e-81df-f9abb7df2bf7","401":"9ba54a81-04e1-484e-abd7-d4695ba06ea8","403":"9f6eff07-bdc8-4687-82fa-5578089d2ed8","500":"34c4d0f5-42ee-4009-a75a-877c52093c13","504":"d6f8246c-c121-4a33-981d-e31a35aa9dd2"},"method":"get","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/trading-plans","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Get trading plans for your organization","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"457b8646-66b9-4563-b913-169ac5fe4d53":{"description":"Filter by metadata key:value (e.g., \"priority:high\", \"active:true\")","name":"metadata","in":"query","required":false,"example":"targetAudience:beginner","schema":{"type":"string","isRequired":false,"description":"Filter by metadata key:value (e.g., \"priority:high\", \"active:true\")","uniqueKey":"","typeLabel":"string"}},"0576ab7d-5a2a-46f1-8838-6370befdb486":{"description":"Filter by active status. Use isActive=true to exclude archived plans, isActive=false for archived only. Omit to get all plans.","name":"isActive","in":"query","required":false,"example":true,"schema":{"type":"boolean","isRequired":false,"description":"Filter by active status. Use isActive=true to exclude archived plans, isActive=false for archived only. Omit to get all plans.","uniqueKey":"","typeLabel":"boolean"}},"5ccd76e0-5d6c-466f-b74f-908bc9952817":{"description":"Results per page (default: 50, max: 100)","name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"description":"Results per page (default: 50, max: 100)","uniqueKey":"","typeLabel":"integer"}},"44c69ce2-7396-4add-81ee-77ca77bbabba":{"description":"Pagination offset","name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0,"description":"Pagination offset","uniqueKey":"","typeLabel":"integer"}},"f9076105-a1e5-4749-914a-275677ee3632":{"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":{"10fdcaa9-85dd-4398-956d-72168f9eaf4a":{"description":"Success - Returns all trading plans","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","plans":[{"id":"88888888-8888-4888-8888-888888888881","name":"50K Challenge","displayName":"50K Evaluation","description":"Our most popular evaluation. Standard risk rules with a solid balance of target and protection.","price":299,"currency":"USD","durationDays":30,"accountSize":50000,"isActive":true,"metadata":{"targetAudience":"beginner","internalCode":"PLAN-50K-V2"},"tradingRule":{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","profitTarget":4000,"dailyLoss":1000,"maxLoss":2500,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null},"createdAt":"2025-12-30T12:28:04.204Z","updatedAt":"2025-12-30T12:28:04.204Z"},{"id":"88888888-8888-4888-8888-888888888883","name":"100K Pro","displayName":null,"description":"For experienced traders ready for a bigger challenge.","price":499,"currency":"USD","durationDays":45,"accountSize":100000,"isActive":true,"metadata":{"targetAudience":"experienced","internalCode":"PLAN-100K-V1"},"tradingRule":{"id":"99999999-9999-4999-8999-999999999992","name":"Aggressive Rules","profitTarget":10000,"dailyLoss":3000,"maxLoss":6000,"maxDrawdown":6,"drawdownType":"trailing","drawdownDenomination":"percent","drawdownTrailCeiling":null},"createdAt":"2026-02-18T21:19:57.328Z","updatedAt":"2026-02-18T21:19:57.328Z"}],"pagination":{"total":5,"limit":50,"offset":0,"hasMore":false}},"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"},"plans":{"type":"array","description":"Array of trading plans","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique plan ID (use this when creating accounts)","uniqueKey":"data.plans.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Plan name (internal). Shown to traders when displayName is not set.","uniqueKey":"data.plans.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","description":"Customer-facing plan name shown to traders in the trading app, up to 120 characters. When null, traders see the plan name.","uniqueKey":"data.plans.items.[INDEX].displayName","typeLabel":"string"},"description":{"type":"string","description":"Plan description for marketing","uniqueKey":"data.plans.items.[INDEX].description","typeLabel":"string"},"price":{"type":"number","description":"Plan price","uniqueKey":"data.plans.items.[INDEX].price","typeLabel":"number"},"currency":{"type":"string","description":"Price currency","uniqueKey":"data.plans.items.[INDEX].currency","typeLabel":"string"},"durationDays":{"type":"number","description":"Evaluation period in days (null = unlimited)","uniqueKey":"data.plans.items.[INDEX].durationDays","typeLabel":"number"},"accountSize":{"type":"number","description":"Starting account balance","uniqueKey":"data.plans.items.[INDEX].accountSize","typeLabel":"number"},"isActive":{"type":"boolean","description":"Whether this plan can be purchased","uniqueKey":"data.plans.items.[INDEX].isActive","typeLabel":"boolean"},"metadata":{"type":"object","description":"Custom metadata","uniqueKey":"data.plans.items.[INDEX].metadata","typeLabel":"object"},"markets":{"type":"array","description":"Markets accounts on this plan trade. Any CME Group exchange grants the full CME, CBOT, NYMEX and COMEX bundle; BINANCE adds crypto perpetuals, HYPERLIQUID adds index and commodity perpetuals and HDL adds Hyperprop Deep Liquidity crypto perpetuals (one book consolidated from several exchanges). Accounts created without their own markets use these; a plan that sets none uses the CME Group bundle. Every organization is enabled for the CME Group bundle. Perpetuals (BINANCE, HYPERLIQUID, HDL) must each be enabled for your organization by Hyperprop; until then, a request that includes one is refused with 403 MARKET_NOT_ALLOWED.","example":["BINANCE"],"items":{"type":"string","uniqueKey":"data.plans.items.[INDEX].markets.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.plans.items.[INDEX].markets","typeLabel":"string[]"},"tradingRule":{"type":"object","description":"Default trading rules for this plan","properties":{"id":{"type":"string","uniqueKey":"data.plans.items.[INDEX].tradingRule.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.plans.items.[INDEX].tradingRule.name","typeLabel":"string"},"profitTarget":{"type":"number","description":"Profit needed to pass ($)","uniqueKey":"data.plans.items.[INDEX].tradingRule.profitTarget","typeLabel":"number"},"dailyLoss":{"type":"number","description":"Max daily loss limit ($)","uniqueKey":"data.plans.items.[INDEX].tradingRule.dailyLoss","typeLabel":"number"},"maxLoss":{"type":"number","description":"Max total loss limit ($)","uniqueKey":"data.plans.items.[INDEX].tradingRule.maxLoss","typeLabel":"number"},"maxDrawdown":{"type":"number","description":"Max drawdown. A percent of the reference, or dollars when drawdownDenomination is \"dollars\"","uniqueKey":"data.plans.items.[INDEX].tradingRule.maxDrawdown","typeLabel":"number"},"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.plans.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.plans.items.[INDEX].tradingRule.drawdownTrailCeiling","typeLabel":"number"}},"uniqueKey":"data.plans.items.[INDEX].tradingRule","typeLabel":"object"},"createdAt":{"type":"string","uniqueKey":"data.plans.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"data.plans.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"data.plans.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.plans","typeLabel":"object[]"},"pagination":{"type":"object","description":"Pagination info","properties":{"total":{"type":"number","description":"Total number of plans","uniqueKey":"data.pagination.total","typeLabel":"number"},"limit":{"type":"number","description":"Results per page","uniqueKey":"data.pagination.limit","typeLabel":"number"},"offset":{"type":"number","description":"Current offset","uniqueKey":"data.pagination.offset","typeLabel":"number"},"hasMore":{"type":"boolean","description":"Whether more results exist","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"}},"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","plans":[{"id":"88888888-8888-4888-8888-888888888881","name":"50K Challenge","displayName":"50K Evaluation","description":"Our most popular evaluation. Standard risk rules with a solid balance of target and protection.","price":299,"currency":"USD","durationDays":30,"accountSize":50000,"isActive":true,"metadata":{"targetAudience":"beginner","internalCode":"PLAN-50K-V2"},"tradingRule":{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","profitTarget":4000,"dailyLoss":1000,"maxLoss":2500,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null},"createdAt":"2025-12-30T12:28:04.204Z","updatedAt":"2025-12-30T12:28:04.204Z"},{"id":"88888888-8888-4888-8888-888888888883","name":"100K Pro","displayName":null,"description":"For experienced traders ready for a bigger challenge.","price":499,"currency":"USD","durationDays":45,"accountSize":100000,"isActive":true,"metadata":{"targetAudience":"experienced","internalCode":"PLAN-100K-V1"},"tradingRule":{"id":"99999999-9999-4999-8999-999999999992","name":"Aggressive Rules","profitTarget":10000,"dailyLoss":3000,"maxLoss":6000,"maxDrawdown":6,"drawdownType":"trailing","drawdownDenomination":"percent","drawdownTrailCeiling":null},"createdAt":"2026-02-18T21:19:57.328Z","updatedAt":"2026-02-18T21:19:57.328Z"}],"pagination":{"total":5,"limit":50,"offset":0,"hasMore":false}}}}},"exampleType":"generated"}},"exampleType":"generated"},"938a275f-810e-4c1e-81df-f9abb7df2bf7":{"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"},"9ba54a81-04e1-484e-abd7-d4695ba06ea8":{"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"},"9f6eff07-bdc8-4687-82fa-5578089d2ed8":{"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"},"34c4d0f5-42ee-4009-a75a-877c52093c13":{"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"},"d6f8246c-c121-4a33-981d-e31a35aa9dd2":{"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":{"202f6242-ffed-469e-8dd1-1a2a454b7aa2":{"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 plans for your organization - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:09.757Z","originalFileLocation":"platform-api/trading-plans/get-trading-plans-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 plans configured for your organization. What is a trading plan? A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \u0026quot;evaluation challenge\u0026quot; or \u0026quot;funded account\u0026quot; offering. What you get for each plan: - Plan details (name, description, price, currency) - Account size and evaluation duration - Default trading rules (profit target, max loss, drawdown limits) - Active/inactive status - Custom metadata (any JSON data you need) Example plans: - \u0026quot;50K Challenge\u0026quot; - $299, 30 days, $50,000 account - \u0026quot;100K Challenge\u0026quot; - $499, 30 days, $100,000 account - \u0026quot;200K Pro\u0026quot; - $999, 45 days, $200,000 account Filtering by metadata: Filter plans by any key:value in your metadata: http # Find plans for beginners GET /organization/trading-plans?metadata=targetAudience:beginner # Find promotional plans GET /organization/trading-plans?metadata=promo:true # Find plans by internal code GET /organization/trading-plans?metadata=internalCode:PLAN-100K Supports strings, numbers, and booleans. Uses fast GIN index. Filtering archived plans: By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans: http GET /organization/trading-plans?isActive=true Use cases: - Display available plans on your website - Validate plan IDs before creating accounts - Check which rules are attached to each plan - Audit your product offerings Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026amp; rules.\">\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 plans for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all trading plans configured for your organization. What is a trading plan? A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \u0026quot;evaluation challenge\u0026quot; or \u0026quot;funded account\u0026quot; offering. What you get for each plan: - Plan details (name, description, price, currency) - Account size and evaluation duration - Default trading rules (profit target, max loss, drawdown limits) - Active/inactive status - Custom metadata (any JSON data you need) Example plans: - \u0026quot;50K Challenge\u0026quot; - $299, 30 days, $50,000 account - \u0026quot;100K Challenge\u0026quot; - $499, 30 days, $100,000 account - \u0026quot;200K Pro\u0026quot; - $999, 45 days, $200,000 account Filtering by metadata: Filter plans by any key:value in your metadata: http # Find plans for beginners GET /organization/trading-plans?metadata=targetAudience:beginner # Find promotional plans GET /organization/trading-plans?metadata=promo:true # Find plans by internal code GET /organization/trading-plans?metadata=internalCode:PLAN-100K Supports strings, numbers, and booleans. Uses fast GIN index. Filtering archived plans: By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans: http GET /organization/trading-plans?isActive=true Use cases: - Display available plans on your website - Validate plan IDs before creating accounts - Check which rules are attached to each plan - Audit your product offerings Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026amp; rules.\">\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-plans/get-trading-plans-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+plans\u0026amp;title=Get+trading+plans+for+your+organization\u0026amp;description=Retrieve+all+trading+plans+configured+for+your+organization.%0A%0A**What+is+a+trading+plan%3F**%0AA+trading+plan+defines+the+product+you+sell+to+traders.+It+includes+th\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=d8af921628ace3b0ee7db2e2422f2828d11fa0a1b6dbddf388447a57168953c8\">\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 plans for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all trading plans configured for your organization. What is a trading plan? A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \u0026quot;evaluation challenge\u0026quot; or \u0026quot;funded account\u0026quot; offering. What you get for each plan: - Plan details (name, description, price, currency) - Account size and evaluation duration - Default trading rules (profit target, max loss, drawdown limits) - Active/inactive status - Custom metadata (any JSON data you need) Example plans: - \u0026quot;50K Challenge\u0026quot; - $299, 30 days, $50,000 account - \u0026quot;100K Challenge\u0026quot; - $499, 30 days, $100,000 account - \u0026quot;200K Pro\u0026quot; - $999, 45 days, $200,000 account Filtering by metadata: Filter plans by any key:value in your metadata: http # Find plans for beginners GET /organization/trading-plans?metadata=targetAudience:beginner # Find promotional plans GET /organization/trading-plans?metadata=promo:true # Find plans by internal code GET /organization/trading-plans?metadata=internalCode:PLAN-100K Supports strings, numbers, and booleans. Uses fast GIN index. Filtering archived plans: By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans: http GET /organization/trading-plans?isActive=true Use cases: - Display available plans on your website - Validate plan IDs before creating accounts - Check which rules are attached to each plan - Audit your product offerings Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026amp; rules.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Trading+plans\u0026amp;title=Get+trading+plans+for+your+organization\u0026amp;description=Retrieve+all+trading+plans+configured+for+your+organization.%0A%0A**What+is+a+trading+plan%3F**%0AA+trading+plan+defines+the+product+you+sell+to+traders.+It+includes+th\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=d8af921628ace3b0ee7db2e2422f2828d11fa0a1b6dbddf388447a57168953c8\">\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-plans/get-trading-plans-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-plans/get-trading-plans-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-plans/get-trading-plans-for-your-organization#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization\",\"name\":\"Get trading plans for your organization\",\"description\":\"Retrieve all trading plans configured for your organization. What is a trading plan? A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \\\"evaluation challenge\\\" or \\\"funded account\\\" offering. What you get for each plan: - Plan details (name, description, price, currency) - Account size and evaluation duration - Default trading rules (profit target, max loss, drawdown limits) - Active/inactive status - Custom metadata (any JSON data you need) Example plans: - \\\"50K Challenge\\\" - $299, 30 days, $50,000 account - \\\"100K Challenge\\\" - $499, 30 days, $100,000 account - \\\"200K Pro\\\" - $999, 45 days, $200,000 account Filtering by metadata: Filter plans by any key:value in your metadata: http # Find plans for beginners GET /organization/trading-plans?metadata=targetAudience:beginner # Find promotional plans GET /organization/trading-plans?metadata=promo:true # Find plans by internal code GET /organization/trading-plans?metadata=internalCode:PLAN-100K Supports strings, numbers, and booleans. Uses fast GIN index. Filtering archived plans: By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans: http GET /organization/trading-plans?isActive=true Use cases: - Display available plans on your website - Validate plan IDs before creating accounts - Check which rules are attached to each plan - Audit your product offerings Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.\",\"dateModified\":\"2026-11-15T15:41:09.757Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-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\":\"Get trading plans for your organization\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization#apireference\",\"headline\":\"Get trading plans for your organization\",\"name\":\"Get trading plans for your organization\",\"description\":\"Retrieve all trading plans configured for your organization. What is a trading plan? A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your \\\"evaluation challenge\\\" or \\\"funded account\\\" offering. What you get for each plan: - Plan details (name, description, price, currency) - Account size and evaluation duration - Default trading rules (profit target, max loss, drawdown limits) - Active/inactive status - Custom metadata (any JSON data you need) Example plans: - \\\"50K Challenge\\\" - $299, 30 days, $50,000 account - \\\"100K Challenge\\\" - $499, 30 days, $100,000 account - \\\"200K Pro\\\" - $999, 45 days, $200,000 account Filtering by metadata: Filter plans by any key:value in your metadata: http # Find plans for beginners GET /organization/trading-plans?metadata=targetAudience:beginner # Find promotional plans GET /organization/trading-plans?metadata=promo:true # Find plans by internal code GET /organization/trading-plans?metadata=internalCode:PLAN-100K Supports strings, numbers, and booleans. Uses fast GIN index. Filtering archived plans: By default all plans are returned, including archived ones (isActive: false). For plan pickers and storefronts, request only live plans: http GET /organization/trading-plans?isActive=true Use cases: - Display available plans on your website - Validate plan IDs before creating accounts - Check which rules are attached to each plan - Audit your product offerings Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-plans/get-trading-plans-for-your-organization#webpage\"},\"dateModified\":\"2026-11-15T15:41:09.757Z\",\"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-plans/get-trading-plans-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","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs","href":"/platform-api/trading-accounts/list-close-all-runs"},{"title":"Get trading accounts for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/get-trading-accounts-for-your-organization"},{"title":"Create a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/create-a-trading-account"},{"title":"Get bulk operation details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/bulk-operations/{batchId}","href":"/platform-api/trading-accounts/get-bulk-operation-details"},{"title":"Get a close-all run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs/{runId}","href":"/platform-api/trading-accounts/get-a-close-all-run"},{"title":"Get active traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/active-traders","href":"/platform-api/trading-accounts/get-active-traders"},{"title":"Get daily account and trader activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/activity","href":"/platform-api/trading-accounts/get-daily-account-and-trader-activity"},{"title":"Bulk-create unlinked accounts with import keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk","href":"/platform-api/trading-accounts/bulk-create-unlinked-accounts-with-import-keys"},{"title":"Bulk update trading accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts"},{"title":"Close all positions across accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/flatten","href":"/platform-api/trading-accounts/close-all-positions-across-accounts"},{"title":"Get open positions and equity for many accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions","href":"/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts"},{"title":"Get a specific trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/get-a-specific-trading-account"},{"title":"Update a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/update-a-trading-account"},{"title":"Get an account's event log and session history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/activity","href":"/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history"},{"title":"List an account's balance adjustments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/list-an-accounts-balance-adjustments"},{"title":"Credit or debit a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/credit-or-debit-a-trading-account"},{"title":"Get account change history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/changes","href":"/platform-api/trading-accounts/get-account-change-history"},{"title":"Get an account's daily P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/daily-pnl","href":"/platform-api/trading-accounts/get-an-accounts-daily-p\u0026l"},{"title":"Turn an account off (pause)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/deactivate","href":"/platform-api/trading-accounts/turn-an-account-off-pause"},{"title":"Get an account's equity and unrealized P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/equity","href":"/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p\u0026l"},{"title":"Close all positions on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/flatten","href":"/platform-api/trading-accounts/close-all-positions-on-an-account"},{"title":"Get an account's order event timeline","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/order-events","href":"/platform-api/trading-accounts/get-an-accounts-order-event-timeline"},{"title":"Get an account's order history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/orders","href":"/platform-api/trading-accounts/get-an-accounts-order-history"},{"title":"Get an account's open positions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/positions","href":"/platform-api/trading-accounts/get-an-accounts-open-positions"},{"title":"Turn an account back on","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/reactivate","href":"/platform-api/trading-accounts/turn-an-account-back-on"},{"title":"Unlink a trader (issues a fresh import key)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/unlink","href":"/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key"},{"title":"Get a balance adjustment by reference","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference}","href":"/platform-api/trading-accounts/get-a-balance-adjustment-by-reference"},{"title":"Cancel working orders on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/orders/cancel","href":"/platform-api/trading-accounts/cancel-working-orders-on-an-account"},{"title":"Close one position on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/positions/{contract}/close","href":"/platform-api/trading-accounts/close-one-position-on-an-account"}]},{"group":"Traders","pages":[{"title":"List trader identity bindings (customer ⇄ Hyperprop login)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trader-bindings","href":"/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login"},{"title":"Get traders for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders","href":"/platform-api/traders/get-traders-for-your-organization"},{"title":"Get a specific trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders/{traderId}","href":"/platform-api/traders/get-a-specific-trader"},{"title":"Update a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/traders/{traderId}","href":"/platform-api/traders/update-a-trader"},{"title":"Rebind a customer to a new Hyperprop login (support flow)","description":"Move a soulbound customer to a **new** Hyperprop login in one atomic operation. There is no plain \"release\" — every customer always has exactly one bound login, so a lost login is fixed by rebinding, never by leaving the customer unbound.\n\n**Use this when a customer lost access to their Hyperprop login** (forgot password AND lost the email — normal password reset covers everything else):\n\n1. Customer contacts YOUR support\n2. The customer creates their new Hyperprop account (signs up) and verifies its email\n3. You create an account for the customer with `unassigned: true` and `claimEmail` set to that email. When they open the Hyperprop app with the new login, the claim is refused (the customer is still bound to the old login) and you receive `account.claim_refused`\n4. You rebind here with that `claimEmail` (or the event's `attemptedUserId` as `traderId`) — find the binding via `GET /trader-bindings?customerId=...` or the event's `bindingId`. The pending account then links the next time the new login is loaded\n\n**What happens:**\n- The binding now points at the new login (`boundVia: \"rebind\"`)\n- **Every still-active account (`not_started` / `in_progress`) linked to the OLD login is set to `failed`** with the violation reason \"Identity rebound by the firm ...\" — the old login can never trade this customer's accounts again. An `account.failed` webhook fires per account, and the old login's open trading sessions end immediately.\n- Terminal accounts (`passed`/`failed`/`expired`) are untouched — history stays with the old identity for audit.\n- Unlinked accounts with pending import keys are now redeemable **only** by the new login.\n- Give the customer new accounts by creating them for the new login (or unassigned with an import key) — failed accounts are not transferred.\n- **Billing note:** activating an account under the new login (redeeming a pending key, or a new linked create) counts as a fresh market data activation for that login — a new billing cycle (platform + market data) starts, on top of what the old login already consumed. Billing follows logins, not customers.\n\n**Safety checks:**\n- The new login must have tried to claim an account of this customer (step 3), or already trade with your firm. Any other email or ID, including one with no Hyperprop login, gets the same `404 TRADER_NOT_FOUND`.\n- One login = one customer per firm: if the new login already belongs to a **different** customer of yours, the rebind is refused with `409 NEW_LOGIN_ALREADY_BOUND`.\n- Rebinding to the already-bound login is a no-op and returns `400 SAME_LOGIN`.\n\n**Permissions:** organization **admins** (or API key). Supports idempotency keys.\n\n**Error codes:** `BINDING_NOT_FOUND`, `TRADER_NOT_FOUND`, `SAME_LOGIN`, `NEW_LOGIN_ALREADY_BOUND`, `REBIND_ERROR`.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Team \u0026 roles.","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","description":"Create a new trading plan for your organization. **Admin only**.\n\n**Required fields:**\n| Field | Description |\n|-------|-------------|\n| `name` | Plan name (unique within org) |\n| `price` | Plan price |\n| `accountSize` | Account size in $ |\n| `tradingRuleId` | ID of the trading rule to use |\n\n**Optional fields:**\n| Field | Default | Description |\n|-------|---------|-------------|\n| `displayName` | null | Name shown to traders (falls back to `name`) |\n| `description` | null | Plan description |\n| `currency` | \"USD\" | Currency code |\n| `durationDays` | null | Duration in days (null = unlimited) |\n| `isActive` | true | Whether plan is active for purchase |\n| `metadata` | {} | Custom organization data |\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-plans\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"100K Evaluation\",\n \"displayName\": \"100K Evaluation\",\n \"description\": \"Our flagship 100K evaluation challenge\",\n \"price\": 299,\n \"accountSize\": 100000,\n \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n \"durationDays\": 30,\n \"metadata\": { \"featured\": true }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `PLAN_NAME_EXISTS` | A plan with this name already exists |\n| `RULE_NOT_FOUND` | No trading rule with this ID exists in your organization |\n| `ADMIN_REQUIRED` | Only admins can create plans |\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans \u0026 rules.","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 plans 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"]}