Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the ‘read::portfolio_balance’ scope.
For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing.
Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.
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
Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.
Member's available balance as a fixed-point dollar string for the requested account and exchange index. It includes all exchange indexes when exchange_index is omitted.
Balance for every exchange index, summed across all subaccounts, including zero balances. Unaffected by the subaccount and exchange_index parameters. Omitted when access is restricted to a subaccount.
Show child attributes
{"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":"api-reference/portfolio/get-balance","slug":"/api-reference/portfolio/get-balance","pageMetadata":{"title":"Get Balance","description":"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.\n\nFor per-subaccount balances, use `GET /portfolio/subaccounts/balances`. It returns existing subaccount and exchange index pairs, so its entry count can differ from `balance_breakdown`. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing.\n\n**Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/balance","href":"/api-reference/portfolio/get-balance","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 p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless \", _jsx(_components.code, {\n children: \"exchange_index\"\n }), \" is provided. Pass \", _jsx(_components.code, {\n children: \"subaccount\"\n }), \" to use a subaccount instead of the primary account. This endpoint also accepts API keys with the ‘read::portfolio_balance’ scope.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For per-subaccount balances, use \", _jsx(_components.code, {\n children: \"GET /portfolio/subaccounts/balances\"\n }), \". It returns existing subaccount and exchange index pairs, so its entry count can differ from \", _jsx(_components.code, {\n children: \"balance_breakdown\"\n }), \". The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limit:\"\n }), \" this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it \", _jsx(_components.strong, {\n children: \"1 time per second\"\n }), \"; all higher tiers may call it \", _jsx(_components.strong, {\n children: \"5 times per second\"\n }), \". The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\"]\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};\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 Balance","description":"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.\n\nFor per-subaccount balances, use `GET /portfolio/subaccounts/balances`. It returns existing subaccount and exchange index pairs, so its entry count can differ from `balance_breakdown`. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing.\n\n**Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/balance","href":"/api-reference/portfolio/get-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"GetBalance","summary":"Get Balance","description":"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless `exchange_index` is provided. Pass `subaccount` to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.\n\nFor per-subaccount balances, use `GET /portfolio/subaccounts/balances`. It returns existing subaccount and exchange index pairs, so its entry count can differ from `balance_breakdown`. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing.\n\n**Rate limit:** this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it **1 time per second**; all higher tiers may call it **5 times per second**. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\n","tags":["portfolio"],"security":["988c3023-5e37-473d-b07c-26151b7e416a"],"parameters":["9228ba0c-ccbb-4754-90fc-6d66852d04bd","8381c373-3628-4dd8-aae9-017142196e4c"],"responses":{"200":"22f067e9-4476-4e75-a771-13cdcb93a9d0","401":"d03a5dfe-630b-44ad-9327-ecba228be67a","500":"a9ccd8ba-b5cc-4ee1-9ec1-acb4906ce3ec"},"method":"get","type":"path","servers":["97068fb7-876c-4b73-a187-7dfab910cddb","48af83e7-4b37-443a-8566-7f88157b3412","59f67a71-f95d-4893-85de-a7edd01189af","c75a253b-2166-4b82-80fb-eab3b1afccab"],"path":"/portfolio/balance","baseUrlOptions":["https://external-api.kalshi.com/trade-api/v2","https://api.elections.kalshi.com/trade-api/v2","https://external-api.demo.kalshi.co/trade-api/v2","https://demo-api.kalshi.co/trade-api/v2"],"title":"Get Balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9228ba0c-ccbb-4754-90fc-6d66852d04bd":{"name":"subaccount","in":"query","required":false,"description":"Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.","schema":{"type":"integer","minimum":0,"isRequired":false,"description":"Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.","uniqueKey":"","typeLabel":"integer"}},"8381c373-3628-4dd8-aae9-017142196e4c":{"name":"exchange_index","in":"query","schema":{"type":"integer","description":"Exchange index used to scope the balance and portfolio value. If omitted, both include all exchange indexes.\nIdentifier for an exchange shard.","example":0,"uniqueKey":"","typeLabel":"integer"},"description":"Exchange index used to scope the balance and portfolio value. If omitted, both include all exchange indexes."}},"responses":{"22f067e9-4476-4e75-a771-13cdcb93a9d0":{"description":"Balance retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["balance","balance_dollars","portfolio_value","updated_ts"],"properties":{"balance":{"type":"integer","format":"int64","description":"Member's available balance in cents for the requested account and exchange index. It includes all exchange indexes when `exchange_index` is omitted.","isRequired":true,"uniqueKey":"balance","typeLabel":"integer\u003cint64>"},"balance_dollars":{"type":"string","description":"Member's available balance as a fixed-point dollar string for the requested account and exchange index. It includes all exchange indexes when `exchange_index` is omitted.","example":"0.5600","isRequired":true,"uniqueKey":"balance_dollars","typeLabel":"string"},"portfolio_value":{"type":"integer","format":"int64","description":"Member's portfolio value in cents for the requested account and exchange index. It includes all exchange indexes when `exchange_index` is omitted.","isRequired":true,"uniqueKey":"portfolio_value","typeLabel":"integer\u003cint64>"},"updated_ts":{"type":"integer","format":"int64","description":"Unix timestamp of the last update to the balance.","isRequired":true,"uniqueKey":"updated_ts","typeLabel":"integer\u003cint64>"},"balance_breakdown":{"type":"array","items":{"type":"object","required":["exchange_index","balance"],"properties":{"exchange_index":{"type":"integer","description":"Identifier for an exchange shard.","example":0,"isRequired":true,"uniqueKey":"balance_breakdown.items.[INDEX].exchange_index","typeLabel":"integer"},"balance":{"type":"string","description":"Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., \"0.56\", \"0.5600\"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.","example":"0.5600","isRequired":true,"uniqueKey":"balance_breakdown.items.[INDEX].balance","typeLabel":"string"}},"uniqueKey":"balance_breakdown.items.[INDEX]","typeLabel":"object"},"description":"Balance for every exchange index, summed across all subaccounts, including zero balances. Unaffected by the `subaccount` and `exchange_index` parameters. Omitted when access is restricted to a subaccount.","uniqueKey":"balance_breakdown","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"balance":123,"balance_dollars":"0.5600","portfolio_value":123,"updated_ts":123,"balance_breakdown":[{"exchange_index":0,"balance":"0.5600"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"d03a5dfe-630b-44ad-9327-ecba228be67a":{"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"},"a9ccd8ba-b5cc-4ee1-9ec1-acb4906ce3ec":{"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":{"988c3023-5e37-473d-b07c-26151b7e416a":{"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"}}},"servers":{"97068fb7-876c-4b73-a187-7dfab910cddb":{"url":"https://external-api.kalshi.com/trade-api/v2","description":"Production Trade API server"},"48af83e7-4b37-443a-8566-7f88157b3412":{"url":"https://api.elections.kalshi.com/trade-api/v2","description":"Production shared API server, also supported"},"59f67a71-f95d-4893-85de-a7edd01189af":{"url":"https://external-api.demo.kalshi.co/trade-api/v2","description":"Demo Trade API server"},"c75a253b-2166-4b82-80fb-eab3b1afccab":{"url":"https://demo-api.kalshi.co/trade-api/v2","description":"Demo shared API server, also supported"}},"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"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"kalshi-b198743e","siteName":"API Documentation","title":"Get Balance - API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T19:14:23.712Z","originalFileLocation":"api-reference/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=\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the \u0026#x27;read::portfolio_balance\u0026#x27; scope. For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing. Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\">\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=\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the \u0026#x27;read::portfolio_balance\u0026#x27; scope. For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing. Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kalshi.com/api-reference/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=Returns+the+balance+and+portfolio+value+for+a+member.+Both+values+include+all+exchange+indexes+unless+%60exchange_index%60+is+provided.+Pass+%60subaccount%60+to+use+a+s\u0026amp;theme=7930e9e5ad96f557800076a6\u0026amp;signature=cc12fd3ba0db9774e7f2e6ed92c0b7ab0672876a8f25f8c89710f3515ba3f6a3\">\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=\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the \u0026#x27;read::portfolio_balance\u0026#x27; scope. For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing. Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\">\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=Returns+the+balance+and+portfolio+value+for+a+member.+Both+values+include+all+exchange+indexes+unless+%60exchange_index%60+is+provided.+Pass+%60subaccount%60+to+use+a+s\u0026amp;theme=7930e9e5ad96f557800076a6\u0026amp;signature=cc12fd3ba0db9774e7f2e6ed92c0b7ab0672876a8f25f8c89710f3515ba3f6a3\">\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/api-reference/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=\"/api-reference/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/api-reference/portfolio/get-balance#webpage\",\"url\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance\",\"name\":\"Get Balance\",\"description\":\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope. For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing. Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\",\"dateModified\":\"2026-11-12T19:14:23.712Z\",\"isPartOf\":{\"@id\":\"https://docs.kalshi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST\",\"item\":\"https://docs.kalshi.com/cfbenchmarks/rest-passthrough\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Balance\",\"item\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance#apireference\",\"headline\":\"Get Balance\",\"name\":\"Get Balance\",\"description\":\"Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope. For per-subaccount balances, use GET /portfolio/subaccounts/balances. It returns existing subaccount and exchange index pairs, so its entry count can differ from balance_breakdown. The breakdown uses portfolio valuation snapshots; separate requests may reflect different stages of transfer processing. Rate limit: this endpoint has its own bucket, separate from the Read budget. Basic and Advanced tiers may call it 1 time per second; all higher tiers may call it 5 times per second. The bucket holds one second of budget, so there is no burst. Calls to this endpoint do not draw down the Read budget, and other reads do not draw down this bucket. Balance only changes on fills, settlements and transfers, so react to those (for example the user fills websocket channel) instead of polling this endpoint.\",\"url\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kalshi.com/api-reference/portfolio/get-balance#webpage\"},\"dateModified\":\"2026-11-12T19:14:23.712Z\",\"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":"/api-reference/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","groups":[{"group":"REST","pages":[{"title":"CF Benchmarks REST Passthrough","href":"/cfbenchmarks/rest-passthrough"},{"group":"exchange","pages":[{"title":"Get Exchange Status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange/status","href":"/api-reference/exchange/get-exchange-status"},{"title":"Get Series Fee Changes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series/fee_changes","href":"/api-reference/exchange/get-series-fee-changes"},{"title":"Get Exchange Schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange/schedule","href":"/api-reference/exchange/get-exchange-schedule"},{"title":"Get User Data Timestamp","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange/user_data_timestamp","href":"/api-reference/exchange/get-user-data-timestamp"}]},{"group":"market","pages":[{"title":"Get Market Candlesticks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series/{series_ticker}/markets/{ticker}/candlesticks","href":"/api-reference/market/get-market-candlesticks"},{"title":"Get Trades","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets/trades","href":"/api-reference/market/get-trades"},{"title":"Get Market Orderbook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets/{ticker}/orderbook","href":"/api-reference/market/get-market-orderbook"},{"title":"Get Multiple Market Orderbooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets/orderbooks","href":"/api-reference/market/get-multiple-market-orderbooks"},{"title":"Get Series","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series/{series_ticker}","href":"/api-reference/market/get-series"},{"title":"Get Series List","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series","href":"/api-reference/market/get-series-list"},{"title":"Get Markets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets","href":"/api-reference/market/get-markets"},{"title":"Get Market","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets/{ticker}","href":"/api-reference/market/get-market"},{"title":"Batch Get Market Candlesticks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /markets/candlesticks","href":"/api-reference/market/batch-get-market-candlesticks"}]},{"group":"events","pages":[{"title":"Get Event Candlesticks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series/{series_ticker}/events/{ticker}/candlesticks","href":"/api-reference/events/get-event-candlesticks"},{"title":"Get Events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events","href":"/api-reference/events/get-events"},{"title":"Get Multivariate Events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events/multivariate","href":"/api-reference/events/get-multivariate-events"},{"title":"Get Event Fee Changes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events/fee_changes","href":"/api-reference/events/get-event-fee-changes"},{"title":"Get Event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events/{event_ticker}","href":"/api-reference/events/get-event"},{"title":"Get Event Metadata","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events/{event_ticker}/metadata","href":"/api-reference/events/get-event-metadata"},{"title":"Get Event Forecast Percentile History","deprecated":null,"version":null,"openapi":"/openapi.yaml get /series/{series_ticker}/events/{ticker}/forecast_percentile_history","href":"/api-reference/events/get-event-forecast-percentile-history"}]},{"group":"orders","pages":[{"title":"Get Orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/orders","href":"/api-reference/orders/get-orders"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/orders/{order_id}","href":"/api-reference/orders/get-order"},{"title":"Get Queue Positions for Orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/orders/queue_positions","href":"/api-reference/orders/get-queue-positions-for-orders"},{"title":"Get Order Queue Position","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/orders/{order_id}/queue_position","href":"/api-reference/orders/get-order-queue-position"},{"title":"Create Order (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/events/orders","href":"/api-reference/orders/create-order-v2"},{"title":"Cancel All Orders","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /portfolio/events/orders","href":"/api-reference/orders/cancel-all-orders"},{"title":"Batch Create Orders (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/events/orders/batched","href":"/api-reference/orders/batch-create-orders-v2"},{"title":"Batch Cancel Orders (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /portfolio/events/orders/batched","href":"/api-reference/orders/batch-cancel-orders-v2"},{"title":"Cancel Order (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /portfolio/events/orders/{order_id}","href":"/api-reference/orders/cancel-order-v2"},{"title":"Amend Order (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/events/orders/{order_id}/amend","href":"/api-reference/orders/amend-order-v2"},{"title":"Decrease Order (V2)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/events/orders/{order_id}/decrease","href":"/api-reference/orders/decrease-order-v2"}]},{"group":"order-groups","pages":[{"title":"Get Order Groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/order_groups","href":"/api-reference/order-groups/get-order-groups"},{"title":"Create Order Group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/order_groups/create","href":"/api-reference/order-groups/create-order-group"},{"title":"Get Order Group","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/order_groups/{order_group_id}","href":"/api-reference/order-groups/get-order-group"},{"title":"Delete Order Group","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /portfolio/order_groups/{order_group_id}","href":"/api-reference/order-groups/delete-order-group"},{"title":"Reset Order Group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /portfolio/order_groups/{order_group_id}/reset","href":"/api-reference/order-groups/reset-order-group"},{"title":"Trigger Order Group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /portfolio/order_groups/{order_group_id}/trigger","href":"/api-reference/order-groups/trigger-order-group"},{"title":"Update Order Group Limit","description":" Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.","deprecated":null,"version":null,"openapi":"/openapi.yaml put /portfolio/order_groups/{order_group_id}/limit","href":"/api-reference/order-groups/update-order-group-limit"}]},{"group":"portfolio","pages":[{"title":"Get Balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/balance","href":"/api-reference/portfolio/get-balance"},{"title":"Intra Account Transfer","description":"Transfers funds within the same account.\n\nSubaccount-restricted API keys can only transfer between `event_contract` exchange indices, with `source_subaccount` and `destination_subaccount` both set to the key's subaccount.\n\nWhen `source_exchange_shard` and `destination_exchange_shard` are the same, Kalshi treats the request as a subaccount transfer. The returned transfer ID appears in the subaccount transfer history.\n\nCross-exchange-index subaccount transfers run in up to three non-atomic steps. If a later step fails, completed steps are not undone, so funds may remain in the primary account on the source or destination exchange index.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/intra_exchange_instance_transfer","href":"/api-reference/portfolio/intra-account-transfer"},{"title":"Get Intra Account Transfers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/intra_exchange_instance_transfers","href":"/api-reference/portfolio/get-intra-account-transfers"},{"title":"Get Intra Account Transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/intra_exchange_instance_transfers/{transfer_id}","href":"/api-reference/portfolio/get-intra-account-transfer"},{"title":"Create Subaccount","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/subaccounts","href":"/api-reference/portfolio/create-subaccount"},{"title":"Transfer Between Subaccounts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/subaccounts/transfer","href":"/api-reference/portfolio/transfer-between-subaccounts"},{"title":"Get All Subaccount Balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/subaccounts/balances","href":"/api-reference/portfolio/get-all-subaccount-balances"},{"title":"Get Subaccount Transfers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/subaccounts/transfers","href":"/api-reference/portfolio/get-subaccount-transfers"},{"title":"Get Subaccount Netting","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/subaccounts/netting","href":"/api-reference/portfolio/get-subaccount-netting"},{"title":"Update Subaccount Netting","deprecated":null,"version":null,"openapi":"/openapi.yaml put /portfolio/subaccounts/netting","href":"/api-reference/portfolio/update-subaccount-netting"},{"title":"Get Positions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/positions","href":"/api-reference/portfolio/get-positions"},{"title":"Get Settlements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/settlements","href":"/api-reference/portfolio/get-settlements"},{"title":"Get Credit History","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/credit_history","href":"/api-reference/portfolio/get-credit-history"},{"title":"Get Deposits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/deposits","href":"/api-reference/portfolio/get-deposits"},{"title":"Get Withdrawals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/withdrawals","href":"/api-reference/portfolio/get-withdrawals"},{"title":"Get Total Resting Order Value","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/summary/total_resting_order_value","href":"/api-reference/portfolio/get-total-resting-order-value"},{"title":"Get Fills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/fills","href":"/api-reference/portfolio/get-fills"},{"title":"Get Target Balance Allocation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portfolio/target_balance_allocation","href":"/api-reference/portfolio/get-target-balance-allocation"},{"title":"Set Target Balance Allocation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portfolio/target_balance_allocation","href":"/api-reference/portfolio/set-target-balance-allocation"}]},{"group":"communications","pages":[{"title":"Get Communications ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/id","href":"/api-reference/communications/get-communications-id"},{"title":"Get Block Trade Proposals","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/block-trade-proposals","href":"/api-reference/communications/get-block-trade-proposals"},{"title":"Propose Block Trade","deprecated":null,"version":null,"openapi":"/openapi.yaml post /communications/block-trade-proposals","href":"/api-reference/communications/propose-block-trade"},{"title":"Cancel Block Trade Proposal","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /communications/block-trade-proposals/{block_trade_proposal_id}","href":"/api-reference/communications/cancel-block-trade-proposal"},{"title":"Accept Block Trade Proposal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /communications/block-trade-proposals/{block_trade_proposal_id}/accept","href":"/api-reference/communications/accept-block-trade-proposal"},{"title":"Reject Block Trade Proposal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /communications/block-trade-proposals/{block_trade_proposal_id}/reject","href":"/api-reference/communications/reject-block-trade-proposal"},{"title":"Get RFQs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/rfqs","href":"/api-reference/communications/get-rfqs"},{"title":"Create RFQ","deprecated":null,"version":null,"openapi":"/openapi.yaml post /communications/rfqs","href":"/api-reference/communications/create-rfq"},{"title":"Get RFQ","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/rfqs/{rfq_id}","href":"/api-reference/communications/get-rfq"},{"title":"Delete RFQ","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /communications/rfqs/{rfq_id}","href":"/api-reference/communications/delete-rfq"},{"title":"Get RFQ Quote","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/rfqs/{rfq_id}/quotes/{quote_id}","href":"/api-reference/communications/get-rfq-quote"},{"title":"Delete RFQ Quote","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /communications/rfqs/{rfq_id}/quotes/{quote_id}","href":"/api-reference/communications/delete-rfq-quote"},{"title":"Accept RFQ Quote","deprecated":null,"version":null,"openapi":"/openapi.yaml put /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept","href":"/api-reference/communications/accept-rfq-quote"},{"title":"Confirm RFQ Quote","deprecated":null,"version":null,"openapi":"/openapi.yaml put /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm","href":"/api-reference/communications/confirm-rfq-quote"},{"title":"Get Quotes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /communications/quotes","href":"/api-reference/communications/get-quotes"},{"title":"Create Quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /communications/quotes","href":"/api-reference/communications/create-quote"},{"title":"Get Quote","deprecated":true,"version":null,"openapi":"/openapi.yaml get /communications/quotes/{quote_id}","href":"/api-reference/communications/get-quote"},{"title":"Delete Quote","deprecated":true,"version":null,"openapi":"/openapi.yaml delete /communications/quotes/{quote_id}","href":"/api-reference/communications/delete-quote"},{"title":"Accept Quote","deprecated":true,"version":null,"openapi":"/openapi.yaml put /communications/quotes/{quote_id}/accept","href":"/api-reference/communications/accept-quote"},{"title":"Confirm Quote","deprecated":true,"version":null,"openapi":"/openapi.yaml put /communications/quotes/{quote_id}/confirm","href":"/api-reference/communications/confirm-quote"}]},{"group":"api-keys","pages":[{"title":"Get API Keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api_keys","href":"/api-reference/api-keys/get-api-keys"},{"title":"Create API Key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api_keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Generate API Key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api_keys/generate","href":"/api-reference/api-keys/generate-api-key"},{"title":"Delete API Key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api_keys/{api_key}","href":"/api-reference/api-keys/delete-api-key"}]},{"group":"account","pages":[{"title":"Get Account API Limits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account/limits","href":"/api-reference/account/get-account-api-limits"},{"title":"Upgrade Account API Usage Level","deprecated":null,"version":null,"openapi":"/openapi.yaml post /account/api_usage_level/upgrade","href":"/api-reference/account/upgrade-account-api-usage-level"},{"title":"Get Account API Usage Level Volume Progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account/api_usage_level/volume_progress","href":"/api-reference/account/get-account-api-usage-level-volume-progress"},{"title":"List Non-Default Endpoint Costs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account/endpoint_costs","href":"/api-reference/account/list-non-default-endpoint-costs"}]},{"group":"search","pages":[{"title":"Get Tags for Series Categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /search/tags_by_categories","href":"/api-reference/search/get-tags-for-series-categories"},{"title":"Get Filters for Sports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /search/filters_by_sport","href":"/api-reference/search/get-filters-for-sports"}]},{"group":"live-data","pages":[{"title":"Get Live Data","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/milestone/{milestone_id}","href":"/api-reference/live-data/get-live-data"},{"title":"Get Live Data (with type)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/{type}/milestone/{milestone_id}","href":"/api-reference/live-data/get-live-data-with-type"},{"title":"Get Multiple Live Data","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/batch","href":"/api-reference/live-data/get-multiple-live-data"},{"title":"Get Game Stats","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/milestone/{milestone_id}/game_stats","href":"/api-reference/live-data/get-game-stats"},{"title":"Get Event Live Data","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/events/{event_ticker}","href":"/api-reference/live-data/get-event-live-data"},{"title":"Get Weather Index","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/weather/{city}","href":"/api-reference/live-data/get-weather-index"},{"title":"Get Weather Index Calibrations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /live_data/weather/{city}/calibrations","href":"/api-reference/live-data/get-weather-index-calibrations"}]},{"group":"structured-targets","pages":[{"title":"Get Structured Targets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /structured_targets","href":"/api-reference/structured-targets/get-structured-targets"},{"title":"Get Structured Target","deprecated":null,"version":null,"openapi":"/openapi.yaml get /structured_targets/{structured_target_id}","href":"/api-reference/structured-targets/get-structured-target"}]},{"group":"milestone","pages":[{"title":"Get Milestone","deprecated":null,"version":null,"openapi":"/openapi.yaml get /milestones/{milestone_id}","href":"/api-reference/milestone/get-milestone"},{"title":"Get Milestones","deprecated":null,"version":null,"openapi":"/openapi.yaml get /milestones","href":"/api-reference/milestone/get-milestones"}]},{"group":"markets","pages":[{"title":"Create Weather Point Market","deprecated":null,"version":null,"openapi":"/openapi.yaml post /weather_point_markets","href":"/api-reference/markets/create-weather-point-market"},{"title":"Get Weather Point Market Availability","deprecated":null,"version":null,"openapi":"/openapi.yaml get /weather_point_markets/availability","href":"/api-reference/markets/get-weather-point-market-availability"}]},{"group":"multivariate","pages":[{"title":"Get Multivariate Event Collection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /multivariate_event_collections/{collection_ticker}","href":"/api-reference/multivariate/get-multivariate-event-collection"},{"title":"Create Market In Multivariate Event Collection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /multivariate_event_collections/{collection_ticker}","href":"/api-reference/multivariate/create-market-in-multivariate-event-collection"},{"title":"Get Multivariate Event Collections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /multivariate_event_collections","href":"/api-reference/multivariate/get-multivariate-event-collections"}]},{"group":"incentive-programs","pages":[{"title":"Get Incentives","deprecated":null,"version":null,"openapi":"/openapi.yaml get /incentive_programs","href":"/api-reference/incentive-programs/get-incentives"},{"title":"Get Incentive Schedules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /incentive_schedules","href":"/api-reference/incentive-programs/get-incentive-schedules"}]},{"group":"fcm","pages":[{"title":"Get FCM Fills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/fills","href":"/api-reference/fcm/get-fcm-fills"},{"title":"Get FCM Orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/orders","href":"/api-reference/fcm/get-fcm-orders"},{"title":"List FCM Subtraders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/subtraders","href":"/api-reference/fcm/list-fcm-subtraders"},{"title":"Create FCM Subtrader","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fcm/subtraders","href":"/api-reference/fcm/create-fcm-subtrader"},{"title":"Get FCM Subtrader Event Contract Daily Cap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/subtraders/event_contract_daily_cap","href":"/api-reference/fcm/get-fcm-subtrader-event-contract-daily-cap"},{"title":"Update FCM Subtrader Event Contract Daily Cap","deprecated":null,"version":null,"openapi":"/openapi.yaml put /fcm/subtraders/event_contract_daily_cap","href":"/api-reference/fcm/update-fcm-subtrader-event-contract-daily-cap"},{"title":"Delete FCM Subtrader Event Contract Daily Cap","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /fcm/subtraders/event_contract_daily_cap","href":"/api-reference/fcm/delete-fcm-subtrader-event-contract-daily-cap"},{"title":"Get FCM Subtrader Blocked Categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/subtraders/blocked_categories","href":"/api-reference/fcm/get-fcm-subtrader-blocked-categories"},{"title":"Update FCM Subtrader Blocked Categories","deprecated":null,"version":null,"openapi":"/openapi.yaml put /fcm/subtraders/blocked_categories","href":"/api-reference/fcm/update-fcm-subtrader-blocked-categories"},{"title":"Get FCM Positions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fcm/positions","href":"/api-reference/fcm/get-fcm-positions"},{"title":"Create FCM Position Transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fcm/positions/transfers","href":"/api-reference/fcm/create-fcm-position-transfer"}]},{"group":"historical","pages":[{"title":"Get Historical Cutoff Timestamps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/cutoff","href":"/api-reference/historical/get-historical-cutoff-timestamps"},{"title":"Get Historical Market Candlesticks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/markets/{ticker}/candlesticks","href":"/api-reference/historical/get-historical-market-candlesticks"},{"title":"Get Historical Fills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/fills","href":"/api-reference/historical/get-historical-fills"},{"title":"Get Historical Orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/orders","href":"/api-reference/historical/get-historical-orders"},{"title":"Get Historical Positions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/positions","href":"/api-reference/historical/get-historical-positions"},{"title":"Get Historical Trades","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/trades","href":"/api-reference/historical/get-historical-trades"},{"title":"Get Historical Markets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/markets","href":"/api-reference/historical/get-historical-markets"},{"title":"Get Historical Market","deprecated":null,"version":null,"openapi":"/openapi.yaml get /historical/markets/{ticker}","href":"/api-reference/historical/get-historical-market"}]}]},{"group":"WebSockets","pages":[{"title":"WebSocket API","sidebarTitle":"Overview","href":"/websockets"},{"title":"WebSocket Connection","asyncapi":"asyncapi.yaml root","href":"/websockets/websocket-connection"},{"title":"Connection Keep-Alive","asyncapi":"asyncapi.yaml control_frames","href":"/websockets/connection-keep-alive"},{"title":"Orderbook Updates","asyncapi":"asyncapi.yaml orderbook_delta","href":"/websockets/orderbook-updates"},{"title":"Market Ticker","asyncapi":"asyncapi.yaml ticker","href":"/websockets/market-ticker"},{"title":"CF Benchmarks Value Feed","asyncapi":"asyncapi.yaml cfbenchmarks_value","href":"/websockets/cfbenchmarks-value"},{"title":"CF Benchmarks 5Hz Value Feed","asyncapi":"asyncapi.yaml cfbenchmarks_value_5hz","href":"/websockets/cfbenchmarks-value-5hz"},{"title":"Pyth Value Feed","asyncapi":"asyncapi.yaml pyth_value","href":"/websockets/pyth-value"},{"title":"Public Trades","asyncapi":"asyncapi.yaml trade","href":"/websockets/public-trades"},{"title":"User Fills","asyncapi":"asyncapi.yaml fill","href":"/websockets/user-fills"},{"title":"Market Positions","asyncapi":"asyncapi.yaml market_positions","href":"/websockets/market-positions"},{"title":"Market \u0026 Event Lifecycle","asyncapi":"asyncapi.yaml market_lifecycle_v2","href":"/websockets/market-and-event-lifecycle"},{"title":"Multivariate Market \u0026 Event Lifecycle","asyncapi":"asyncapi.yaml multivariate_market_lifecycle","href":"/websockets/multivariate-market-and-event-lifecycle"},{"title":"Communications","asyncapi":"asyncapi.yaml communications","href":"/websockets/communications"},{"title":"Order Group Updates","asyncapi":"asyncapi.yaml order_group_updates","href":"/websockets/order-group-updates"},{"title":"User Orders","asyncapi":"asyncapi.yaml user_orders","href":"/websockets/user-orders"}]},{"group":"FIX","pages":[{"title":"Common Components","icon":"puzzle-piece","href":"/fix/common-components"},{"title":"Connectivity","icon":"network-wired","href":"/fix/connectivity"},{"title":"Authentication \u0026 Sessions","icon":"key","href":"/fix/authentication"},{"title":"Order Entry","icon":"cart-plus","href":"/fix/order-entry"},{"title":"Order Groups","icon":"layer-group","href":"/fix/order-groups"},{"title":"Market Data","icon":"chart-line","href":"/fix/market-data"},{"title":"RFQ","icon":"comments-dollar","href":"/fix/rfq-messages"},{"title":"Drop Copy Session","icon":"copy","href":"/fix/drop-copy"},{"title":"Listener Sessions","icon":"headphones","href":"/fix/listener-sessions"},{"title":"Market Settlement","icon":"circle-check","href":"/fix/market-settlement"},{"title":"Error Handling","icon":"triangle-exclamation","href":"/fix/error-handling"},{"title":"Subpenny Pricing","icon":"dollar-sign","href":"/fix/subpenny-pricing"}]}]},{"tab":"Perps APIs","pages":[{"title":"Perps APIs","href":"/margin"}]},{"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"]}