Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement.
Subaccount-restricted API keys read only their locked subaccount’s balance, and the response omits the account-wide settled_funds total.
Resource-bound MCP OAuth tokens may read the owner’s balance with read::mcp_portfolio.
Rate limit: 5 tokens per request, or 50 tokens when compute_available_balance=true (the available-balance computation scans all resting orders). See GET /trade-api/v2/account/endpoint_costs for current non-default endpoint costs.
Base64 signature of the pre-sign text (timestamp + method + path) made with the API key's algorithm - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys
Total settled funds across all subaccounts in fixed-point dollars. Omitted when access is restricted to a subaccount.
Example:
"0.5600"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"API Documentation","colors":{"primary":"#00B67A","light":"#00DD94","dark":"#00B67A"},"logo":{"light":"https://mintcdn.com/kalshi-b198743e/koRHzlv9fsyF-jSm/logo-light.svg?fit=max\u0026auto=format\u0026n=koRHzlv9fsyF-jSm\u0026q=85\u0026s=bac849e081bbb1881bb945ea3e0464a8","dark":"https://mintcdn.com/kalshi-b198743e/koRHzlv9fsyF-jSm/logo-dark.svg?fit=max\u0026auto=format\u0026n=koRHzlv9fsyF-jSm\u0026q=85\u0026s=a4da341dfa9fb72cf3f2e94566447d0a"},"favicon":"https://mintcdn.com/kalshi-b198743e/koRHzlv9fsyF-jSm/favicon.png?fit=max\u0026auto=format\u0026n=koRHzlv9fsyF-jSm\u0026q=85\u0026s=292b09f2d750fdddf9861e6d016116dd","api":{"playground":{}},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/kalshi-b198743e/koRHzlv9fsyF-jSm/images/og-background.png?fit=max\u0026auto=format\u0026n=koRHzlv9fsyF-jSm\u0026q=85\u0026s=345c6286bc1878240df49e1dabe7a10f"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kalshi-b198743e","hasAudioNarration":false,"actualSubdomain":"kalshi-b198743e","customDomains":["docs.kalshi.com"],"gitSource":{"type":"github","owner":"kalshi","repo":"exchange-infra","deployBranch":"dev","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af60fff56a3e8a10c944873","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"REST","count":208},{"language":"default","tag":"Predictions APIs","count":153},{"language":"default","tag":"Perps APIs","count":103},{"language":"default","tag":"clearing-members","count":28},{"language":"default","tag":"WebSockets","count":25},{"language":"default","tag":"portfolio","count":25},{"language":"default","tag":"Concepts","count":22},{"language":"default","tag":"FIX","count":20},{"language":"default","tag":"communications","count":20},{"language":"default","tag":"fcm","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"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":"llms-txt-v2","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navigation-items li[id=\"/changelog\"]{display:none}.mcp-tool-tables th:first-child,.mcp-tool-tables td:first-child{width:12rem;min-width:12rem}.mcp-tool-tables code{white-space:nowrap}.docs-home-hero{position:relative;width:100%;height:24rem;overflow:hidden;margin-top:-1px;display:flex;align-items:center;justify-content:center}.docs-home-hero-bg{position:absolute;inset:0;height:24rem;background-size:100%;background-position:center;background-repeat:no-repeat}.docs-home-hero-bg-light{background-image:url(\"https://mintlify-assets.b-cdn.net/kalshi-bg.svg\")}.docs-home-hero-bg-dark{display:none;background-image:url(\"https://mintlify-assets.b-cdn.net/kalshi-dark-bg.svg\")}.dark .docs-home-hero-bg-light{display:none}.dark .docs-home-hero-bg-dark{display:block}.docs-home-hero-content{position:absolute;width:min(45rem, calc(100% - 2rem));padding:0 1rem;text-align:center;color:#000}.dark .docs-home-hero-content{color:#fff}.docs-home-hero-title{margin:0;font-family:Inter, sans-serif;font-size:36px;font-weight:500;line-height:44px}.docs-home-hero-subtitle{margin-top:1rem;font-size:18px;font-weight:400;opacity:0.6}.docs-home-hero-agreement{margin-top:0.75rem;font-size:14px;font-weight:400}.docs-home-hero-agreement span{opacity:0.6}.docs-home-hero-link{color:#00B67A;text-decoration:underline}html.dark .docs-home-hero-link{color:#00DD94}.docs-home-content{max-width:70rem;margin:4rem auto 8rem;padding:0 1.25rem}.docs-home-section-title{margin-top:3.25rem;margin-bottom:1.25rem;font-size:1.75rem;font-weight:650;line-height:2.25rem}.docs-home-section-title:first-child{margin-top:0}"}],"page":{"pagePath":"margin-rest/portfolio/get-balance","slug":"/margin-rest/portfolio/get-balance","pageMetadata":{"title":"Get Balance","description":"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement.\nSubaccount-restricted API keys read only their locked subaccount's balance, and the response omits the account-wide `settled_funds` total.\nResource-bound MCP OAuth tokens may read the owner's balance with read::mcp_portfolio.\n","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/balance","href":"/margin-rest/portfolio/get-balance","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement.\\nSubaccount-restricted API keys read only their locked subaccount’s balance, and the response omits the account-wide \", _jsx(_components.code, {\n children: \"settled_funds\"\n }), \" total.\\nResource-bound MCP OAuth tokens may read the owner’s balance with read::mcp_portfolio.\"]\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};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 5 tokens per request, or 50 tokens when `,_jsx(_components.code,{children:`compute_available_balance=true`}),` (the available-balance computation scans all resting orders). See `,_jsx(_components.code,{children:`GET /trade-api/v2/account/endpoint_costs`}),` for current non-default endpoint costs.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Balance","description":"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement.\nSubaccount-restricted API keys read only their locked subaccount's balance, and the response omits the account-wide `settled_funds` total.\nResource-bound MCP OAuth tokens may read the owner's balance with read::mcp_portfolio.\n","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/balance","href":"/margin-rest/portfolio/get-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"GetMarginBalance","summary":"Get Balance","description":"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement.\nSubaccount-restricted API keys read only their locked subaccount's balance, and the response omits the account-wide `settled_funds` total.\nResource-bound MCP OAuth tokens may read the owner's balance with read::mcp_portfolio.\n","x-mint":{"content":"\u003cNote>\n**Rate limit:** 5 tokens per request, or 50 tokens when `compute_available_balance=true` (the available-balance computation scans all resting orders). See `GET /trade-api/v2/account/endpoint_costs` for current non-default endpoint costs.\n\u003c/Note>\n"},"tags":["portfolio"],"security":["f751f765-0b2c-4381-90b2-b36c1e7d65e2","0457f952-704d-4265-94af-43282f3f7d70"],"parameters":["60cb1a2d-276c-4036-ac6d-284128ddf474"],"responses":{"200":"6c0f22b7-83fb-477a-8935-a28c36c343b2","401":"9af44037-3cdc-4ec1-a146-93141fc8b435","403":"04715be4-2281-4e92-95c8-8b7d6d103675","429":"c4062b75-4e54-46d7-a5b7-f442dcfaf742","500":"928a3448-d9f4-42f2-84ad-fbdd15d63766"},"method":"get","type":"path","servers":["3e38d62e-2d9d-4ef6-9d63-845010426c26","352c1fa0-3531-4ebd-8b7b-6198ca55f826"],"path":"/margin/balance","baseUrlOptions":["https://external-api.kalshi.com/trade-api/v2","https://external-api.demo.kalshi.co/trade-api/v2"],"title":"Get Balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"60cb1a2d-276c-4036-ac6d-284128ddf474":{"name":"compute_available_balance","in":"query","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"When true, computes available_balance per subaccount at an increased rate limit cost. Available balance is 0 when the flag is false or omitted.","uniqueKey":"","typeLabel":"boolean"},"x-go-type-skip-optional-pointer":true,"description":"When true, computes available_balance per subaccount at an increased rate limit cost. Available balance is 0 when the flag is false or omitted."}},"responses":{"6c0f22b7-83fb-477a-8935-a28c36c343b2":{"description":"Margin balance retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["subaccount_balances"],"properties":{"subaccount_balances":{"type":"array","items":{"type":"object","required":["subaccount","subaccount_type","position_value","account_equity","maintenance_margin","initial_margin","resting_orders_margin","available_balance"],"properties":{"subaccount":{"type":"integer","description":"The subaccount number (0 for primary, 1-63 for subaccounts)","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].subaccount","typeLabel":"integer"},"subaccount_type":{"type":"string","enum":["cross","isolated","auto_rebalance","managed_isolated"],"x-enum-varnames":["SubaccountTypeCross","SubaccountTypeIsolated","SubaccountTypeAutoRebalance","SubaccountTypeManagedIsolated"],"description":"How the subaccount is margined. `cross` for the primary account and numbered subaccounts, `isolated` for a market's isolated subaccount, `auto_rebalance` for an auto-rebalanced isolated position, which shares its market's isolated subaccount number, and `managed_isolated` for a managed isolated position, whose subaccount number is its slot number rather than the market's isolated subaccount number.","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].subaccount_type","typeLabel":"enum\u003cstring>"},"position_value":{"type":"string","description":"Mark-to-market value of open positions for this subaccount in fixed-point dollars","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].position_value","typeLabel":"string"},"account_equity":{"type":"string","description":"Account equity for this subaccount in fixed-point dollars. 0 for self clearing members.","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].account_equity","typeLabel":"string"},"maintenance_margin":{"type":"string","description":"Maintenance margin requirement for this subaccount in fixed-point dollars","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].maintenance_margin","typeLabel":"string"},"initial_margin":{"type":"string","description":"Initial margin requirement for this subaccount in fixed-point dollars. 0 for self clearing members.","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].initial_margin","typeLabel":"string"},"resting_orders_margin":{"type":"string","description":"Margin locked by resting orders for this subaccount in fixed-point dollars. 0 unless compute_available_balance is passed.","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].resting_orders_margin","typeLabel":"string"},"available_balance":{"type":"string","description":"Available balance for this subaccount in fixed-point dollars. 0 for institutional users or if compute_available_balance was not passed.","example":"0.5600","isRequired":true,"uniqueKey":"subaccount_balances.items.[INDEX].available_balance","typeLabel":"string"}},"uniqueKey":"subaccount_balances.items.[INDEX]","typeLabel":"object"},"description":"Per-subaccount balance breakdown. Subaccount-restricted API keys receive only their locked subaccount.","isRequired":true,"uniqueKey":"subaccount_balances","typeLabel":"object[]"},"settled_funds":{"type":"string","description":"Total settled funds across all subaccounts in fixed-point dollars. Omitted when access is restricted to a subaccount.","example":"0.5600","uniqueKey":"settled_funds","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subaccount_balances":[{"subaccount":123,"subaccount_type":"cross","position_value":"0.5600","account_equity":"0.5600","maintenance_margin":"0.5600","initial_margin":"0.5600","resting_orders_margin":"0.5600","available_balance":"0.5600"}],"settled_funds":"0.5600"}}},"exampleType":"generated"}},"exampleType":"generated"},"9af44037-3cdc-4ec1-a146-93141fc8b435":{"description":"Unauthorized - authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error, if available","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"04715be4-2281-4e92-95c8-8b7d6d103675":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error, if available","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c4062b75-4e54-46d7-a5b7-f442dcfaf742":{"description":"Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error, if available","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"928a3448-d9f4-42f2-84ad-fbdd15d63766":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error, if available","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f751f765-0b2c-4381-90b2-b36c1e7d65e2":{"kalshiAccessKey":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-KEY","description":"Your API key ID","scopes":[],"schemeName":"kalshiAccessKey"},"kalshiAccessSignature":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-SIGNATURE","description":"Base64 signature of the pre-sign text (timestamp + method + path) made with the API key's algorithm - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys","scopes":[],"schemeName":"kalshiAccessSignature"},"kalshiAccessTimestamp":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-TIMESTAMP","description":"Request timestamp in milliseconds","scopes":[],"schemeName":"kalshiAccessTimestamp"}},"0457f952-704d-4265-94af-43282f3f7d70":{"kalshiOauthAccessToken":{"type":"http","scheme":"bearer","description":"User OAuth access token with read::compliance_partner, issued to an explicitly authorized partner. Accepted only on margin fills and margin positions in this lane; generic read and partner client-credentials tokens do not grant access.","scopes":[],"schemeName":"kalshiOauthAccessToken"}}},"servers":{"3e38d62e-2d9d-4ef6-9d63-845010426c26":{"url":"https://external-api.kalshi.com/trade-api/v2","description":"Production perps REST API server"},"352c1fa0-3531-4ebd-8b7b-6198ca55f826":{"url":"https://external-api.demo.kalshi.co/trade-api/v2","description":"Demo perps REST API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-KEY","description":"Your API key ID","scopes":[],"schemeName":"kalshiAccessKey"},"schema":{"title":"KALSHI-ACCESS-KEY","type":"string","description":"Your API key ID","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"kalshiAccessKey","name":"KALSHI-ACCESS-KEY"},{"scheme":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-SIGNATURE","description":"Base64 signature of the pre-sign text (timestamp + method + path) made with the API key's algorithm - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys","scopes":[],"schemeName":"kalshiAccessSignature"},"schema":{"title":"KALSHI-ACCESS-SIGNATURE","type":"string","description":"Base64 signature of the pre-sign text (timestamp + method + path) made with the API key's algorithm - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"kalshiAccessSignature","name":"KALSHI-ACCESS-SIGNATURE"},{"scheme":{"type":"apiKey","in":"header","name":"KALSHI-ACCESS-TIMESTAMP","description":"Request timestamp in milliseconds","scopes":[],"schemeName":"kalshiAccessTimestamp"},"schema":{"title":"KALSHI-ACCESS-TIMESTAMP","type":"string","description":"Request timestamp in milliseconds","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"kalshiAccessTimestamp","name":"KALSHI-ACCESS-TIMESTAMP"}],"title":"kalshiAccessKey \u0026 kalshiAccessSignature \u0026 kalshiAccessTimestamp"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"User OAuth access token with read::compliance_partner, issued to an explicitly authorized partner. Accepted only on margin fills and margin positions in this lane; generic read and partner client-credentials tokens do not grant access.","scopes":[],"schemeName":"kalshiOauthAccessToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User OAuth access token with read::compliance_partner, issued to an explicitly authorized partner. Accepted only on margin fills and margin positions in this lane; generic read and partner client-credentials tokens do not grant access.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"kalshiOauthAccessToken","name":"Authorization"}],"title":"kalshiOauthAccessToken"}]},"originalFileLocation":"perps_openapi.yaml"},"subdomain":"kalshi-b198743e","siteName":"API Documentation","title":"Get Balance - API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T19:14:25.072Z","originalFileLocation":"margin-rest/portfolio/get-balance.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=\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement. Subaccount-restricted API keys read only their locked subaccount\u0026#x27;s balance, and the response omits the account-wide settled_funds total. Resource-bound MCP OAuth tokens may read the owner\u0026#x27;s balance with read::mcp_portfolio.\">\u003cmeta data-mint-head name=\"application-name\" content=\"API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_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/kalshi-b198743e/_UdUeym1J95PnKJ_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Balance - API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement. Subaccount-restricted API keys read only their locked subaccount\u0026#x27;s balance, and the response omits the account-wide settled_funds total. Resource-bound MCP OAuth tokens may read the owner\u0026#x27;s balance with read::mcp_portfolio.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kalshi.com/margin-rest/portfolio/get-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kalshi-b198743e.mintlify.site/_mintlify/api/og/v2?division=portfolio\u0026amp;title=Get+Balance\u0026amp;description=Endpoint+for+retrieving+the+balance+breakdown+for+the+authenticated+direct+margin+user.+Returns+cash+balance+%28aggregate+and+per-subaccount%29%2C+position+value%2C+tot\u0026amp;theme=7930e9e5ad96f557800076a6\u0026amp;signature=032aa8db64cf032f844e33c3a6820b9be7d89722078c989d7c0793ac85764989\">\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 Balance - API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement. Subaccount-restricted API keys read only their locked subaccount\u0026#x27;s balance, and the response omits the account-wide settled_funds total. Resource-bound MCP OAuth tokens may read the owner\u0026#x27;s balance with read::mcp_portfolio.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kalshi-b198743e.mintlify.site/_mintlify/api/og/v2?division=portfolio\u0026amp;title=Get+Balance\u0026amp;description=Endpoint+for+retrieving+the+balance+breakdown+for+the+authenticated+direct+margin+user.+Returns+cash+balance+%28aggregate+and+per-subaccount%29%2C+position+value%2C+tot\u0026amp;theme=7930e9e5ad96f557800076a6\u0026amp;signature=032aa8db64cf032f844e33c3a6820b9be7d89722078c989d7c0793ac85764989\">\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/kalshi-b198743e/_UdUeym1J95PnKJ_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B67A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kalshi.com/margin-rest/portfolio/get-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/margin-rest/portfolio/get-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kalshi.com/#organization\",\"name\":\"API Documentation\",\"url\":\"https://docs.kalshi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kalshi-b198743e/koRHzlv9fsyF-jSm/logo-light.svg?fit=max\u0026auto=format\u0026n=koRHzlv9fsyF-jSm\u0026q=85\u0026s=bac849e081bbb1881bb945ea3e0464a8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kalshi.com#website\",\"name\":\"API Documentation\",\"url\":\"https://docs.kalshi.com\",\"publisher\":{\"@id\":\"https://docs.kalshi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance#webpage\",\"url\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance\",\"name\":\"Get Balance\",\"description\":\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement. Subaccount-restricted API keys read only their locked subaccount's balance, and the response omits the account-wide settled_funds total. Resource-bound MCP OAuth tokens may read the owner's balance with read::mcp_portfolio.\",\"dateModified\":\"2026-11-12T19:14:25.072Z\",\"isPartOf\":{\"@id\":\"https://docs.kalshi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST\",\"item\":\"https://docs.kalshi.com/api-reference/get-margin-reports\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"portfolio\",\"item\":\"https://docs.kalshi.com/margin-rest/portfolio/get-fills\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Balance\",\"item\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance#apireference\",\"headline\":\"Get Balance\",\"name\":\"Get Balance\",\"description\":\"Endpoint for retrieving the balance breakdown for the authenticated direct margin user. Returns cash balance (aggregate and per-subaccount), position value, total balance, and maintenance margin requirement. Subaccount-restricted API keys read only their locked subaccount's balance, and the response omits the account-wide settled_funds total. Resource-bound MCP OAuth tokens may read the owner's balance with read::mcp_portfolio.\",\"url\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kalshi.com/margin-rest/portfolio/get-balance#webpage\"},\"dateModified\":\"2026-11-12T19:14:25.072Z\",\"publisher\":{\"@id\":\"https://docs.kalshi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kalshi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/margin-rest/portfolio/get-balance.md","siteName":"API Documentation","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/welcome"}]},{"tab":"Quick Start","pages":[{"title":"Quick Start","href":"/getting_started/api_environments"}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/getting_started/making_your_first_request"}]},{"tab":"Predictions APIs","pages":[{"title":"Predictions APIs","href":"/cfbenchmarks/rest-passthrough"}]},{"tab":"Perps APIs","pages":[{"group":"Overview","pages":[{"title":"Perps API","href":"/margin"},{"title":"Price Banding","href":"/margin/price-banding"},{"title":"Corporate Actions","href":"/margin/corporate-actions"}]},{"group":"REST","pages":[{"group":"clearing-members","pages":[{"title":"Get Margin Reports","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/reports","href":"/api-reference/get-margin-reports"},{"title":"Get Active Margin Obligations","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/active_obligations","href":"/api-reference/get-active-margin-obligations"},{"title":"Get Obligation History","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/obligation_history","href":"/api-reference/get-obligation-history"},{"title":"Get Obligation Settlement Details","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/obligations/{obligation_id}/settlement_details","href":"/api-reference/get-obligation-settlement-details"},{"title":"Get Obligation Funding Payments","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/obligations/{obligation_id}/funding_payments","href":"/api-reference/get-obligation-funding-payments"},{"title":"Get Obligation Corporate Action Payments","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/obligations/{obligation_id}/corporate_action_payments","href":"/api-reference/get-obligation-corporate-action-payments"},{"title":"Get Obligation Maintenance Margin Details","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/obligations/{obligation_id}/maintenance_margin_details","href":"/api-reference/get-obligation-maintenance-margin-details"},{"title":"Get Member Funding Payments","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/funding_payments","href":"/api-reference/get-member-funding-payments"},{"title":"Get Large Trader Positions","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/large_trader_positions","href":"/api-reference/get-large-trader-positions"},{"title":"Estimate Portfolio Maintenance Margin","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml post /margin/estimate_maintenance_margin","href":"/api-reference/estimate-portfolio-maintenance-margin"},{"title":"Get Maintenance Margin Metadata","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/estimate_maintenance_margin/metadata","href":"/api-reference/get-maintenance-margin-metadata"},{"title":"Get Settlement Estimate By Asset Class","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/settlement_estimate_by_asset_class","href":"/api-reference/get-settlement-estimate-by-asset-class"},{"title":"Get Funding Estimate By Asset Class","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/funding_estimate_by_asset_class","href":"/api-reference/get-funding-estimate-by-asset-class"},{"title":"Get Funding Schedule","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/funding_schedule","href":"/api-reference/get-funding-schedule"},{"title":"Get Settlement Prices","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/settlement_prices","href":"/api-reference/get-settlement-prices"},{"title":"Get Settlement Balance","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/settlement_balance","href":"/api-reference/get-settlement-balance"},{"title":"Get Guaranty Fund Balance","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/guaranty_fund_balance","href":"/api-reference/get-guaranty-fund-balance"},{"title":"Get Settlement Balance History","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/settlement_balance_history","href":"/api-reference/get-settlement-balance-history"},{"title":"Withdraw Settlement Balance","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml post /margin/settlement_balance_withdrawal","href":"/api-reference/withdraw-settlement-balance"},{"title":"Get Settlement Balance Withdrawal","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /margin/settlement_balance_withdrawal","href":"/api-reference/get-settlement-balance-withdrawal"},{"title":"Get Subtrader Groups","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /fcm/margin/subtrader_groups","href":"/api-reference/get-subtrader-groups"},{"title":"Create Subtrader Group","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml post /fcm/margin/subtrader_groups","href":"/api-reference/create-subtrader-group"},{"title":"Update Subtrader Group","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml put /fcm/margin/subtrader_groups/{group_id}","href":"/api-reference/update-subtrader-group"},{"title":"Delete Subtrader Group","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml delete /fcm/margin/subtrader_groups/{group_id}","href":"/api-reference/delete-subtrader-group"},{"title":"Create Subtrader-Bound API Key","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml post /fcm/margin/api_keys","href":"/api-reference/create-subtrader-bound-api-key"},{"title":"List Subtrader-Bound API Keys","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml get /fcm/margin/api_keys","href":"/api-reference/list-subtrader-bound-api-keys"},{"title":"Generate Subtrader-Bound API Key","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml post /fcm/margin/api_keys/generate","href":"/api-reference/generate-subtrader-bound-api-key"},{"title":"Delete Subtrader-Bound API Key","deprecated":null,"version":null,"openapi":"/perps_scm_openapi.yaml delete /fcm/margin/api_keys/{api_key_id}","href":"/api-reference/delete-subtrader-bound-api-key"}]},{"group":"corporate-actions","pages":[{"title":"Get Margin Corporate Actions","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/corporate_actions","href":"/margin-rest/corporate-actions/get-margin-corporate-actions"}]},{"group":"fcm","pages":[{"title":"Create Margin FCM Subtrader","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/fcm/subtraders","href":"/margin-rest/fcm/create-margin-fcm-subtrader"},{"title":"Get FCM Subtrader Risk Controls","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/fcm/subtraders/risk_controls","href":"/margin-rest/fcm/get-fcm-subtrader-risk-controls"},{"title":"Update FCM Subtrader Risk Controls","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/fcm/subtraders/risk_controls","href":"/margin-rest/fcm/update-fcm-subtrader-risk-controls"},{"title":"Delete FCM Subtrader Risk Controls","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/fcm/subtraders/risk_controls","href":"/margin-rest/fcm/delete-fcm-subtrader-risk-controls"},{"title":"Create Margin FCM Position Transfer","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/fcm/positions/transfers","href":"/margin-rest/fcm/create-margin-fcm-position-transfer"},{"title":"Update FCM Notional Risk Limit","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/fcm/notional_risk_limit","href":"/margin-rest/fcm/update-fcm-notional-risk-limit"},{"title":"Delete FCM Notional Risk Limit","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/fcm/notional_risk_limit","href":"/margin-rest/fcm/delete-fcm-notional-risk-limit"}]},{"group":"account","pages":[{"title":"Get Perps Account API Limits","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /account/limits/perps","href":"/margin-rest/account/get-perps-account-api-limits"}]},{"group":"exchange","pages":[{"title":"Get Exchange Status","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/exchange/status","href":"/margin-rest/exchange/get-exchange-status"},{"title":"Get Enabled Status","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/enabled","href":"/margin-rest/exchange/get-enabled-status"}]},{"group":"risk","pages":[{"title":"Get Risk Parameters","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/risk_parameters","href":"/margin-rest/risk/get-risk-parameters"},{"title":"Get Notional Risk Limit","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/notional_risk_limit","href":"/margin-rest/risk/get-notional-risk-limit"},{"title":"Get Risk","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/risk","href":"/margin-rest/risk/get-risk"}]},{"group":"orders","pages":[{"title":"Get Orders","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/orders","href":"/margin-rest/orders/get-orders"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/orders","href":"/margin-rest/orders/create-order"},{"title":"Cancel All Orders","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/orders","href":"/margin-rest/orders/cancel-all-orders"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/orders/{order_id}","href":"/margin-rest/orders/get-order"},{"title":"Cancel Order","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/orders/{order_id}","href":"/margin-rest/orders/cancel-order"},{"title":"Decrease Order","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/orders/{order_id}/decrease","href":"/margin-rest/orders/decrease-order"},{"title":"Amend Order","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/orders/{order_id}/amend","href":"/margin-rest/orders/amend-order"}]},{"group":"market","pages":[{"title":"Get Markets","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets","href":"/margin-rest/market/get-markets"},{"title":"Get Market Schedules","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets/schedules","href":"/margin-rest/market/get-market-schedules"},{"title":"Get Multiple Market Orderbooks","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets/orderbooks","href":"/margin-rest/market/get-multiple-market-orderbooks"},{"title":"Get Market","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets/{ticker}","href":"/margin-rest/market/get-market"},{"title":"Get Market Orderbook","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets/{ticker}/orderbook","href":"/margin-rest/market/get-market-orderbook"},{"title":"Get Market Candlesticks","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/markets/{ticker}/candlesticks","href":"/margin-rest/market/get-market-candlesticks"},{"title":"Get Trades","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/trades","href":"/margin-rest/market/get-trades"}]},{"group":"portfolio","pages":[{"title":"Get Fills","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/fills","href":"/margin-rest/portfolio/get-fills"},{"title":"Get Positions","description":"Endpoint for retrieving the authenticated user's margin positions.\nResource-bound MCP OAuth tokens may read the owner's data with read::mcp_portfolio.\nRegistered partners may also use a user OAuth access token with the explicitly granted read::compliance_partner scope.\n","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/positions","href":"/margin-rest/portfolio/get-positions"},{"title":"Get Balance","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/balance","href":"/margin-rest/portfolio/get-balance"},{"title":"Intra Account Transfer","description":"Endpoint for transferring funds within the same account.","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /portfolio/intra_exchange_instance_transfer","href":"/margin-rest/portfolio/intra-account-transfer"},{"title":"Create Subaccount","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /portfolio/margin/subaccounts","href":"/margin-rest/portfolio/create-subaccount"},{"title":"Transfer Between Subaccounts","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /portfolio/margin/subaccounts/transfer","href":"/margin-rest/portfolio/transfer-between-subaccounts"}]},{"group":"fees","pages":[{"title":"Get Fee Tiers","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/fee_tiers","href":"/margin-rest/fees/get-fee-tiers"},{"title":"Get Fee Tier Rates","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/fee_tier_rates","href":"/margin-rest/fees/get-fee-tier-rates"}]},{"group":"funding","pages":[{"title":"Get Funding History","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/funding_history","href":"/margin-rest/funding/get-funding-history"},{"title":"Get Historical Funding Rates","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/funding_rates/historical","href":"/margin-rest/funding/get-historical-funding-rates"},{"title":"Get Funding Rate Estimate","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/funding_rates/estimate","href":"/margin-rest/funding/get-funding-rate-estimate"},{"title":"Get Premium Index","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/funding_rates/premium_index","href":"/margin-rest/funding/get-premium-index"}]},{"group":"order-groups","pages":[{"title":"Get Order Groups","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/order_groups","href":"/margin-rest/order-groups/get-order-groups"},{"title":"Create Order Group","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml post /margin/order_groups/create","href":"/margin-rest/order-groups/create-order-group"},{"title":"Get Order Group","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/order_groups/{order_group_id}","href":"/margin-rest/order-groups/get-order-group"},{"title":"Delete Order Group","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/order_groups/{order_group_id}","href":"/margin-rest/order-groups/delete-order-group"},{"title":"Reset Order Group","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/order_groups/{order_group_id}/reset","href":"/margin-rest/order-groups/reset-order-group"},{"title":"Trigger Order Group","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/order_groups/{order_group_id}/trigger","href":"/margin-rest/order-groups/trigger-order-group"},{"title":"Update Order Group Limit","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/order_groups/{order_group_id}/limit","href":"/margin-rest/order-groups/update-order-group-limit"}]},{"group":"exit-triggers","pages":[{"title":"Get Isolated Exit Triggers","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/isolated/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/get-isolated-exit-triggers"},{"title":"Set Isolated Exit Trigger","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/isolated/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/set-isolated-exit-trigger"},{"title":"Cancel Isolated Exit Trigger","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/isolated/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/cancel-isolated-exit-trigger"},{"title":"Get Cross Exit Triggers","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml get /margin/cross/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/get-cross-exit-triggers"},{"title":"Set Cross Exit Trigger","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/cross/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/set-cross-exit-trigger"},{"title":"Cancel Cross Exit Triggers","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/cross/positions/{ticker}/exit_trigger","href":"/margin-rest/exit-triggers/cancel-cross-exit-triggers"},{"title":"Update Cross Exit Trigger","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml put /margin/cross/positions/{ticker}/exit_trigger/{trigger_id}","href":"/margin-rest/exit-triggers/update-cross-exit-trigger"},{"title":"Cancel Cross Exit Trigger by ID","deprecated":null,"version":null,"openapi":"/perps_openapi.yaml delete /margin/cross/positions/{ticker}/exit_trigger/{trigger_id}","href":"/margin-rest/exit-triggers/cancel-cross-exit-trigger-by-id"}]}]},{"group":"WebSockets","pages":[{"title":"WebSocket Connection","asyncapi":"perps_asyncapi.yaml root","href":"/margin-ws/websockets/websocket-connection"},{"title":"Connection Keep-Alive","asyncapi":"perps_asyncapi.yaml control_frames","href":"/margin-ws/websockets/connection-keep-alive"},{"title":"Orderbook Updates","asyncapi":"perps_asyncapi.yaml orderbook_delta","href":"/margin-ws/websockets/orderbook-updates"},{"title":"Market Ticker","asyncapi":"perps_asyncapi.yaml ticker","href":"/margin-ws/websockets/market-ticker"},{"title":"Public Trades","asyncapi":"perps_asyncapi.yaml trade","href":"/margin-ws/websockets/public-trades"},{"title":"User Fills","asyncapi":"perps_asyncapi.yaml fill","href":"/margin-ws/websockets/user-fills"},{"title":"User Orders","asyncapi":"perps_asyncapi.yaml user_orders","href":"/margin-ws/websockets/user-orders"},{"title":"Order Group Updates","asyncapi":"perps_asyncapi.yaml order_group_updates","href":"/margin-ws/websockets/order-group-updates"},{"title":"Market Lifecycle","asyncapi":"perps_asyncapi.yaml market_lifecycle_v2","href":"/margin-ws/websockets/market-lifecycle"}]},{"group":"FIX","pages":[{"title":"Connectivity","icon":"network-wired","href":"/fix-margin/connectivity"},{"title":"Authentication \u0026 Sessions","icon":"key","href":"/fix-margin/authentication"},{"title":"Order Entry","icon":"cart-plus","href":"/fix-margin/order-entry"},{"title":"Order Groups","icon":"layer-group","href":"/fix-margin/order-groups"},{"title":"Market Data","icon":"chart-line","href":"/fix-margin/market-data"},{"title":"Drop Copy Session","icon":"copy","href":"/fix-margin/drop-copy"},{"title":"Listener Sessions","icon":"headphones","href":"/fix-margin/listener-sessions"},{"title":"Error Handling","icon":"triangle-exclamation","href":"/fix-margin/error-handling"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get Balance - API Documentation","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}