{
"type": "tag:kraken.com,2025:PermissionDenied",
"status": 403,
"title": "Forbidden",
"data": {
"message": "Permission denied."
},
"detail": "The caller is not authorized to perform this action.",
"instance": "https://debug.kraken.com/req/01HXYZABCDEF"
}
{
"type": "tag:kraken.com,2025:gateway/ReadUpstream",
"status": 500,
"title": "Internal Server Error",
"data": "<unknown>",
"detail": "Failed to read response from upstream custody service.",
"instance": "https://debug.kraken.com/req/01HXYZABCDEF"
}
{
"type": "tag:kraken.com,2025:gateway/Connect",
"status": 503,
"title": "Service Unavailable",
"data": {},
"detail": "Downstream custody service is temporarily unreachable; retry with backoff.",
"instance": "https://debug.kraken.com/req/01HXYZABCDEF"
}
Vaults (v0)
Get vault balance
Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable.
This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances.
Quote asset code the balance fields are valued in (e.g. USD). Defaults to USD when the quote_asset parameter is omitted. Currency-only by contract.
Example:
"USD"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kraken Developers","colors":{"primary":"#101114","light":"#FFFFFF","dark":"#101114"},"logo":{"light":"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/light.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=6be2f97a23f9a7aa6ef071ae334cc89c","dark":"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/dark.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=97e079a88bc1e9f156ed533a5f9d5d05"},"favicon":"https://mintcdn.com/kraken/qRZxIUN3tXcpjqG0/favicon.svg?fit=max\u0026auto=format\u0026n=qRZxIUN3tXcpjqG0\u0026q=85\u0026s=1215f433d712b5e667fd4e7599391422","api":{"examples":{"languages":["curl","python","javascript","go"]}},"appearance":{"default":"dark","strict":false},"navbar":{"primary":{"type":"button","label":"Get API key","href":"https://pro.kraken.com/app/settings/api"}},"footer":{"socials":{"x":"https://x.com/krakenfx","github":"https://github.com/krakenfx","linkedin":"https://linkedin.com/company/kraken-exchange"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kraken","hasAudioNarration":false,"actualSubdomain":"kraken","customDomains":["docs.kraken.com"],"gitSource":{"type":"gitlab","owner":"eng-devs","repo":"kraken-api-docs","hostUrl":"https://roshi-korin.honeycrypt.com","projectId":28500,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb5758f5cb23dfd601ef73","collectionId":"dc2b2325-16db-438c-98f1-1f4449361557","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb5758f5cb23dfd601ef73"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec999cd926defce99fc3b3","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":366},{"language":"default","tag":"Exchange","count":309},{"language":"default","tag":"Institutional","count":96},{"language":"default","tag":"Spot REST","count":81},{"language":"default","tag":"Derivatives REST","count":71},{"language":"default","tag":"Guides","count":45},{"language":"default","tag":"Market Data","count":39},{"language":"default","tag":"Session","count":31},{"language":"default","tag":"Trading","count":29},{"language":"default","tag":"Custody REST","count":25}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","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":"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":"custom.css","content":"@import url('https://assets.kraken.com/fonts/kraken.css');@import url('https://assets.kraken.com/fonts/celias.css');html,body,body *{font-family:var(--kp-font-sans)!important;-webkit-font-smoothing:antialiased}h1,h2,h3,h4{font-family:var(--kp-font-brand)!important}.prose h1,.prose h2,.prose h3,.prose h4,.prose h5,.prose h6{font-family:var(--kp-font-brand)!important;font-weight:500!important}body code,body pre,body kbd,body samp,body code *,body pre *,body [class*=\"code\"],body [class*=\"Code\"],.kp-mono,.kp-mono *{font-family:var(--kp-font-mono)!important}:root{--kp-primary: #101114;--kp-primary-hover: #2a2c33;--kp-brand: #7132f5;--kp-font-sans: 'Kraken-Product', system-ui, -apple-system, sans-serif;--kp-font-mono: 'Kraken-Mono', ui-monospace, monospace;--kp-font-brand: 'Kraken-Brand', 'Celias', system-ui, sans-serif;--kp-bg-page: #f6f5f9;--kp-bg-card: #ffffff;--kp-bg-subtle: rgba(104, 107, 130, 0.12);--kp-text-heading: #101114;--kp-text-body: #686b82;--kp-text-placeholder: #9497a9;--kp-text-accent: #101114;--kp-text-meta: #9497a9;--kp-border: rgba(104, 107, 130, 0.16);--kp-terminal-bg: transparent;--kp-terminal-text: var(--kp-text-body);--kp-terminal-heading: var(--kp-text-heading);--kp-terminal-muted: var(--kp-text-placeholder)}html.dark{--kp-primary: #ffffff;--kp-primary-hover: #e7e7e7;--kp-brand: #8a61ff;--kp-bg-page: #0b0611;--kp-bg-card: #16121f;--kp-bg-subtle: rgba(255, 255, 255, 0.07);--kp-text-heading: #ffffff;--kp-text-body: #c6c7d2;--kp-text-placeholder: #9497a9;--kp-text-accent: #ffffff;--kp-text-meta: rgba(255, 255, 255, 0.45);--kp-border: rgba(255, 255, 255, 0.1)}@media (prefers-reduced-motion: reduce){.kp-terminal *,.kp-welcome-hero *{animation-duration:0.01ms!important;animation-iteration-count:1!important;transition-duration:0.01ms!important}}body{background-color:var(--kp-bg-page)!important}body #almond-background-color{background-color:var(--kp-bg-page)!important}.prose{--tw-prose-body: var(--kp-text-body) !important;--tw-prose-headings: var(--kp-text-heading) !important;--tw-prose-links: var(--kp-text-accent) !important;--tw-prose-bold: var(--kp-text-heading) !important;--tw-prose-code: var(--kp-text-heading) !important;--tw-prose-counters: var(--kp-text-body) !important;--tw-prose-bullets: var(--kp-text-placeholder) !important;--tw-prose-hr: var(--kp-border) !important;--tw-prose-quotes: var(--kp-text-body) !important;--tw-prose-quote-borders: var(--kp-border) !important;--tw-prose-th-borders: var(--kp-border) !important;--tw-prose-td-borders: var(--kp-border) !important}nav a,nav button{color:var(--kp-text-body)}nav a:hover,nav button:hover{color:var(--kp-text-heading)}.nav-logo{width:150px!important;height:auto!important}[data-component-part=\"field-root\"]{border-color:var(--kp-border)!important}[role=\"tablist\"] button[data-state=\"active\"]{color:var(--kp-text-heading)!important;border-color:var(--kp-primary)!important}[role=\"tablist\"] button[data-state=\"inactive\"]{color:var(--kp-text-placeholder)!important}body:has(.kp-welcome-hero) #header{display:none!important}@media (min-width: 1024px){.kp-welcome-hero{display:grid;grid-template-columns:1fr 1fr;gap:2rem;align-items:start;margin-bottom:2.5rem}}.prose .kp-welcome-title{font-size:36px!important;line-height:1.15!important;letter-spacing:-0.01em;margin:0 0 1rem!important}.kp-welcome-hero-code .code-group{margin-top:0!important;margin-bottom:0!important}.prose a.kp-hero-btn-primary{text-decoration:none!important;border:1px solid var(--kp-primary)!important;background-color:var(--kp-primary);color:var(--kp-bg-card)!important}.prose a.kp-hero-btn-primary:hover{background-color:var(--kp-primary-hover);border-color:var(--kp-primary-hover)!important}html.dark .prose a.kp-hero-btn-primary{color:var(--kp-bg-page)!important}.kp-terminal{background:var(--kp-terminal-bg)!important;border-color:var(--kp-border)!important}.kp-terminal.kp-terminal-card{background:var(--kp-bg-card)!important}.kp-terminal .kp-term-output{color:var(--kp-terminal-text)}.kp-terminal .kp-term-prompt-text{color:var(--kp-terminal-heading)!important}.kp-terminal .kp-term-cursor{background:var(--kp-terminal-heading)!important}.kp-terminal span[aria-hidden=\"true\"]:first-child{color:var(--kp-terminal-muted)!important}.kp-term-output,pre code{scrollbar-width:none}.kp-term-output::-webkit-scrollbar,pre code::-webkit-scrollbar{display:none}@media (max-width: 480px){.kp-term-output{font-size:11px!important;padding:12px 14px!important}}.kp-cli-install{scrollbar-width:none}.kp-cli-install::-webkit-scrollbar{display:none}.kp-cli-copy-btn{transition:color 0.15s ease}.kp-cli-install:hover .kp-cli-copy-btn{color:var(--kp-text-heading)!important}.kp-cli-install:focus-visible{outline:2px solid var(--kp-brand);outline-offset:-2px}.kp-cli-copy-btn svg{transition:transform 0.15s ease}.kp-cli-install:hover .kp-cli-copy-btn svg{transform:scale(1.15)}.login-link{display:none!important}"},{"filePath":"global.css","content":"hr{margin-top:1rem!important;margin-bottom:1rem!important}[data-component-part=\"field-content\"]{margin-top:0.25rem!important}.api-banner{display:flex;align-items:center;gap:0.5rem;border:1px solid light-dark(#e5e6ec, #353746);box-shadow:0 0 0 5px light-dark(#ffffff, #0b0611), 0 0 0 6px light-dark(#e5e6ec, #353746);border-radius:1rem;padding:0.4rem;margin-bottom:0.8rem}.api-banner .api-protocol{color:white;font-weight:800;font-size:12px;padding:0.1rem 0.5rem;border-radius:1rem;text-transform:uppercase}.api-banner .api-protocol.ws{background:light-dark(#0079b4, #004e75)}.api-banner .api-protocol.fix{background:light-dark(#a67c1d, #6f5000)}.api-banner .api-detail{font-family:var(--kp-font-mono);font-size:14px;color:light-dark(#484b5e, #9497a9)}.api-banner .api-tag{margin-left:auto;font-family:var(--kp-font-mono);font-weight:600;font-size:12px;background:light-dark(#eeeff3, #292b38);color:light-dark(#484b5e, #c6c7d2);padding:0.1rem 1.5rem;border-radius:0.7rem}div:has(>.nav-tag-pill){order:-1;margin-left:0!important;margin-right:0.9rem!important}.prose code:not(pre *){padding-inline:0.15em}pre code{font-size:12px!important}[data-component-part=\"code-block-root\"],[data-component-part=\"code-group-tab-content\"]{line-height:1.25rem!important}#content-side-layout{position:relative!important;top:auto!important;height:auto!important;max-height:none!important}#header .prose{font-size:16px}.field-attr{font-weight:600;font-size:12px;line-height:16px;color:light-dark(#686b82, #9497a9)}"}],"page":{"pagePath":"api-reference/custody-external-api/get-vault-balance","slug":"/api-reference/custody-external-api/get-vault-balance","pageMetadata":{"title":"Get vault balance","description":"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable.\n\nThis is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call `GET /v0/insto/custody/vaults/{vault_id}/assets/balances`.\n\n**Rate limit:** 200 requests per 30 seconds per IP.","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/balances","href":"/api-reference/custody-external-api/get-vault-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: [_jsx(_components.p, {\n children: \"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call \", _jsx(_components.code, {\n children: \"GET /v0/insto/custody/vaults/{vault_id}/assets/balances\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limit:\"\n }), \" 200 requests per 30 seconds per IP.\"]\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 vault balance","description":"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable.\n\nThis is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call `GET /v0/insto/custody/vaults/{vault_id}/assets/balances`.\n\n**Rate limit:** 200 requests per 30 seconds per IP.","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/balances","href":"/api-reference/custody-external-api/get-vault-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Custody External API"],"summary":"Get vault balance","description":"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable.\n\nThis is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call `GET /v0/insto/custody/vaults/{vault_id}/assets/balances`.\n\n**Rate limit:** 200 requests per 30 seconds per IP.","operationId":"getV0InstoCustodyVaultsVaultIdBalances","parameters":["d4ce31e2-51f4-4ea3-9b3d-c589d0d6d26c","f4840a26-a953-4c92-8164-243d87896611"],"responses":{"200":"9e07ac3f-b4a2-4ab0-9b6b-ae84904a88db","400":"663d4286-4716-4b8e-a0bb-294136c9af98","403":"9994bca3-3490-46f2-a9ff-038c00f4ec38","500":"16ffe9c3-9a69-4879-ade1-b3feca2de278","503":"e7a90082-4f2c-4ce3-a3c6-8a32e55230f8"},"security":["df17a4f2-21ff-405f-9e19-8dfef0ba70b0"],"x-stability":{"version":"v1","level":"draft","since":null},"x-spec-source":["InstoCustodyExternalService-1.0.0"],"method":"get","type":"path","servers":["5a5e43db-f036-47c2-892f-f86bb8682cd3"],"path":"/v0/insto/custody/vaults/{vault_id}/balances","baseUrlOptions":["https://api.kraken.com"],"title":"Get vault balance","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d4ce31e2-51f4-4ea3-9b3d-c589d0d6d26c":{"in":"path","name":"vault_id","required":true,"description":"Vault identifier, a `V`-prefixed 14-char base32 string with a final check character.","schema":{"type":"string","example":"VABCDEF234567A","isRequired":true,"description":"Vault identifier, a `V`-prefixed 14-char base32 string with a final check character.","uniqueKey":"","typeLabel":"string"},"style":"simple"},"f4840a26-a953-4c92-8164-243d87896611":{"in":"query","name":"quote_asset","description":"Currency code used to value the vault balance. Defaults to USD when omitted; only USD is currently accepted.","schema":{"type":"string","example":"USD","description":"Currency code used to value the vault balance. Defaults to USD when omitted; only USD is currently accepted.","uniqueKey":"","typeLabel":"string"},"style":"form"}},"responses":{"9e07ac3f-b4a2-4ab0-9b6b-ae84904a88db":{"description":"OK. Returns the vault balance valued in the requested quote currency.","content":{"application/json":{"schema":{"type":"object","properties":{"quote_value":{"description":"Total vault balance valued in the quote currency, decimal as string.","type":"string","example":"12345.6789","isRequired":true,"uniqueKey":"quote_value","typeLabel":"string"},"quote_value_change_24h":{"description":"24h percentage change of the vault's quote-valued spot balance versus the prior day, as a percentage string (not a quote-currency amount).","type":"string","example":"1.50","isRequired":true,"uniqueKey":"quote_value_change_24h","typeLabel":"string"},"missing_rates":{"description":"Assets held in the vault for which a quote rate was unavailable when computing the total.","type":"array","items":{"type":"object","properties":{"asset":{"description":"Asset code missing a quote rate.","type":"string","example":"BTC","isRequired":true,"uniqueKey":"missing_rates.items.[INDEX].asset","typeLabel":"string"},"asset_class":{"description":"Asset class of the asset missing a quote rate.","type":"string","example":"currency","isRequired":true,"uniqueKey":"missing_rates.items.[INDEX].asset_class","typeLabel":"string"}},"required":["asset","asset_class"],"uniqueKey":"missing_rates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"missing_rates","typeLabel":"object[]"},"quote_asset":{"description":"Quote asset code the balance fields are valued in (e.g. `USD`). Defaults to USD when the `quote_asset` parameter is omitted. Currency-only by contract.","type":"string","example":"USD","isRequired":true,"uniqueKey":"quote_asset","typeLabel":"string"}},"required":["quote_value","quote_value_change_24h","missing_rates","quote_asset"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"quote_value":"12345.6789","quote_value_change_24h":"1.50","missing_rates":[{"asset":"BTC","asset_class":"currency"}],"quote_asset":"USD"}}},"exampleType":"generated"}},"exampleType":"generated"},"663d4286-4716-4b8e-a0bb-294136c9af98":{"description":"Bad Request. The request failed validation, or quote_asset is not a supported quote currency.","content":{"application/problem+json":{"schema":{"description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","type":"object","properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:BadRequest"],"example":"tag:kraken.com,2025:BadRequest","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Bad Request","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"data":{"description":"Error-specific payload.","type":"object","properties":{"message":{"description":"Human-readable description of the validation failure.","type":"string","example":"Invalid quote_asset parameter.","isRequired":true,"uniqueKey":"data.message","typeLabel":"string"}},"required":["message"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Invalid quote_asset parameter.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Invalid quote_asset parameter.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["data","status","title","type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"tag:kraken.com,2025:BadRequest","status":400,"title":"Bad Request","data":{"message":"Invalid quote_asset parameter."},"detail":"Invalid quote_asset parameter.","instance":"https://debug.kraken.com/req/01HXYZABCDEF"}}},"exampleType":"generated"}},"exampleType":"generated"},"9994bca3-3490-46f2-a9ff-038c00f4ec38":{"description":"Forbidden. The caller lacks access to the requested vault.","content":{"application/problem+json":{"schema":{"description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","type":"object","properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:PermissionDenied"],"example":"tag:kraken.com,2025:PermissionDenied","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":403,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Forbidden","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"data":{"description":"Error-specific payload.","type":"object","properties":{"message":{"description":"Human-readable description of why access was denied.","type":"string","example":"Permission denied.","isRequired":true,"uniqueKey":"data.message","typeLabel":"string"}},"required":["message"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"The caller is not authorized to perform this action.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"The caller is not authorized to perform this action.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["data","status","title","type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"tag:kraken.com,2025:PermissionDenied","status":403,"title":"Forbidden","data":{"message":"Permission denied."},"detail":"The caller is not authorized to perform this action.","instance":"https://debug.kraken.com/req/01HXYZABCDEF"}}},"exampleType":"generated"}},"exampleType":"generated"},"16ffe9c3-9a69-4879-ade1-b3feca2de278":{"description":"Internal Server Error. An unhandled exception occurred while serving the request.","content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.0.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.0.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.0.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.0.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.0.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.1.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.1.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.1.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.1.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.1.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.2.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.2.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.2.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.2.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.2.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.2.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/WriteResponse"],"example":"tag:kraken.com,2025:gateway/WriteResponse","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.3.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.3.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to write response to upstream custody service.","uniqueKey":"oneOf.3.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to write response to upstream custody service.","uniqueKey":"oneOf.3.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.3.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.3.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.3","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/Connect"],"example":"tag:kraken.com,2025:gateway/Connect","isRequired":true,"uniqueKey":"oneOf.4.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.4.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.4.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.4.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to connect to upstream custody service.","uniqueKey":"oneOf.4.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to connect to upstream custody service.","uniqueKey":"oneOf.4.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.4.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.4.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.4","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.5.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.5.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.5.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.5.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.5.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.5.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.5.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.5.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.5.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.5.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.5","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.6.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.6.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.6.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.6.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.6.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.6.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.6.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.6.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.6.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.6.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.6","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/ReadUpstream"],"example":"tag:kraken.com,2025:gateway/ReadUpstream","isRequired":true,"uniqueKey":"oneOf.7.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.7.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.7.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.7.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.7.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to read response from upstream custody service.","uniqueKey":"oneOf.7.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.7.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.7.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.7.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.7.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.7","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/WriteResponse"],"example":"tag:kraken.com,2025:gateway/WriteResponse","isRequired":true,"uniqueKey":"oneOf.8.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.8.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.8.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.8.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Failed to write response to upstream custody service.","uniqueKey":"oneOf.8.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Failed to write response to upstream custody service.","uniqueKey":"oneOf.8.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.8.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.8.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.8.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.8.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.8","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/Fatal"],"example":"tag:kraken.com,2025:gateway/Fatal","isRequired":true,"uniqueKey":"oneOf.9.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.9.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.9.title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","isRequired":true,"uniqueKey":"oneOf.9.data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"A fatal gateway error occurred while serving the request.","uniqueKey":"oneOf.9.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"A fatal gateway error occurred while serving the request.","uniqueKey":"oneOf.9.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.9.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.9.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.9.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.9.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.9","typeLabel":"object"},{"type":"object","description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","required":["data","status","title","type"],"properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:Unknown"],"example":"tag:kraken.com,2025:Unknown","isRequired":true,"uniqueKey":"oneOf.10.type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":500,"isRequired":true,"uniqueKey":"oneOf.10.status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"oneOf.10.title","typeLabel":"string"},"data":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the underlying failure.","example":"Unhandled exception while servicing the request.","isRequired":true,"uniqueKey":"oneOf.10.data.message","typeLabel":"string"},"core_error":{"type":"string","description":"Identifier for the originating error.","example":"InternalError","isRequired":true,"uniqueKey":"oneOf.10.data.core_error","typeLabel":"string"}},"required":["message","core_error"],"description":"Error-specific payload returned for an unhandled exception.","isRequired":true,"uniqueKey":"oneOf.10.data","typeLabel":"object"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"An unexpected error occurred while serving the request.","uniqueKey":"oneOf.10.detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"An unexpected error occurred while serving the request.","uniqueKey":"oneOf.10.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.10.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.10.instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"oneOf.10.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.10.instance","typeLabel":"string | null"}},"uniqueKey":"oneOf.10","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"tag:kraken.com,2025:gateway/ReadUpstream","status":500,"title":"Internal Server Error","data":"\u003cunknown>","detail":"Failed to read response from upstream custody service.","instance":"https://debug.kraken.com/req/01HXYZABCDEF"}}},"exampleType":"generated"}},"exampleType":"generated"},"e7a90082-4f2c-4ce3-a3c6-8a32e55230f8":{"description":"Service Unavailable. The custody service could not connect to a downstream dependency.","content":{"application/problem+json":{"schema":{"description":"Error responses follow `Problem Details for HTTP APIs` ([rfc7807]).\n\n[rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807","type":"object","properties":{"type":{"description":"URL uniquely identifying the error type relative to an operation","type":"string","enum":["tag:kraken.com,2025:gateway/Connect"],"example":"tag:kraken.com,2025:gateway/Connect","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"HTTP status (provided for convenience)","type":"integer","format":"uint16","minimum":0,"example":503,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cuint16>"},"title":{"description":"Short human-readable summary","type":"string","example":"Service Unavailable","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"data":{"description":"Custom data attached to this problem","example":{},"isRequired":true,"uniqueKey":"data","typeLabel":"any"},"detail":{"oneOf":[{"description":"Help to solve the problem","type":"string","example":"Downstream custody service is temporarily unreachable; retry with backoff.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"description":"Help to solve the problem","type":"null","example":"Downstream custody service is temporarily unreachable; retry with backoff.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"description":"Link to debug data for this particular error","type":"string","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"description":"Link to debug data for this particular error","type":"null","example":"https://debug.kraken.com/req/01HXYZABCDEF","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"required":["data","status","title","type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"tag:kraken.com,2025:gateway/Connect","status":503,"title":"Service Unavailable","data":{},"detail":"Downstream custody service is temporarily unreachable; retry with backoff.","instance":"https://debug.kraken.com/req/01HXYZABCDEF"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"df17a4f2-21ff-405f-9e19-8dfef0ba70b0":{"API Key Auth (key)":{"type":"apiKey","in":"header","name":"api-key","scopes":[],"schemeName":"API Key Auth (key)"},"API Key Auth (signature)":{"type":"apiKey","in":"header","name":"api-sign","scopes":[],"schemeName":"API Key Auth (signature)"},"API Key Auth (nonce)":{"type":"apiKey","in":"header","name":"api-nonce","scopes":[],"schemeName":"API Key Auth (nonce)"}}},"servers":{"5a5e43db-f036-47c2-892f-f86bb8682cd3":{"url":"https://api.kraken.com","description":"Production Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","scopes":[],"schemeName":"API Key Auth (key)"},"schema":{"title":"api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API Key Auth (key)","name":"api-key"},{"scheme":{"type":"apiKey","in":"header","name":"api-sign","scopes":[],"schemeName":"API Key Auth (signature)"},"schema":{"title":"api-sign","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API Key Auth (signature)","name":"api-sign"},{"scheme":{"type":"apiKey","in":"header","name":"api-nonce","scopes":[],"schemeName":"API Key Auth (nonce)"},"schema":{"title":"api-nonce","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API Key Auth (nonce)","name":"api-nonce"}],"title":"API Key Auth (key) \u0026 API Key Auth (signature) \u0026 API Key Auth (nonce)"}]},"originalFileLocation":"openapi/insto-custody-rest.yaml"},"subdomain":"kraken","siteName":"Kraken Developers","title":"Get vault balance - Kraken Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T14:58:57.067Z","originalFileLocation":"api-reference/custody-external-api/get-vault-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=\"dark\"}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 total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable. This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances. Rate limit: 200 requests per 30 seconds per IP.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kraken Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_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/kraken/WtiP_7MUCtGxw5vL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get vault balance - Kraken Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable. This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances. Rate limit: 200 requests per 30 seconds per IP.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kraken Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kraken.mintlify.app/_mintlify/api/og/v2?division=Vaults+%28v0%29\u0026amp;title=Get+vault+balance\u0026amp;description=Returns+the+total+balance+for+a+vault+valued+in+the+requested+quote+currency.+The+response+includes+the+24-hour+balance+change+and+any+assets+for+which+a+quote+\u0026amp;theme=5c8759ca94ea0060c63352cf\u0026amp;signature=18d174e91205cf2d96dc38ae05789655be2302fb60a0bcd13e3d4aca87026118\">\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 vault balance - Kraken Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable. This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances. Rate limit: 200 requests per 30 seconds per IP.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kraken.mintlify.app/_mintlify/api/og/v2?division=Vaults+%28v0%29\u0026amp;title=Get+vault+balance\u0026amp;description=Returns+the+total+balance+for+a+vault+valued+in+the+requested+quote+currency.+The+response+includes+the+24-hour+balance+change+and+any+assets+for+which+a+quote+\u0026amp;theme=5c8759ca94ea0060c63352cf\u0026amp;signature=18d174e91205cf2d96dc38ae05789655be2302fb60a0bcd13e3d4aca87026118\">\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/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kraken Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#101114\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-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/custody-external-api/get-vault-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kraken.com/#organization\",\"name\":\"Kraken Developers\",\"url\":\"https://docs.kraken.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/light.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=6be2f97a23f9a7aa6ef071ae334cc89c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kraken.com#website\",\"name\":\"Kraken Developers\",\"url\":\"https://docs.kraken.com\",\"publisher\":{\"@id\":\"https://docs.kraken.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance#webpage\",\"url\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance\",\"name\":\"Get vault balance\",\"description\":\"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable. This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances. Rate limit: 200 requests per 30 seconds per IP.\",\"dateModified\":\"2026-11-05T14:58:57.067Z\",\"isPartOf\":{\"@id\":\"https://docs.kraken.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Vaults (v0)\",\"item\":\"https://docs.kraken.com/api-reference/custody-external-api/list-vaults\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get vault balance\",\"item\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance#apireference\",\"headline\":\"Get vault balance\",\"name\":\"Get vault balance\",\"description\":\"Returns the total balance for a vault valued in the requested quote currency. The response includes the 24-hour balance change and any assets for which a quote rate was unavailable. This is an aggregate valuation only. It does not break down which assets the vault holds or in what quantity. For per-asset quantities, including the spot, hold, available, staked, and pledged components, call GET /v0/insto/custody/vaults/{vault_id}/assets/balances. Rate limit: 200 requests per 30 seconds per IP.\",\"url\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kraken.com/api-reference/custody-external-api/get-vault-balance#webpage\"},\"dateModified\":\"2026-11-05T14:58:57.067Z\",\"publisher\":{\"@id\":\"https://docs.kraken.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kraken.com#website\"}}]}\u003c/script>","siteName":"Kraken Developers","nav":{"global":{},"products":[{"product":"Home","pages":[{"title":"Home","href":""}]},{"product":"Exchange","pages":[{"title":"Exchange","href":"/exchange/guides/overview"}]},{"product":"Institutional","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/institutional/guides/overview"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"Institutional API reference","sidebarTitle":"Overview","href":"/institutional/api-reference/overview"}]},{"dropdown":"Custody REST","icon":"code","pages":[{"title":"Custody REST overview","sidebarTitle":"Overview","href":"/institutional/api-reference/custody-rest"},{"group":"Portfolios","public":true,"hidden":true,"pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/ListCustodyVaults","href":"/api-reference/portfolios/list-vaults"},{"title":"Get vault information by id","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/GetCustodyVault","href":"/api-reference/portfolios/get-vault-information-by-id"},{"title":"Get deposit methods","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/DepositMethods","href":"/api-reference/portfolios/get-deposit-methods"},{"title":"Get deposit addresses","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/DepositAddresses","href":"/api-reference/portfolios/get-deposit-addresses"},{"title":"Get custody balance","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/GetCustodyBalance","href":"/api-reference/portfolios/get-custody-balance"},{"title":"List custody transactions","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/ListCustodyTransactions","href":"/api-reference/portfolios/list-custody-transactions"},{"title":"Get transaction by id","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/GetCustodyTransaction","href":"/api-reference/portfolios/get-transaction-by-id"}]},{"group":"Transfers","public":true,"hidden":true,"pages":[{"title":"Get withdraw methods","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/WithdrawMethods","href":"/api-reference/transfers/get-withdraw-methods"},{"title":"Get withdraw addresses","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/WithdrawAddresses","href":"/api-reference/transfers/get-withdraw-addresses"}]},{"group":"Tasks","public":true,"hidden":true,"pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/ListCustodyTasks","href":"/api-reference/tasks/list-tasks"},{"title":"Get task by id","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/GetCustodyTask","href":"/api-reference/tasks/get-task-by-id"},{"title":"List activities","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/ListCustodyActivities","href":"/api-reference/tasks/list-activities"},{"title":"Get activity by id","deprecated":null,"version":null,"openapi":"/openapi/custody-rest.yaml post /0/private/GetCustodyActivity","href":"/api-reference/tasks/get-activity-by-id"}]},{"group":"Assets (v0)","public":true,"pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/assets","href":"/api-reference/custody-external-api/list-assets"}]},{"group":"Organizations (v0)","public":true,"pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/organizations","href":"/api-reference/custody-external-api/list-organizations"},{"title":"List balances","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/organizations/{org_iiban}/balances","href":"/api-reference/custody-external-api/list-balances"}]},{"group":"Vaults (v0)","public":true,"pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults","href":"/api-reference/custody-external-api/list-vaults"},{"title":"Get vault","description":"Returns metadata for a single vault the authenticated user can access. Initiator and Reviewer API users must be a member of the vault.\n\n**Rate limit:** 200 requests per 30 seconds per IP.","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}","href":"/api-reference/custody-external-api/get-vault"},{"title":"Get vault balance","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/balances","href":"/api-reference/custody-external-api/get-vault-balance"},{"title":"List vault asset balances","description":"Returns per-asset balances for a vault, including spot, hold, available, staked, and pledged components for each asset. Each row includes asset metadata and optional quote-currency valuations. Use `quote_asset` to select the valuation currency (defaults to USD). Numeric strings are always returned at full upstream precision.\n\nThis is the endpoint to use whenever you need asset codes and quantities. The `quote_value` on `GET /v0/insto/custody/vaults` and `GET /v0/insto/custody/vaults/{vault_id}/balances` is a single aggregate valuation and cannot be decomposed into holdings.\n\n**Rate limit:** 200 requests per 30 seconds per IP.","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/assets/balances","href":"/api-reference/custody-external-api/list-vault-asset-balances"},{"title":"List vault policies","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/policies","href":"/api-reference/custody-external-api/list-vault-policies"}]},{"group":"Deposits (v0)","public":true,"pages":[{"title":"List deposit methods","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/deposit-methods","href":"/api-reference/custody-external-api/list-deposit-methods"},{"title":"List deposit addresses","deprecated":null,"version":null,"sidebarTitle":"List deposit addresses","openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/deposit-methods/{method_id}/addresses","href":"/api-reference/custody-external-api/list-deposit-addresses"},{"title":"Create address","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml post /v0/insto/custody/vaults/{vault_id}/deposit-methods/{method_id}/addresses","href":"/api-reference/custody-external-api/create-address"},{"title":"Get deposit info","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/deposits/info","href":"/api-reference/custody-external-api/get-deposit-info"}]},{"group":"Withdrawals (v0)","public":true,"pages":[{"title":"List whitelist addresses","deprecated":null,"version":null,"sidebarTitle":"List whitelist addresses","openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/whitelist/addresses","href":"/api-reference/custody-external-api/list-whitelist-addresses"},{"title":"List withdrawal methods","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/withdrawal-methods","href":"/api-reference/custody-external-api/list-withdrawal-methods"},{"title":"Get withdrawal info","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/withdrawals/info","href":"/api-reference/custody-external-api/get-withdrawal-info"},{"title":"Create withdrawal fee quote","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml post /v0/insto/custody/vaults/{vault_id}/withdrawals/fee-quotes","href":"/api-reference/custody-external-api/create-withdrawal-fee-quote"}]},{"group":"Tasks (v0)","public":true,"pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/tasks","href":"/api-reference/custody-external-api/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml post /v0/insto/custody/tasks","href":"/api-reference/custody-external-api/create-task"},{"title":"List task activities","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/tasks/activities","href":"/api-reference/custody-external-api/list-task-activities"},{"title":"Get task by id","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/tasks/{task_id}","href":"/api-reference/custody-external-api/get-task-by-id"},{"title":"Get task activity by id","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/tasks/activities/{activity_id}","href":"/api-reference/custody-external-api/get-task-activity-by-id"},{"title":"Review task","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml post /v0/insto/custody/tasks/{task_id}/review","href":"/api-reference/custody-external-api/review-task"}]},{"group":"Transactions (v0)","public":true,"pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/transactions","href":"/api-reference/custody-external-api/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"/openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/transactions/{transaction_id}","href":"/api-reference/custody-external-api/get-transaction"}]}]},{"dropdown":"OTC REST","icon":"code","pages":[{"title":"OTC REST","href":"/institutional/api-reference/otc-rest"},{"group":"Quotes","public":true,"pages":[{"title":"Create OTC Quote","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/CreateOtcQuoteRequest","href":"/api-reference/quotes/create-otc-quote"},{"title":"Update OTC Quote","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/UpdateOtcQuote","href":"/api-reference/quotes/update-otc-quote"},{"title":"Get OTC Pairs","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcPairs","href":"/api-reference/quotes/get-otc-pairs"},{"title":"Get OTC Active Quotes","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcActiveQuotes","href":"/api-reference/quotes/get-otc-active-quotes"},{"title":"Get OTC Historical Quotes","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcHistoricalQuotes","href":"/api-reference/quotes/get-otc-historical-quotes"},{"title":"Get OTC Exposures","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcExposures","href":"/api-reference/quotes/get-otc-exposures"},{"title":"Check OTC Eligibility","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/CheckOtcClient","href":"/api-reference/quotes/check-otc-eligibility"}]},{"group":"Trades","public":true,"pages":[{"title":"Get OTC Spot Trade History","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcSpotTradeHistory","href":"/api-reference/trades/get-otc-spot-trade-history"},{"title":"Get OTC Options Trade History","deprecated":null,"version":null,"openapi":"/openapi/otc-rest.yaml post /private/GetOtcOptionsTradeHistory","href":"/api-reference/trades/get-otc-options-trade-history"}]}]},{"dropdown":"Prime REST","icon":"code","pages":[{"title":"Prime REST","sidebarTitle":"Prime REST","href":"/institutional/api-reference/prime-rest"},{"group":"API Users","public":true,"pages":[{"title":"Create Prime API User","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/CreatePrimeApiUser","href":"/api-reference/api-users/create-prime-api-user"},{"title":"Get Prime API User","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/GetPrimeApiUser","href":"/api-reference/api-users/get-prime-api-user"},{"title":"List Prime API Users","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/ListPrimeApiUsers","href":"/api-reference/api-users/list-prime-api-users"},{"title":"Update Prime API User","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/UpdatePrimeApiUser","href":"/api-reference/api-users/update-prime-api-user"},{"title":"Update Prime API User Roles","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/UpdatePrimeApiUserRoles","href":"/api-reference/api-users/update-prime-api-user-roles"}]},{"group":"API User Keys","public":true,"pages":[{"title":"Create Prime API User Key","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/CreatePrimeApiUserKey","href":"/api-reference/api-user-keys/create-prime-api-user-key"},{"title":"List Prime API User Keys","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/ListPrimeApiUserKeys","href":"/api-reference/api-user-keys/list-prime-api-user-keys"},{"title":"Update Prime API User Key","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/UpdatePrimeApiUserKey","href":"/api-reference/api-user-keys/update-prime-api-user-key"},{"title":"Delete Prime API User Key","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/DeletePrimeApiUserKey","href":"/api-reference/api-user-keys/delete-prime-api-user-key"}]},{"group":"Settlement","public":true,"pages":[{"title":"Create Prime Settlement Batch","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/CreatePrimeSettlementBatch","href":"/api-reference/settlement/create-prime-settlement-batch"},{"title":"Get Prime Settlement Batch","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/GetPrimeSettlementBatch","href":"/api-reference/settlement/get-prime-settlement-batch"},{"title":"List Prime Settlement Batches","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/ListPrimeSettlementBatches","href":"/api-reference/settlement/list-prime-settlement-batches"},{"title":"Settle Prime Settlement Batch Asset","deprecated":null,"version":null,"openapi":"/openapi/prime-rest.yaml post /0/private/SettlePrimeSettlementBatchAsset","href":"/api-reference/settlement/settle-prime-settlement-batch-asset"}]}]},{"dropdown":"Prime FIX","icon":"terminal","groups":[{"group":"Session","public":true,"pages":[{"title":"Logon","href":"/institutional/api-reference/prime-fix/logon"},{"title":"Logout","href":"/institutional/api-reference/prime-fix/logout"},{"title":"Header \u0026 Trailer","sidebarTitle":"Header \u0026 Trailer","href":"/institutional/api-reference/prime-fix/header-trailer"},{"title":"Heartbeat","href":"/institutional/api-reference/prime-fix/heartbeat"},{"title":"Test Request","href":"/institutional/api-reference/prime-fix/test-request"},{"title":"Resend Request","href":"/institutional/api-reference/prime-fix/resend-request"},{"title":"Sequence Reset","href":"/institutional/api-reference/prime-fix/sequence-reset"},{"title":"Session Reject","href":"/institutional/api-reference/prime-fix/session-reject"}]},{"group":"Order Management","public":true,"pages":[{"title":"New Order Single","href":"/institutional/api-reference/prime-fix/nos"},{"title":"Order Cancel Request","href":"/institutional/api-reference/prime-fix/ocr"},{"title":"Order Cancel Replace Request","sidebarTitle":"Order Cancel Replace","href":"/institutional/api-reference/prime-fix/ocrr"},{"title":"Order Cancel Reject","sidebarTitle":"Order Cancel Reject","href":"/institutional/api-reference/prime-fix/ocrej"},{"title":"Execution Report","href":"/institutional/api-reference/prime-fix/er"}]},{"group":"Security List","public":true,"pages":[{"title":"Security List","href":"/institutional/api-reference/prime-fix/sl"},{"title":"Security List Request","href":"/institutional/api-reference/prime-fix/slr"}]},{"group":"Market Data","public":true,"pages":[{"title":"Market Data Request","href":"/institutional/api-reference/prime-fix/mdr"},{"title":"Market Data Request Reject","sidebarTitle":"Market Data Request Reject","href":"/institutional/api-reference/prime-fix/mdrr"},{"title":"Market Data Snapshot Full Refresh","sidebarTitle":"Market Data Snapshot","href":"/institutional/api-reference/prime-fix/mdsfr"}]}]},{"dropdown":"Prime WebSocket","icon":"bolt","groups":[{"group":"Connection","public":true,"pages":[{"title":"Authentication","href":"/institutional/api-reference/prime-websocket/authentication"},{"title":"Hello","href":"/institutional/api-reference/prime-websocket/hello"},{"title":"Ping","href":"/institutional/api-reference/prime-websocket/ping"}]},{"group":"Subscription Management","public":true,"pages":[{"title":"Subscribe","href":"/institutional/api-reference/prime-websocket/subscribe"},{"title":"Continue Paged Stream","href":"/institutional/api-reference/prime-websocket/page"},{"title":"Cancel Stream","href":"/institutional/api-reference/prime-websocket/cancel"}]},{"group":"Order Management","public":true,"pages":[{"title":"New Order Single","sidebarTitle":"New Order Single","href":"/institutional/api-reference/prime-websocket/new-order-single"},{"title":"Order Cancel Request","sidebarTitle":"Order Cancel Request","href":"/institutional/api-reference/prime-websocket/order-cancel-request"},{"title":"Order Cancel Replace Request","sidebarTitle":"Order Cancel Replace","href":"/institutional/api-reference/prime-websocket/order-cancel-replace-request"},{"title":"Order Control Request","sidebarTitle":"Order Control Request","href":"/institutional/api-reference/prime-websocket/order-control-request"},{"title":"Order Updates","sidebarTitle":"Order Updates","href":"/institutional/api-reference/prime-websocket/order"},{"title":"Execution Report","sidebarTitle":"Execution Report","href":"/institutional/api-reference/prime-websocket/execution-report"}]},{"group":"Market Data","public":true,"pages":[{"title":"Security","href":"/institutional/api-reference/prime-websocket/security"},{"title":"Market Data Snapshot","sidebarTitle":"Market Data Snapshot","href":"/institutional/api-reference/prime-websocket/market-data-snapshot"}]},{"group":"Account","public":true,"pages":[{"title":"Balance","href":"/institutional/api-reference/prime-websocket/balance"},{"title":"Trade","href":"/institutional/api-reference/prime-websocket/trade"},{"title":"Exposure","href":"/institutional/api-reference/prime-websocket/exposure"},{"title":"User","href":"/institutional/api-reference/prime-websocket/user"},{"title":"User Config","sidebarTitle":"User Config","href":"/institutional/api-reference/prime-websocket/user-config"}]},{"group":"RFQ","public":true,"pages":[{"title":"Quote Request","sidebarTitle":"Quote Request","href":"/institutional/api-reference/prime-websocket/quote-request"},{"title":"Quote Updates","sidebarTitle":"Quote Updates","href":"/institutional/api-reference/prime-websocket/quote"},{"title":"Quote Cancel Request","sidebarTitle":"Quote Cancel Request","href":"/institutional/api-reference/prime-websocket/quote-cancel-request"}]},{"group":"Reference Data","public":true,"pages":[{"title":"Currency","href":"/institutional/api-reference/prime-websocket/currency"},{"title":"Currency Conversion","sidebarTitle":"Currency Conversion","href":"/institutional/api-reference/prime-websocket/currency-conversion"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/institutional/changelog"}]}]},{"product":"Pay","pages":[{"title":"Pay","href":"/pay/guides/pay-webhook"}]},{"product":"Nodes","hidden":true,"pages":[{"title":"Nodes","href":"/nodes/guides/introduction"}]}]},"basePath":"","title":"Get vault balance - Kraken Developers","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}