Retrieve all trading rules configured for your organization.
What are trading rules?
Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.
Rule parameters explained:
Parameter
Description
profitTarget
Amount trader must profit to pass (e.g., $10,000)
dailyLoss
Max loss allowed in a single day (e.g., $2,500)
maxLoss
Max total loss from starting balance (e.g., $5,000)
dailyDrawdown
Max daily loss as a whole-number percent of the day’s starting balance, open P&L included (e.g., 2 = 2%)
maxDrawdown
Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%)
maxContracts
Max position size in mini-equivalent contracts (e.g., 10)
microConversionRatio
How many micros count as 1 unit toward maxContracts (default 10)
consistency
Consistency rule percentage (0 = disabled)
dailyProfit
Max daily profit cap (0 = unlimited)
maxProfit
Max total profit cap (0 = unlimited)
maxAccountDays
Calendar days an account has to pass, counted from activation (0 = no time limit)
maxInactiveDays
Consecutive calendar days without a fill before the account fails (0 = off)
timeLimitExtensionDays
One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off)
timeLimitExtensionMinProgressPct
Total profit must be strictly above this % of profitTarget for the extension
personalRiskPolicy
Bounds on the risk controls traders set for themselves (see below)
Personal risk policy (personalRiskPolicy):
Traders can impose their own risk controls on an account — a personal daily
loss limit (optionally trailing their session peak), a daily profit target,
max trades per day/week, per-symbol contract limits, symbol blocks and
automatic brackets. These are enforced by the trade engine in real time and
can only ever make an account stricter than your rule set.
personalRiskPolicy lets you bound what a trader may choose:
Every value is a ceiling: a trader may always pick something stricter.
A ceiling is an effective bound, not just form validation. If the trader
leaves the field empty, your value applies (dailyLossLimitDefault when
set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a
field blank.
requireDailyLossLimit also forces the limit to be armed: a trader
cannot set the action to “do nothing”.
lockedByFirm: true makes the whole personal risk panel read-only; the
trader’s own API calls are rejected with FIRM_LOCKED.
Omit the object entirely (or send null on update) to leave traders
unconstrained. Nothing changes for existing rule sets.
Traders read and write their own settings through the trade API
(GET/POST /trade/account/risk-settings); this policy is the only knob
you need on your side.
Example rule sets:
Standard Challenge (beginner-friendly):
Profit target: $10,000 (10%)
Daily loss: $2,500 (2.5%)
Max drawdown: $5,000 (5%)
Aggressive Challenge (experienced traders):
Profit target: $8,000 (8%)
Daily loss: $4,000 (4%)
Max drawdown: $6,000 (6%)
Filtering by metadata:
# Find strict rule setsGET /organization/trading-rules?metadata=strict:true# Find rules by versionGET /organization/trading-rules?metadata=ruleVersion:2.1# Find rules for specific marketsGET /organization/trading-rules?metadata=market:futures
Use cases:
Display rule details on your website
Validate rule IDs before creating accounts
Compare different rule configurations
Audit your risk parameters
Access: read-only and full-access API keys. Dashboard members need view access to Plans & rules.
GET
/
v1
/
organization
/
trading-rules
Get trading rules for your organization
curl --request GET \ --url https://api.hyperprop.com/platform/v1/organization/trading-rules \ --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., "strict:true", "level:advanced")
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-rules/get-trading-rules-for-your-organization","slug":"/platform-api/trading-rules/get-trading-rules-for-your-organization","pageMetadata":{"title":"Get trading rules for your organization","description":"Retrieve all trading rules configured for your organization.\n\n**What are trading rules?**\nTrading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.\n\n**Rule parameters explained:**\n\n| Parameter | Description |\n|-----------|-------------|\n| `profitTarget` | Amount trader must profit to pass (e.g., $10,000) |\n| `dailyLoss` | Max loss allowed in a single day (e.g., $2,500) |\n| `maxLoss` | Max total loss from starting balance (e.g., $5,000) |\n| `dailyDrawdown` | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) |\n| `maxDrawdown` | Max drawdown below the reference set by `drawdownType`; a percent, or dollars when `drawdownDenomination` is `dollars` (e.g., 5 = 5%) |\n| `maxContracts` | Max position size in mini-equivalent contracts (e.g., 10) |\n| `microConversionRatio` | How many micros count as 1 unit toward maxContracts (default 10) |\n| `consistency` | Consistency rule percentage (0 = disabled) |\n| `dailyProfit` | Max daily profit cap (0 = unlimited) |\n| `maxProfit` | Max total profit cap (0 = unlimited) |\n| `maxAccountDays` | Calendar days an account has to pass, counted from activation (0 = no time limit) |\n| `maxInactiveDays` | Consecutive calendar days without a fill before the account fails (0 = off) |\n| `timeLimitExtensionDays` | One-time extension of `maxAccountDays` for accounts above the progress threshold at the time limit (0 = off) |\n| `timeLimitExtensionMinProgressPct` | Total profit must be strictly above this % of `profitTarget` for the extension |\n| `personalRiskPolicy` | Bounds on the risk controls traders set for themselves (see below) |\n\n**Personal risk policy (`personalRiskPolicy`):**\n\nTraders can impose their own risk controls on an account — a personal daily\nloss limit (optionally trailing their session peak), a daily profit target,\nmax trades per day/week, per-symbol contract limits, symbol blocks and\nautomatic brackets. These are enforced by the trade engine in real time and\ncan only ever make an account **stricter** than your rule set.\n\n`personalRiskPolicy` lets you bound what a trader may choose:\n\n```json\n{\n \"personalRiskPolicy\": {\n \"dailyLossLimitMax\": 1000,\n \"dailyLossLimitDefault\": 500,\n \"requireDailyLossLimit\": true,\n \"maxTradesPerDayMax\": 20,\n \"requireAutoBracket\": false,\n \"lockedByFirm\": false\n }\n}\n```\n\n- Every value is a **ceiling**: a trader may always pick something stricter.\n- A ceiling is an *effective* bound, not just form validation. If the trader\n leaves the field empty, your value applies (`dailyLossLimitDefault` when\n set, otherwise `dailyLossLimitMax`) — nobody escapes a bound by leaving a\n field blank.\n- `requireDailyLossLimit` also forces the limit to be **armed**: a trader\n cannot set the action to \"do nothing\".\n- `lockedByFirm: true` makes the whole personal risk panel read-only; the\n trader's own API calls are rejected with `FIRM_LOCKED`.\n- Omit the object entirely (or send `null` on update) to leave traders\n unconstrained. Nothing changes for existing rule sets.\n\nTraders read and write their own settings through the trade API\n(`GET`/`POST /trade/account/risk-settings`); this policy is the only knob\nyou need on your side.\n\n**Example rule sets:**\n\n*Standard Challenge (beginner-friendly):*\n- Profit target: $10,000 (10%)\n- Daily loss: $2,500 (2.5%)\n- Max drawdown: $5,000 (5%)\n\n*Aggressive Challenge (experienced traders):*\n- Profit target: $8,000 (8%)\n- Daily loss: $4,000 (4%)\n- Max drawdown: $6,000 (6%)\n\n**Filtering by metadata:**\n```http\n# Find strict rule sets\nGET /organization/trading-rules?metadata=strict:true\n\n# Find rules by version\nGET /organization/trading-rules?metadata=ruleVersion:2.1\n\n# Find rules for specific markets\nGET /organization/trading-rules?metadata=market:futures\n```\n\n**Use cases:**\n- Display rule details on your website\n- Validate rule IDs before creating accounts\n- Compare different rule configurations\n- Audit your risk parameters\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-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n em: \"em\",\n li: \"li\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve all trading rules configured for your organization.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"What are trading rules?\"\n }), \"\\nTrading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Rule parameters explained:\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Parameter\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"profitTarget\"\n })\n }), _jsx(_components.td, {\n children: \"Amount trader must profit to pass (e.g., $10,000)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"dailyLoss\"\n })\n }), _jsx(_components.td, {\n children: \"Max loss allowed in a single day (e.g., $2,500)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxLoss\"\n })\n }), _jsx(_components.td, {\n children: \"Max total loss from starting balance (e.g., $5,000)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"dailyDrawdown\"\n })\n }), _jsx(_components.td, {\n children: \"Max daily loss as a whole-number percent of the day’s starting balance, open P\u0026L included (e.g., 2 = 2%)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxDrawdown\"\n })\n }), _jsxs(_components.td, {\n children: [\"Max drawdown below the reference set by \", _jsx(_components.code, {\n children: \"drawdownType\"\n }), \"; a percent, or dollars when \", _jsx(_components.code, {\n children: \"drawdownDenomination\"\n }), \" is \", _jsx(_components.code, {\n children: \"dollars\"\n }), \" (e.g., 5 = 5%)\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxContracts\"\n })\n }), _jsx(_components.td, {\n children: \"Max position size in mini-equivalent contracts (e.g., 10)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"microConversionRatio\"\n })\n }), _jsx(_components.td, {\n children: \"How many micros count as 1 unit toward maxContracts (default 10)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"consistency\"\n })\n }), _jsx(_components.td, {\n children: \"Consistency rule percentage (0 = disabled)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"dailyProfit\"\n })\n }), _jsx(_components.td, {\n children: \"Max daily profit cap (0 = unlimited)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxProfit\"\n })\n }), _jsx(_components.td, {\n children: \"Max total profit cap (0 = unlimited)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxAccountDays\"\n })\n }), _jsx(_components.td, {\n children: \"Calendar days an account has to pass, counted from activation (0 = no time limit)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"maxInactiveDays\"\n })\n }), _jsx(_components.td, {\n children: \"Consecutive calendar days without a fill before the account fails (0 = off)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"timeLimitExtensionDays\"\n })\n }), _jsxs(_components.td, {\n children: [\"One-time extension of \", _jsx(_components.code, {\n children: \"maxAccountDays\"\n }), \" for accounts above the progress threshold at the time limit (0 = off)\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"timeLimitExtensionMinProgressPct\"\n })\n }), _jsxs(_components.td, {\n children: [\"Total profit must be strictly above this % of \", _jsx(_components.code, {\n children: \"profitTarget\"\n }), \" for the extension\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"personalRiskPolicy\"\n })\n }), _jsx(_components.td, {\n children: \"Bounds on the risk controls traders set for themselves (see below)\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"Personal risk policy (\", _jsx(_components.code, {\n children: \"personalRiskPolicy\"\n }), \"):\"]\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Traders can impose their own risk controls on an account — a personal daily\\nloss limit (optionally trailing their session peak), a daily profit target,\\nmax trades per day/week, per-symbol contract limits, symbol blocks and\\nautomatic brackets. These are enforced by the trade engine in real time and\\ncan only ever make an account \", _jsx(_components.strong, {\n children: \"stricter\"\n }), \" than your rule set.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"personalRiskPolicy\"\n }), \" lets you bound what a trader may choose:\"]\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"10\",\n language: \"json\",\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: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"10\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"personalRiskPolicy\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"dailyLossLimitMax\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"1000\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"dailyLossLimitDefault\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"500\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"requireDailyLossLimit\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"true\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"maxTradesPerDayMax\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"20\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"requireAutoBracket\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"lockedByFirm\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Every value is a \", _jsx(_components.strong, {\n children: \"ceiling\"\n }), \": a trader may always pick something stricter.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"A ceiling is an \", _jsx(_components.em, {\n children: \"effective\"\n }), \" bound, not just form validation. If the trader\\nleaves the field empty, your value applies (\", _jsx(_components.code, {\n children: \"dailyLossLimitDefault\"\n }), \" when\\nset, otherwise \", _jsx(_components.code, {\n children: \"dailyLossLimitMax\"\n }), \") — nobody escapes a bound by leaving a\\nfield blank.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"requireDailyLossLimit\"\n }), \" also forces the limit to be \", _jsx(_components.strong, {\n children: \"armed\"\n }), \": a trader\\ncannot set the action to “do nothing”.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"lockedByFirm: true\"\n }), \" makes the whole personal risk panel read-only; the\\ntrader’s own API calls are rejected with \", _jsx(_components.code, {\n children: \"FIRM_LOCKED\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Omit the object entirely (or send \", _jsx(_components.code, {\n children: \"null\"\n }), \" on update) to leave traders\\nunconstrained. Nothing changes for existing rule sets.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Traders read and write their own settings through the trade API\\n(\", _jsx(_components.code, {\n children: \"GET\"\n }), \"/\", _jsx(_components.code, {\n children: \"POST /trade/account/risk-settings\"\n }), \"); this policy is the only knob\\nyou need on your side.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example rule sets:\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.em, {\n children: \"Standard Challenge (beginner-friendly):\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Profit target: $10,000 (10%)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Daily loss: $2,500 (2.5%)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Max drawdown: $5,000 (5%)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.em, {\n children: \"Aggressive Challenge (experienced traders):\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Profit target: $8,000 (8%)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Daily loss: $4,000 (4%)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Max drawdown: $6,000 (6%)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Filtering by metadata:\"\n })\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 strict rule sets\"\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-rules?metadata=strict: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 rules by version\"\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-rules?metadata=ruleVersion:2.1\"\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 rules for specific markets\"\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-rules?metadata=market:futures\"\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 rule details on your website\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validate rule IDs before creating accounts\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Compare different rule configurations\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Audit your risk parameters\"\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 rules for your organization","description":"Retrieve all trading rules configured for your organization.\n\n**What are trading rules?**\nTrading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.\n\n**Rule parameters explained:**\n\n| Parameter | Description |\n|-----------|-------------|\n| `profitTarget` | Amount trader must profit to pass (e.g., $10,000) |\n| `dailyLoss` | Max loss allowed in a single day (e.g., $2,500) |\n| `maxLoss` | Max total loss from starting balance (e.g., $5,000) |\n| `dailyDrawdown` | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) |\n| `maxDrawdown` | Max drawdown below the reference set by `drawdownType`; a percent, or dollars when `drawdownDenomination` is `dollars` (e.g., 5 = 5%) |\n| `maxContracts` | Max position size in mini-equivalent contracts (e.g., 10) |\n| `microConversionRatio` | How many micros count as 1 unit toward maxContracts (default 10) |\n| `consistency` | Consistency rule percentage (0 = disabled) |\n| `dailyProfit` | Max daily profit cap (0 = unlimited) |\n| `maxProfit` | Max total profit cap (0 = unlimited) |\n| `maxAccountDays` | Calendar days an account has to pass, counted from activation (0 = no time limit) |\n| `maxInactiveDays` | Consecutive calendar days without a fill before the account fails (0 = off) |\n| `timeLimitExtensionDays` | One-time extension of `maxAccountDays` for accounts above the progress threshold at the time limit (0 = off) |\n| `timeLimitExtensionMinProgressPct` | Total profit must be strictly above this % of `profitTarget` for the extension |\n| `personalRiskPolicy` | Bounds on the risk controls traders set for themselves (see below) |\n\n**Personal risk policy (`personalRiskPolicy`):**\n\nTraders can impose their own risk controls on an account — a personal daily\nloss limit (optionally trailing their session peak), a daily profit target,\nmax trades per day/week, per-symbol contract limits, symbol blocks and\nautomatic brackets. These are enforced by the trade engine in real time and\ncan only ever make an account **stricter** than your rule set.\n\n`personalRiskPolicy` lets you bound what a trader may choose:\n\n```json\n{\n \"personalRiskPolicy\": {\n \"dailyLossLimitMax\": 1000,\n \"dailyLossLimitDefault\": 500,\n \"requireDailyLossLimit\": true,\n \"maxTradesPerDayMax\": 20,\n \"requireAutoBracket\": false,\n \"lockedByFirm\": false\n }\n}\n```\n\n- Every value is a **ceiling**: a trader may always pick something stricter.\n- A ceiling is an *effective* bound, not just form validation. If the trader\n leaves the field empty, your value applies (`dailyLossLimitDefault` when\n set, otherwise `dailyLossLimitMax`) — nobody escapes a bound by leaving a\n field blank.\n- `requireDailyLossLimit` also forces the limit to be **armed**: a trader\n cannot set the action to \"do nothing\".\n- `lockedByFirm: true` makes the whole personal risk panel read-only; the\n trader's own API calls are rejected with `FIRM_LOCKED`.\n- Omit the object entirely (or send `null` on update) to leave traders\n unconstrained. Nothing changes for existing rule sets.\n\nTraders read and write their own settings through the trade API\n(`GET`/`POST /trade/account/risk-settings`); this policy is the only knob\nyou need on your side.\n\n**Example rule sets:**\n\n*Standard Challenge (beginner-friendly):*\n- Profit target: $10,000 (10%)\n- Daily loss: $2,500 (2.5%)\n- Max drawdown: $5,000 (5%)\n\n*Aggressive Challenge (experienced traders):*\n- Profit target: $8,000 (8%)\n- Daily loss: $4,000 (4%)\n- Max drawdown: $6,000 (6%)\n\n**Filtering by metadata:**\n```http\n# Find strict rule sets\nGET /organization/trading-rules?metadata=strict:true\n\n# Find rules by version\nGET /organization/trading-rules?metadata=ruleVersion:2.1\n\n# Find rules for specific markets\nGET /organization/trading-rules?metadata=market:futures\n```\n\n**Use cases:**\n- Display rule details on your website\n- Validate rule IDs before creating accounts\n- Compare different rule configurations\n- Audit your risk parameters\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-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get trading rules for your organization","operationId":"getV1OrganizationTradingrules","description":"Retrieve all trading rules configured for your organization.\n\n**What are trading rules?**\nTrading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.\n\n**Rule parameters explained:**\n\n| Parameter | Description |\n|-----------|-------------|\n| `profitTarget` | Amount trader must profit to pass (e.g., $10,000) |\n| `dailyLoss` | Max loss allowed in a single day (e.g., $2,500) |\n| `maxLoss` | Max total loss from starting balance (e.g., $5,000) |\n| `dailyDrawdown` | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) |\n| `maxDrawdown` | Max drawdown below the reference set by `drawdownType`; a percent, or dollars when `drawdownDenomination` is `dollars` (e.g., 5 = 5%) |\n| `maxContracts` | Max position size in mini-equivalent contracts (e.g., 10) |\n| `microConversionRatio` | How many micros count as 1 unit toward maxContracts (default 10) |\n| `consistency` | Consistency rule percentage (0 = disabled) |\n| `dailyProfit` | Max daily profit cap (0 = unlimited) |\n| `maxProfit` | Max total profit cap (0 = unlimited) |\n| `maxAccountDays` | Calendar days an account has to pass, counted from activation (0 = no time limit) |\n| `maxInactiveDays` | Consecutive calendar days without a fill before the account fails (0 = off) |\n| `timeLimitExtensionDays` | One-time extension of `maxAccountDays` for accounts above the progress threshold at the time limit (0 = off) |\n| `timeLimitExtensionMinProgressPct` | Total profit must be strictly above this % of `profitTarget` for the extension |\n| `personalRiskPolicy` | Bounds on the risk controls traders set for themselves (see below) |\n\n**Personal risk policy (`personalRiskPolicy`):**\n\nTraders can impose their own risk controls on an account — a personal daily\nloss limit (optionally trailing their session peak), a daily profit target,\nmax trades per day/week, per-symbol contract limits, symbol blocks and\nautomatic brackets. These are enforced by the trade engine in real time and\ncan only ever make an account **stricter** than your rule set.\n\n`personalRiskPolicy` lets you bound what a trader may choose:\n\n```json\n{\n \"personalRiskPolicy\": {\n \"dailyLossLimitMax\": 1000,\n \"dailyLossLimitDefault\": 500,\n \"requireDailyLossLimit\": true,\n \"maxTradesPerDayMax\": 20,\n \"requireAutoBracket\": false,\n \"lockedByFirm\": false\n }\n}\n```\n\n- Every value is a **ceiling**: a trader may always pick something stricter.\n- A ceiling is an *effective* bound, not just form validation. If the trader\n leaves the field empty, your value applies (`dailyLossLimitDefault` when\n set, otherwise `dailyLossLimitMax`) — nobody escapes a bound by leaving a\n field blank.\n- `requireDailyLossLimit` also forces the limit to be **armed**: a trader\n cannot set the action to \"do nothing\".\n- `lockedByFirm: true` makes the whole personal risk panel read-only; the\n trader's own API calls are rejected with `FIRM_LOCKED`.\n- Omit the object entirely (or send `null` on update) to leave traders\n unconstrained. Nothing changes for existing rule sets.\n\nTraders read and write their own settings through the trade API\n(`GET`/`POST /trade/account/risk-settings`); this policy is the only knob\nyou need on your side.\n\n**Example rule sets:**\n\n*Standard Challenge (beginner-friendly):*\n- Profit target: $10,000 (10%)\n- Daily loss: $2,500 (2.5%)\n- Max drawdown: $5,000 (5%)\n\n*Aggressive Challenge (experienced traders):*\n- Profit target: $8,000 (8%)\n- Daily loss: $4,000 (4%)\n- Max drawdown: $6,000 (6%)\n\n**Filtering by metadata:**\n```http\n# Find strict rule sets\nGET /organization/trading-rules?metadata=strict:true\n\n# Find rules by version\nGET /organization/trading-rules?metadata=ruleVersion:2.1\n\n# Find rules for specific markets\nGET /organization/trading-rules?metadata=market:futures\n```\n\n**Use cases:**\n- Display rule details on your website\n- Validate rule IDs before creating accounts\n- Compare different rule configurations\n- Audit your risk parameters\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","parameters":["b0f6799d-9fd1-4e1e-b1ba-e9948ef55ff0","21bc111c-2855-48ac-b713-274245c8d874","84611578-068a-4268-9198-e8823c634f5a","a878daec-1e0c-48c2-b744-931c4f7448e9"],"tags":["Trading rules"],"security":["e00171a1-588f-4186-aa65-22cf0b8e06f6"],"responses":{"200":"e0a00ffb-59f9-4dbe-8268-0b7bd4e20bfb","400":"057ddb97-c4ca-4636-988b-d0993d84a5fa","401":"c2ed566d-b57c-4051-b25a-1c48a55d62cf","403":"b128eb3a-c99d-4574-ae13-34892c9281b8","500":"c69b944e-8093-4de0-ba83-a91d49a32b07","504":"e825d275-d4ad-4ebc-bd30-426f656c9e9f"},"method":"get","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/trading-rules","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Get trading rules for your organization","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b0f6799d-9fd1-4e1e-b1ba-e9948ef55ff0":{"description":"Filter by metadata key:value (e.g., \"strict:true\", \"level:advanced\")","name":"metadata","in":"query","required":false,"example":"strict:true","schema":{"type":"string","isRequired":false,"description":"Filter by metadata key:value (e.g., \"strict:true\", \"level:advanced\")","uniqueKey":"","typeLabel":"string"}},"21bc111c-2855-48ac-b713-274245c8d874":{"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"}},"84611578-068a-4268-9198-e8823c634f5a":{"description":"Pagination offset","name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0,"description":"Pagination offset","uniqueKey":"","typeLabel":"integer"}},"a878daec-1e0c-48c2-b744-931c4f7448e9":{"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":{"e0a00ffb-59f9-4dbe-8268-0b7bd4e20bfb":{"description":"Success - Returns all trading rules","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","rules":[{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","description":"Balanced evaluation rules with 8% profit target and 5% max trailing loss.","profitTarget":4000,"dailyProfit":0,"maxProfit":0,"dailyLoss":1000,"maxLoss":2500,"dailyDrawdown":2,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null,"consistency":0,"maxContracts":10,"microConversionRatio":10,"metadata":{},"createdAt":"2025-12-30T12:03:09.385Z","updatedAt":"2026-03-03T15:00:00.000Z"},{"id":"99999999-9999-4999-8999-999999999992","name":"Aggressive Rules","description":"Higher risk tolerance with 10% profit target and 6% max loss.","profitTarget":10000,"dailyProfit":0,"maxProfit":0,"dailyLoss":3000,"maxLoss":6000,"dailyDrawdown":3,"maxDrawdown":6,"drawdownType":"trailing","drawdownDenomination":"percent","drawdownTrailCeiling":null,"consistency":0,"maxContracts":20,"microConversionRatio":5,"metadata":{},"createdAt":"2026-02-18T21:19:56.853Z","updatedAt":"2026-03-03T15:00:00.000Z"}],"pagination":{"total":4,"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"},"rules":{"type":"array","description":"Array of trading rules","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique rule ID","uniqueKey":"data.rules.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Rule set display name","uniqueKey":"data.rules.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Rule set description","uniqueKey":"data.rules.items.[INDEX].description","typeLabel":"string"},"profitTarget":{"type":"number","description":"Profit target to pass ($)","uniqueKey":"data.rules.items.[INDEX].profitTarget","typeLabel":"number"},"dailyProfit":{"type":"number","description":"Max daily profit cap (0 = unlimited)","uniqueKey":"data.rules.items.[INDEX].dailyProfit","typeLabel":"number"},"dailyProfitEnforced":{"type":"boolean","description":"Whether the engine enforces dailyProfit","uniqueKey":"data.rules.items.[INDEX].dailyProfitEnforced","typeLabel":"boolean"},"bestDayStopPct":{"type":"integer","description":"Best-day stop as a percent of profitTarget (0 = off)","uniqueKey":"data.rules.items.[INDEX].bestDayStopPct","typeLabel":"integer"},"dailyLossEntryBufferTicks":{"type":"integer","description":"Daily-loss entry buffer in ticks per contract (0 = off)","uniqueKey":"data.rules.items.[INDEX].dailyLossEntryBufferTicks","typeLabel":"integer"},"maxProfit":{"type":"number","description":"Max total profit cap (0 = unlimited)","uniqueKey":"data.rules.items.[INDEX].maxProfit","typeLabel":"number"},"dailyLoss":{"type":"number","description":"Max loss allowed per day ($)","uniqueKey":"data.rules.items.[INDEX].dailyLoss","typeLabel":"number"},"maxLoss":{"type":"number","description":"Max total loss ($)","uniqueKey":"data.rules.items.[INDEX].maxLoss","typeLabel":"number"},"dailyDrawdown":{"type":"number","description":"Max daily drawdown, a whole-number percent of the day's starting balance","uniqueKey":"data.rules.items.[INDEX].dailyDrawdown","typeLabel":"number"},"maxDrawdown":{"type":"number","description":"Max drawdown. A percent of the reference, or dollars when drawdownDenomination is \"dollars\"","uniqueKey":"data.rules.items.[INDEX].maxDrawdown","typeLabel":"number"},"drawdownType":{"type":"string","description":"How drawdown is calculated: static (from initial balance), trailing (real-time from HWM), eod (trailing, updates at market close)","enum":["static","trailing","eod"],"uniqueKey":"data.rules.items.[INDEX].drawdownType","typeLabel":"enum\u003cstring>"},"drawdownDenomination":{"type":"string","description":"Unit of maxDrawdown: \"percent\" of the reference (default) or \"dollars\", a fixed dollar amount below it","enum":["percent","dollars"],"uniqueKey":"data.rules.items.[INDEX].drawdownDenomination","typeLabel":"enum\u003cstring>"},"drawdownTrailCeiling":{"type":"number","description":"Trailing floor lock level, dollars above initial balance (null = trails forever)","uniqueKey":"data.rules.items.[INDEX].drawdownTrailCeiling","typeLabel":"number"},"consistency":{"type":"number","description":"Consistency rule % (0 = disabled)","uniqueKey":"data.rules.items.[INDEX].consistency","typeLabel":"number"},"consistencyEnforced":{"type":"boolean","description":"Whether the engine enforces the consistency rule for accounts on this rule set","uniqueKey":"data.rules.items.[INDEX].consistencyEnforced","typeLabel":"boolean"},"consistencyBase":{"type":"string","description":"Configured base mode (null = automatic by account type)","uniqueKey":"data.rules.items.[INDEX].consistencyBase","typeLabel":"string"},"consistencyTolerancePct":{"type":"number","description":"Daily-cap buffer as % of starting balance","uniqueKey":"data.rules.items.[INDEX].consistencyTolerancePct","typeLabel":"number"},"consistencyLeniency":{"type":"number","description":"Flat $ daily-cap buffer","uniqueKey":"data.rules.items.[INDEX].consistencyLeniency","typeLabel":"number"},"consistencyMinDays":{"type":"number","description":"Min profitable days (null = auto ceil(100/consistency))","uniqueKey":"data.rules.items.[INDEX].consistencyMinDays","typeLabel":"number"},"consistencyProfitableDayMin":{"type":"number","description":"Min net PnL ($) for a day to count as profitable","uniqueKey":"data.rules.items.[INDEX].consistencyProfitableDayMin","typeLabel":"number"},"maxPayouts":{"type":"number","description":"Payout count that triggers account.max_payouts_reached (null = unlimited)","uniqueKey":"data.rules.items.[INDEX].maxPayouts","typeLabel":"number"},"payoutMllLockOffset":{"type":"number","description":"Default move_mll_to_lock offset ($ above initial balance)","uniqueKey":"data.rules.items.[INDEX].payoutMllLockOffset","typeLabel":"number"},"maxAccountDays":{"type":"integer","description":"Calendar days to pass, counted from activation (0 = no time limit)","uniqueKey":"data.rules.items.[INDEX].maxAccountDays","typeLabel":"integer"},"maxInactiveDays":{"type":"integer","description":"Consecutive calendar days without a fill before the account fails (0 = off)","uniqueKey":"data.rules.items.[INDEX].maxInactiveDays","typeLabel":"integer"},"timeLimitExtensionDays":{"type":"integer","description":"One-time extension of maxAccountDays, in calendar days (0 = off)","uniqueKey":"data.rules.items.[INDEX].timeLimitExtensionDays","typeLabel":"integer"},"timeLimitExtensionMinProgressPct":{"type":"integer","description":"Total profit must be strictly above this % of profitTarget for the extension","uniqueKey":"data.rules.items.[INDEX].timeLimitExtensionMinProgressPct","typeLabel":"integer"},"dailyLossOffThreshold":{"type":"integer","description":"Dollars above the starting balance at which the daily loss limit switches off from the next trading day (null = off)","uniqueKey":"data.rules.items.[INDEX].dailyLossOffThreshold","typeLabel":"integer"},"dailyLossOffMode":{"type":"string","description":"while_above (back on after a close below the target) or permanent","enum":["while_above","permanent"],"uniqueKey":"data.rules.items.[INDEX].dailyLossOffMode","typeLabel":"enum\u003cstring>"},"maxContracts":{"type":"number","description":"Max position size in mini-equivalent contracts. On a market whose contract steps fractionally (the BTCUSDT perpetual steps 0.001 BTC) this counts ENGINE units, so 100 is 0.1 BTC and 1000 is 1 BTC — read `quantityStep` on the contract rather than assuming one unit is one coin.","uniqueKey":"data.rules.items.[INDEX].maxContracts","typeLabel":"number"},"microConversionRatio":{"type":"number","description":"How many micros count as 1 unit toward maxContracts (default 10)","uniqueKey":"data.rules.items.[INDEX].microConversionRatio","typeLabel":"number"},"maxPositionByMarket":{"type":"object","description":"Per-market position limits in each market's own unit. Overrides maxContracts for the markets it names.","example":{"BINANCE":0.5},"uniqueKey":"data.rules.items.[INDEX].maxPositionByMarket","typeLabel":"object"},"perpMaxLeverage":{"type":"number","description":"Perpetuals: the largest total open position value, as a multiple of the account balance (2 = positions worth up to twice the balance). Open positions and working orders count; closing orders never do. Capped at the instrument's own maximum. Null = no leverage cap (maxPositionByMarket still applies). Does not affect futures.","example":2,"uniqueKey":"data.rules.items.[INDEX].perpMaxLeverage","typeLabel":"number"},"blockedSymbols":{"type":"array","description":"Contract roots that cannot be opened on accounts using this rule set. null means nothing is blocked.","example":["ES","NQ","YM","RTY","CL","GC"],"items":{"type":"string","uniqueKey":"data.rules.items.[INDEX].blockedSymbols.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.rules.items.[INDEX].blockedSymbols","typeLabel":"string[]"},"sessionWindowStart":{"type":"string","description":"Start of the trading session (HH:MM). null = no session restriction.","example":"09:30","uniqueKey":"data.rules.items.[INDEX].sessionWindowStart","typeLabel":"string"},"sessionWindowEnd":{"type":"string","description":"End of the trading session (HH:MM). null = no session restriction.","example":"16:00","uniqueKey":"data.rules.items.[INDEX].sessionWindowEnd","typeLabel":"string"},"sessionWindowTimezone":{"type":"string","description":"IANA time zone of the session times. null when no session is set.","example":"America/New_York","uniqueKey":"data.rules.items.[INDEX].sessionWindowTimezone","typeLabel":"string"},"maxPositionByProduct":{"type":"object","description":"Per-product position caps: contract root → the most contracts of that product an account may hold plus work on one side. null means no caps.","example":{"SIL":5},"uniqueKey":"data.rules.items.[INDEX].maxPositionByProduct","typeLabel":"object"},"personalRiskPolicy":{"type":"object","description":"Firm bounds on trader-set personal risk controls","uniqueKey":"data.rules.items.[INDEX].personalRiskPolicy","typeLabel":"object"},"metadata":{"type":"object","description":"Custom metadata","uniqueKey":"data.rules.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","uniqueKey":"data.rules.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"data.rules.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"data.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.rules","typeLabel":"object[]"},"pagination":{"type":"object","description":"Pagination info","properties":{"total":{"type":"number","description":"Total number of rules","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","rules":[{"id":"99999999-9999-4999-8999-999999999991","name":"Standard Rules","description":"Balanced evaluation rules with 8% profit target and 5% max trailing loss.","profitTarget":4000,"dailyProfit":0,"maxProfit":0,"dailyLoss":1000,"maxLoss":2500,"dailyDrawdown":2,"maxDrawdown":5,"drawdownType":"static","drawdownDenomination":"percent","drawdownTrailCeiling":null,"consistency":0,"maxContracts":10,"microConversionRatio":10,"metadata":{},"createdAt":"2025-12-30T12:03:09.385Z","updatedAt":"2026-03-03T15:00:00.000Z"},{"id":"99999999-9999-4999-8999-999999999992","name":"Aggressive Rules","description":"Higher risk tolerance with 10% profit target and 6% max loss.","profitTarget":10000,"dailyProfit":0,"maxProfit":0,"dailyLoss":3000,"maxLoss":6000,"dailyDrawdown":3,"maxDrawdown":6,"drawdownType":"trailing","drawdownDenomination":"percent","drawdownTrailCeiling":null,"consistency":0,"maxContracts":20,"microConversionRatio":5,"metadata":{},"createdAt":"2026-02-18T21:19:56.853Z","updatedAt":"2026-03-03T15:00:00.000Z"}],"pagination":{"total":4,"limit":50,"offset":0,"hasMore":false}}}}},"exampleType":"generated"}},"exampleType":"generated"},"057ddb97-c4ca-4636-988b-d0993d84a5fa":{"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"},"c2ed566d-b57c-4051-b25a-1c48a55d62cf":{"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"},"b128eb3a-c99d-4574-ae13-34892c9281b8":{"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"},"c69b944e-8093-4de0-ba83-a91d49a32b07":{"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"},"e825d275-d4ad-4ebc-bd30-426f656c9e9f":{"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":{"e00171a1-588f-4186-aa65-22cf0b8e06f6":{"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 rules for your organization - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:09.836Z","originalFileLocation":"platform-api/trading-rules/get-trading-rules-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 rules configured for your organization. What are trading rules? Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans. Rule parameters explained: | Parameter | Description | |-----------|-------------| | profitTarget | Amount trader must profit to pass (e.g., $10,000) | | dailyLoss | Max loss allowed in a single day (e.g., $2,500) | | maxLoss | Max total loss from starting balance (e.g., $5,000) | | dailyDrawdown | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (e.g., 2 = 2%) | | maxDrawdown | Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%) | | maxContracts | Max position size in mini-equivalent contracts (e.g., 10) | | microConversionRatio | How many micros count as 1 unit toward maxContracts (default 10) | | consistency | Consistency rule percentage (0 = disabled) | | dailyProfit | Max daily profit cap (0 = unlimited) | | maxProfit | Max total profit cap (0 = unlimited) | | maxAccountDays | Calendar days an account has to pass, counted from activation (0 = no time limit) | | maxInactiveDays | Consecutive calendar days without a fill before the account fails (0 = off) | | timeLimitExtensionDays | One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off) | | timeLimitExtensionMinProgressPct | Total profit must be strictly above this % of profitTarget for the extension | | personalRiskPolicy | Bounds on the risk controls traders set for themselves (see below) | Personal risk policy (personalRiskPolicy): Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set. personalRiskPolicy lets you bound what a trader may choose: json { \u0026quot;personalRiskPolicy\u0026quot;: { \u0026quot;dailyLossLimitMax\u0026quot;: 1000, \u0026quot;dailyLossLimitDefault\u0026quot;: 500, \u0026quot;requireDailyLossLimit\u0026quot;: true, \u0026quot;maxTradesPerDayMax\u0026quot;: 20, \u0026quot;requireAutoBracket\u0026quot;: false, \u0026quot;lockedByFirm\u0026quot;: false } } - Every value is a ceiling: a trader may always pick something stricter. - A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank. - requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to \u0026quot;do nothing\u0026quot;. - lockedByFirm: true makes the whole personal risk panel read-only; the trader\u0026#x27;s own API calls are rejected with FIRM_LOCKED. - Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets. Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side. Example rule sets: Standard Challenge (beginner-friendly): - Profit target: $10,000 (10%) - Daily loss: $2,500 (2.5%) - Max drawdown: $5,000 (5%) Aggressive Challenge (experienced traders): - Profit target: $8,000 (8%) - Daily loss: $4,000 (4%) - Max drawdown: $6,000 (6%) Filtering by metadata: http # Find strict rule sets GET /organization/trading-rules?metadata=strict:true # Find rules by version GET /organization/trading-rules?metadata=ruleVersion:2.1 # Find rules for specific markets GET /organization/trading-rules?metadata=market:futures Use cases: - Display rule details on your website - Validate rule IDs before creating accounts - Compare different rule configurations - Audit your risk parameters 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 rules for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all trading rules configured for your organization. What are trading rules? Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans. Rule parameters explained: | Parameter | Description | |-----------|-------------| | profitTarget | Amount trader must profit to pass (e.g., $10,000) | | dailyLoss | Max loss allowed in a single day (e.g., $2,500) | | maxLoss | Max total loss from starting balance (e.g., $5,000) | | dailyDrawdown | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (e.g., 2 = 2%) | | maxDrawdown | Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%) | | maxContracts | Max position size in mini-equivalent contracts (e.g., 10) | | microConversionRatio | How many micros count as 1 unit toward maxContracts (default 10) | | consistency | Consistency rule percentage (0 = disabled) | | dailyProfit | Max daily profit cap (0 = unlimited) | | maxProfit | Max total profit cap (0 = unlimited) | | maxAccountDays | Calendar days an account has to pass, counted from activation (0 = no time limit) | | maxInactiveDays | Consecutive calendar days without a fill before the account fails (0 = off) | | timeLimitExtensionDays | One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off) | | timeLimitExtensionMinProgressPct | Total profit must be strictly above this % of profitTarget for the extension | | personalRiskPolicy | Bounds on the risk controls traders set for themselves (see below) | Personal risk policy (personalRiskPolicy): Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set. personalRiskPolicy lets you bound what a trader may choose: json { \u0026quot;personalRiskPolicy\u0026quot;: { \u0026quot;dailyLossLimitMax\u0026quot;: 1000, \u0026quot;dailyLossLimitDefault\u0026quot;: 500, \u0026quot;requireDailyLossLimit\u0026quot;: true, \u0026quot;maxTradesPerDayMax\u0026quot;: 20, \u0026quot;requireAutoBracket\u0026quot;: false, \u0026quot;lockedByFirm\u0026quot;: false } } - Every value is a ceiling: a trader may always pick something stricter. - A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank. - requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to \u0026quot;do nothing\u0026quot;. - lockedByFirm: true makes the whole personal risk panel read-only; the trader\u0026#x27;s own API calls are rejected with FIRM_LOCKED. - Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets. Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side. Example rule sets: Standard Challenge (beginner-friendly): - Profit target: $10,000 (10%) - Daily loss: $2,500 (2.5%) - Max drawdown: $5,000 (5%) Aggressive Challenge (experienced traders): - Profit target: $8,000 (8%) - Daily loss: $4,000 (4%) - Max drawdown: $6,000 (6%) Filtering by metadata: http # Find strict rule sets GET /organization/trading-rules?metadata=strict:true # Find rules by version GET /organization/trading-rules?metadata=ruleVersion:2.1 # Find rules for specific markets GET /organization/trading-rules?metadata=market:futures Use cases: - Display rule details on your website - Validate rule IDs before creating accounts - Compare different rule configurations - Audit your risk parameters 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-rules/get-trading-rules-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+rules\u0026amp;title=Get+trading+rules+for+your+organization\u0026amp;description=Retrieve+all+trading+rules+configured+for+your+organization.%0A%0A**What+are+trading+rules%3F**%0ATrading+rules+define+the+constraints+and+targets+for+your+evaluation+a\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=a194d3dd00e2f7aeda6d85323aac827e36db1bed904c733a407e0389c052cfed\">\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 rules for your organization - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all trading rules configured for your organization. What are trading rules? Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans. Rule parameters explained: | Parameter | Description | |-----------|-------------| | profitTarget | Amount trader must profit to pass (e.g., $10,000) | | dailyLoss | Max loss allowed in a single day (e.g., $2,500) | | maxLoss | Max total loss from starting balance (e.g., $5,000) | | dailyDrawdown | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (e.g., 2 = 2%) | | maxDrawdown | Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%) | | maxContracts | Max position size in mini-equivalent contracts (e.g., 10) | | microConversionRatio | How many micros count as 1 unit toward maxContracts (default 10) | | consistency | Consistency rule percentage (0 = disabled) | | dailyProfit | Max daily profit cap (0 = unlimited) | | maxProfit | Max total profit cap (0 = unlimited) | | maxAccountDays | Calendar days an account has to pass, counted from activation (0 = no time limit) | | maxInactiveDays | Consecutive calendar days without a fill before the account fails (0 = off) | | timeLimitExtensionDays | One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off) | | timeLimitExtensionMinProgressPct | Total profit must be strictly above this % of profitTarget for the extension | | personalRiskPolicy | Bounds on the risk controls traders set for themselves (see below) | Personal risk policy (personalRiskPolicy): Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set. personalRiskPolicy lets you bound what a trader may choose: json { \u0026quot;personalRiskPolicy\u0026quot;: { \u0026quot;dailyLossLimitMax\u0026quot;: 1000, \u0026quot;dailyLossLimitDefault\u0026quot;: 500, \u0026quot;requireDailyLossLimit\u0026quot;: true, \u0026quot;maxTradesPerDayMax\u0026quot;: 20, \u0026quot;requireAutoBracket\u0026quot;: false, \u0026quot;lockedByFirm\u0026quot;: false } } - Every value is a ceiling: a trader may always pick something stricter. - A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank. - requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to \u0026quot;do nothing\u0026quot;. - lockedByFirm: true makes the whole personal risk panel read-only; the trader\u0026#x27;s own API calls are rejected with FIRM_LOCKED. - Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets. Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side. Example rule sets: Standard Challenge (beginner-friendly): - Profit target: $10,000 (10%) - Daily loss: $2,500 (2.5%) - Max drawdown: $5,000 (5%) Aggressive Challenge (experienced traders): - Profit target: $8,000 (8%) - Daily loss: $4,000 (4%) - Max drawdown: $6,000 (6%) Filtering by metadata: http # Find strict rule sets GET /organization/trading-rules?metadata=strict:true # Find rules by version GET /organization/trading-rules?metadata=ruleVersion:2.1 # Find rules for specific markets GET /organization/trading-rules?metadata=market:futures Use cases: - Display rule details on your website - Validate rule IDs before creating accounts - Compare different rule configurations - Audit your risk parameters 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+rules\u0026amp;title=Get+trading+rules+for+your+organization\u0026amp;description=Retrieve+all+trading+rules+configured+for+your+organization.%0A%0A**What+are+trading+rules%3F**%0ATrading+rules+define+the+constraints+and+targets+for+your+evaluation+a\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=a194d3dd00e2f7aeda6d85323aac827e36db1bed904c733a407e0389c052cfed\">\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-rules/get-trading-rules-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-rules/get-trading-rules-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-rules/get-trading-rules-for-your-organization#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization\",\"name\":\"Get trading rules for your organization\",\"description\":\"Retrieve all trading rules configured for your organization. What are trading rules? Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans. Rule parameters explained: | Parameter | Description | |-----------|-------------| | profitTarget | Amount trader must profit to pass (e.g., $10,000) | | dailyLoss | Max loss allowed in a single day (e.g., $2,500) | | maxLoss | Max total loss from starting balance (e.g., $5,000) | | dailyDrawdown | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) | | maxDrawdown | Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%) | | maxContracts | Max position size in mini-equivalent contracts (e.g., 10) | | microConversionRatio | How many micros count as 1 unit toward maxContracts (default 10) | | consistency | Consistency rule percentage (0 = disabled) | | dailyProfit | Max daily profit cap (0 = unlimited) | | maxProfit | Max total profit cap (0 = unlimited) | | maxAccountDays | Calendar days an account has to pass, counted from activation (0 = no time limit) | | maxInactiveDays | Consecutive calendar days without a fill before the account fails (0 = off) | | timeLimitExtensionDays | One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off) | | timeLimitExtensionMinProgressPct | Total profit must be strictly above this % of profitTarget for the extension | | personalRiskPolicy | Bounds on the risk controls traders set for themselves (see below) | Personal risk policy (personalRiskPolicy): Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set. personalRiskPolicy lets you bound what a trader may choose: json { \\\"personalRiskPolicy\\\": { \\\"dailyLossLimitMax\\\": 1000, \\\"dailyLossLimitDefault\\\": 500, \\\"requireDailyLossLimit\\\": true, \\\"maxTradesPerDayMax\\\": 20, \\\"requireAutoBracket\\\": false, \\\"lockedByFirm\\\": false } } - Every value is a ceiling: a trader may always pick something stricter. - A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank. - requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to \\\"do nothing\\\". - lockedByFirm: true makes the whole personal risk panel read-only; the trader's own API calls are rejected with FIRM_LOCKED. - Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets. Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side. Example rule sets: Standard Challenge (beginner-friendly): - Profit target: $10,000 (10%) - Daily loss: $2,500 (2.5%) - Max drawdown: $5,000 (5%) Aggressive Challenge (experienced traders): - Profit target: $8,000 (8%) - Daily loss: $4,000 (4%) - Max drawdown: $6,000 (6%) Filtering by metadata: http # Find strict rule sets GET /organization/trading-rules?metadata=strict:true # Find rules by version GET /organization/trading-rules?metadata=ruleVersion:2.1 # Find rules for specific markets GET /organization/trading-rules?metadata=market:futures Use cases: - Display rule details on your website - Validate rule IDs before creating accounts - Compare different rule configurations - Audit your risk parameters Access: read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.\",\"dateModified\":\"2026-11-15T15:41:09.836Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-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 rules for your organization\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization#apireference\",\"headline\":\"Get trading rules for your organization\",\"name\":\"Get trading rules for your organization\",\"description\":\"Retrieve all trading rules configured for your organization. What are trading rules? Trading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans. Rule parameters explained: | Parameter | Description | |-----------|-------------| | profitTarget | Amount trader must profit to pass (e.g., $10,000) | | dailyLoss | Max loss allowed in a single day (e.g., $2,500) | | maxLoss | Max total loss from starting balance (e.g., $5,000) | | dailyDrawdown | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) | | maxDrawdown | Max drawdown below the reference set by drawdownType; a percent, or dollars when drawdownDenomination is dollars (e.g., 5 = 5%) | | maxContracts | Max position size in mini-equivalent contracts (e.g., 10) | | microConversionRatio | How many micros count as 1 unit toward maxContracts (default 10) | | consistency | Consistency rule percentage (0 = disabled) | | dailyProfit | Max daily profit cap (0 = unlimited) | | maxProfit | Max total profit cap (0 = unlimited) | | maxAccountDays | Calendar days an account has to pass, counted from activation (0 = no time limit) | | maxInactiveDays | Consecutive calendar days without a fill before the account fails (0 = off) | | timeLimitExtensionDays | One-time extension of maxAccountDays for accounts above the progress threshold at the time limit (0 = off) | | timeLimitExtensionMinProgressPct | Total profit must be strictly above this % of profitTarget for the extension | | personalRiskPolicy | Bounds on the risk controls traders set for themselves (see below) | Personal risk policy (personalRiskPolicy): Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set. personalRiskPolicy lets you bound what a trader may choose: json { \\\"personalRiskPolicy\\\": { \\\"dailyLossLimitMax\\\": 1000, \\\"dailyLossLimitDefault\\\": 500, \\\"requireDailyLossLimit\\\": true, \\\"maxTradesPerDayMax\\\": 20, \\\"requireAutoBracket\\\": false, \\\"lockedByFirm\\\": false } } - Every value is a ceiling: a trader may always pick something stricter. - A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank. - requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to \\\"do nothing\\\". - lockedByFirm: true makes the whole personal risk panel read-only; the trader's own API calls are rejected with FIRM_LOCKED. - Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets. Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side. Example rule sets: Standard Challenge (beginner-friendly): - Profit target: $10,000 (10%) - Daily loss: $2,500 (2.5%) - Max drawdown: $5,000 (5%) Aggressive Challenge (experienced traders): - Profit target: $8,000 (8%) - Daily loss: $4,000 (4%) - Max drawdown: $6,000 (6%) Filtering by metadata: http # Find strict rule sets GET /organization/trading-rules?metadata=strict:true # Find rules by version GET /organization/trading-rules?metadata=ruleVersion:2.1 # Find rules for specific markets GET /organization/trading-rules?metadata=market:futures Use cases: - Display rule details on your website - Validate rule IDs before creating accounts - Compare different rule configurations - Audit your risk parameters 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-rules/get-trading-rules-for-your-organization\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization#webpage\"},\"dateModified\":\"2026-11-15T15:41:09.836Z\",\"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-rules/get-trading-rules-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)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trader-bindings/{bindingId}/rebind","href":"/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow"}]},{"group":"Trading plans","pages":[{"title":"Get trading plans for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans","href":"/platform-api/trading-plans/get-trading-plans-for-your-organization"},{"title":"Create a new trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-plans","href":"/platform-api/trading-plans/create-a-new-trading-plan"},{"title":"Get a specific trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/get-a-specific-trading-plan"},{"title":"Delete a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/delete-a-trading-plan"},{"title":"Update a trading plan","description":"Update an existing trading plan. **Admin only**.\n\nOnly provide fields you want to change.\n\n**Example - Update price:**\n```bash\ncurl -X PATCH \"https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"price\": 349}'\n```\n\n**Example - Set the name traders see:**\n```bash\ncurl -X PATCH \".../{planId}\" \\\n -d '{\"displayName\": \"100K Evaluation\"}'\n```\n\n**Example - Deactivate plan:**\n```bash\ncurl -X PATCH \".../{planId}\" \\\n -d '{\"isActive\": false}'\n```\n\n**Example - Change trading rule:**\n```bash\ncurl -X PATCH \".../{planId}\" \\\n -d '{\"tradingRuleId\": \"new-rule-uuid\"}'\n```\n\n**Note:** Existing purchases are not affected by changes. Changes only apply to new purchases.\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `PLAN_NOT_FOUND` | No plan with this ID exists in your organization |\n| `PLAN_NAME_EXISTS` | Another plan already has this name |\n| `RULE_NOT_FOUND` | No trading rule with the new ID exists in your organization |\n| `NO_FIELDS_TO_UPDATE` | No valid fields provided |\n| `ADMIN_REQUIRED` | Only admins can update 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 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","description":"Create a new trading rule for your organization. **Admin only**.\n\n**Required fields:**\n- `name` - Must be unique within your organization\n\n**Optional rule parameters:**\n| Field | Unit | Description | Example |\n|-------|------|-------------|---------|\n| `profitTarget` | $ | Profit target to pass | 4000 |\n| `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 |\n| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |\n| `bestDayStopPct` | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |\n| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |\n| `dailyLoss` | $ | Max loss allowed per day | 1000 |\n| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |\n| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |\n| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |\n| `maxLoss` | $ | Max total loss from starting balance | 2500 |\n| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 2 |\n| `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 |\n| `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent |\n| `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 |\n| `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true |\n| `drawdownType` | | How drawdown is calculated (see below) | trailing |\n| `consistency` | % | Consistency rule (0 = disabled) | 0 |\n| `maxContracts` | count | Max position size in mini-equivalent contracts | 10 |\n| `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 |\n| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\"SIL\": 5} |\n| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\"ES\", \"NQ\"] |\n| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \"09:30\" / \"16:00\" |\n| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \"America/New_York\" |\n| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |\n| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |\n| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |\n| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |\n| `scalingPlan` | | Profit-based contract scaling tiers (see below) | { \"tiers\": [...] } |\n| `metadata` | | Custom organization data | { \"version\": \"1.0\" } |\n\n**Understanding the units:**\n- **Dollar values ($):** `profitTarget`, `dailyProfit`, `maxProfit`, `dailyLoss`, `maxLoss` — these are absolute dollar amounts relative to the account size. E.g., `maxLoss: 2500` means the trader can lose $2,500.\n- **Percentage values (%):** `dailyDrawdown`, `consistency` — always percentages. `maxDrawdown` is a percent by default, but becomes a dollar amount when `drawdownDenomination` is `dollars` (how zero-based sim-funded plans express a $1,000 trailing max loss).\n\n**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**\nRestricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.\n- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.\n- At the session end, open positions are closed and working orders are cancelled.\n- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).\n- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.\n- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.\n\n**Drawdown types (`drawdownType`):**\n| Value | Description |\n|-------|-------------|\n| `static` | Drawdown measured from **initial balance**. Never moves. (default) |\n| `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. |\n| `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. |\n\n**Micro contract conversion (`microConversionRatio`):**\n\n`maxContracts` (and scaling-plan tiers) are denominated in mini-equivalent units. Micro contracts (MES, MNQ, MGC, ...) are converted using the rule set's `microConversionRatio` — how many micros count as **1 unit** toward the limit:\n\n| Ratio | `maxContracts: 10` allows |\n|-------|---------------------------|\n| `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix |\n| `5` | 10 minis or 50 micros |\n| `1` | 10 contracts total — micros count the same as minis |\n\nE-mini and full-size contracts always count as 1 unit each; the ratio only affects micros. Omit the field (or PATCH it to `null`) to use the default 10:1 conversion. Different plans can use different ratios by pointing them at different rule sets. Enforcement is account-wide and real-time in the trade engine.\n\nExample — a plan where 5 micros equal 1 mini:\n```json\n{ \"maxContracts\": 10, \"microConversionRatio\": 5 }\n```\n\n**Scaling plans (`scalingPlan`):**\n\n## Position limits: pick the right field\n\n`maxContracts` counts **engine units** and a rule is not tied to a market, so\none unit is one futures contract but **0.001 BTC** on the Binance perpetual. The\nsame number therefore means different things depending on which account the rule\nbacks. Use `maxPositionByMarket` for anything that is not plain futures:\n\n```json\n{\n \"name\": \"50K BTC Perp\",\n \"maxLoss\": 2000,\n \"dailyLoss\": 1000,\n \"maxPositionByMarket\": { \"BINANCE\": 0.5 }\n}\n```\n\nThat is **half a Bitcoin** — no conversion, no engine units. Rejections quote it\nback the same way:\n\n> Order would exceed the BINANCE position limit on this account: 0.600 BTC\n> requested, limit 0.500 BTC.\n\n| Field | Counts in | Scope | Use for |\n|---|---|---|---|\n| `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract |\n| `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures |\n\nA market named in `maxPositionByMarket` is **not** also gated by\n`maxContracts` — a market gets one limit or the other. Send `null` to clear\nevery per-market limit and put all markets back under `maxContracts`.\n\nInstead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit:\n\n```json\n{\n \"scalingPlan\": {\n \"basis\": \"balance\",\n \"tiers\": [\n { \"profit\": 0, \"maxContracts\": 1 },\n { \"profit\": 1000, \"maxContracts\": 2 },\n { \"profit\": 3000, \"maxContracts\": 5.5 }\n ]\n }\n}\n```\n\n- `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit.\n- Alternatively, tiers can use absolute `balance` thresholds instead of `profit` (all tiers must use the same key). The first tier defines the starting limit — set its threshold at (or below) the account size:\n\n```json\n{\n \"tiers\": [\n { \"balance\": 50000, \"maxContracts\": 1 },\n { \"balance\": 55000, \"maxContracts\": 2 },\n { \"balance\": 60000, \"maxContracts\": 5.5 }\n ]\n}\n```\n\n Note: balance thresholds tie the rule to one account size — a `55000` tier means something very different on a 25K vs 100K account. Profit-based tiers are portable across account sizes; prefer them unless all accounts on this rule share one size.\n- `maxContracts` is in **mini-equivalent** units and supports **0.1 steps**. Micros count as 1/`microConversionRatio` of a mini (default 10), so `5.5` allows 5 minis or 55 micros (e.g. 5 ES or 55 MES) at the default ratio.\n- `basis` controls when tiers activate/deactivate:\n | Value | Behavior |\n |-------|----------|\n | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) |\n | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently |\n- When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`\"scalingPlan\": null` on PATCH) to fall back to the flat limit.\n- Enforced in real time at order placement by the trade engine.\n\n**Consistency rule (`consistency` + related fields):**\n\nCaps how much of a trader's profit may come from a single day. The daily cap is:\n\n```text\ndaily_cap = round(base × consistency%, 2)\n + starting_balance × consistencyTolerancePct%\n + consistencyLeniency\n```\n\nA day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type:\n\n- **Evaluation accounts** — the rule gates *passing*: base defaults to max(profitTarget, totalPnl), and the trader also needs at least `consistencyMinDays` profitable days (default: ceil(100/consistency), so 50% → 2 days). Reaching the profit target with over-concentrated gains does NOT fail the account — it simply stays active until gains are spread out, and the account's `completionPendingReason` explains exactly why.\n- **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`).\n\n**Enforcement is opt-in per rule set** (`consistencyEnforced`, default false — the historical behavior where the consistency % was informational only). Existing accounts are unaffected until you enable it.\n\nExample — a consistency-enforced template: `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyTolerancePct\": 0.2 }` on evaluation rules, and `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40 }` on Builder sim-funded rules.\n\n**Sim-funded accounts — limits are optional per rule set:**\n\nEvery trading limit on a rule set applies to `sim_funded` accounts exactly like evaluations **when set**, and is disabled when `0`/omitted — so you choose per template who enforces funded limits:\n\n- **Platform enforces** (recommended): attach a rule set with real values, e.g. `{ \"dailyLoss\": 1500, \"maxLoss\": 2500, \"maxContracts\": 5, \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40, \"maxPayouts\": 5, \"payoutMllLockOffset\": 100 }` — we enforce limits live, gate payouts on consistency, and fire the webhooks.\n- **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts.\n\n`profitTarget` never completes a sim-funded account — funded accounts withdraw, they don't \"pass\" — so it is safe to reuse an eval-style rule set on funded accounts.\n\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-rules\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Aggressive 100K Challenge\",\n \"description\": \"High risk tolerance for experienced traders\",\n \"profitTarget\": 10000,\n \"maxLoss\": 5000,\n \"maxDrawdown\": 5000,\n \"dailyLoss\": 2500,\n \"maxContracts\": 15,\n \"microConversionRatio\": 5,\n \"metadata\": { \"tier\": \"advanced\", \"version\": \"1.0\" }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `RULE_NAME_EXISTS` | A rule with this name already exists |\n| `ADMIN_REQUIRED` | Only admins can create rules |\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-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 rules 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"]}