Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payward Developer Documentation","colors":{"primary":"#0D0D0D","light":"#FFFFFF","dark":"#0D0D0D"},"logo":{"light":"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/light.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=38bcfc0cb2a1e7c2a308a1de91e5e778","dark":"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/dark.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=acbf50d23cd4e13e991f6ef62e72e95d"},"favicon":"https://mintcdn.com/mintlify-0e856cf0/XXxi474nqJjh9ixz/favicon.svg?fit=max\u0026auto=format\u0026n=XXxi474nqJjh9ixz\u0026q=85\u0026s=52a6dac48bb65d2e07aa472407d20f1d","appearance":{"default":"system"},"background":{"color":{"dark":"#0D0D0D"}},"navbar":{"primary":{"type":"button","label":"Book a Demo","href":"https://services.payward.com/?utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=book_a_demo#contact"}},"footer":{"socials":{"x":"https://x.com/PaywardServices","linkedin":"https://www.linkedin.com/company/payward-services"}},"fonts":{"heading":{"family":"Financier","weight":400,"source":"fonts/FinancierDisplayVF-Roman.ttf","format":"woff2"},"body":{"family":"KrakenProduct","weight":400,"source":"https://assets.kraken.com/fonts/Kraken-Product-Regular.87314a06.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode",{"title":"Download Production spec","description":"Download the Production OpenAPI specification","icon":"download","href":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json"},{"title":"Download Sandbox spec","description":"Download the Sandbox OpenAPI specification","icon":"download","href":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json"}],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"tabs":[{"tab":"Postman collection","href":"/tabs/developer-documentation/get-started/postman"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mintlify-0e856cf0","hasAudioNarration":false,"actualSubdomain":"mintlify-0e856cf0","customDomains":["docs.services.payward.com"],"gitSource":{"type":"gitlab","owner":"pws","repo":"docs","hostUrl":"https://roshi-korin.honeycrypt.com","projectId":27964,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4b22b5f2eda4fce7cd3dd","collectionId":"ac28fbfb-bffc-4add-9803-0e08c3105f5e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4b22b5f2eda4fce7cd3dd"},"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":"6ae4bd6c348296fd67018fd6","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API reference","count":276},{"language":"default","tag":"Payward Services API","count":275},{"language":"default","tag":"Sandbox","count":147},{"language":"default","tag":"Production","count":129},{"language":"default","tag":"Webhooks","count":100},{"language":"default","tag":"Funding","count":40},{"language":"default","tag":"Ramp","count":26},{"language":"default","tag":"Get Started","count":25},{"language":"default","tag":"Conversions","count":21},{"language":"default","tag":"Concepts","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"h2,h3,h4,h5,h6{font-family:var(--font-inter),sans-serif!important;font-weight:500!important;letter-spacing:0}h1{font-size:40px!important;font-weight:400!important;letter-spacing:-.025em!important}h2{font-size:24px!important}h3{font-size:20px!important}.tracking-tight{letter-spacing:.025em}[data-streamdown=strong],b,strong{font-weight:bolder!important}#sidebar-title{font-size:.875rem;font-weight:650!important}[data-component-part=card-title]{font-family:'KrakenProduct',sans-serif;font-size:16px!important;font-weight:600!important}[data-component-part=card-content]{font-size:14px!important;line-height:24px!important}#footer{flex-direction:row-reverse}[data-agent-docs-index]+*{margin-top:0!important}.api-section-heading-title{font-size:20px!important}:is(.dark, [data-theme='dark']) #topbar-cta-button a>span:first-child{background-color:#fff!important}:is(.dark, [data-theme='dark']) #topbar-cta-button a>div span,:is(.dark, [data-theme='dark']) #topbar-cta-button a>div svg{color:#0d0d0d!important}.sidebar-group{line-height:1rem!important}.endpoint-reference-table table :is(th, td):first-child{min-width:0;width:1%;white-space:nowrap}[data-radix-menu-content]{max-height:var(--radix-popper-available-height, none)!important}:not(pre)>code,:not(pre)>code *,[data-component-part=field-name],[data-component-part=field-name] *{overflow-wrap:normal!important;word-break:normal!important;hyphens:none!important}#content-area a:has(>code){border-bottom:0;text-decoration-line:underline;text-underline-offset:.2em}a[target=_blank]::after{content:'';display:inline-block;width:.85em;height:.85em;margin-inline-start:.35em;vertical-align:-.05em;flex-shrink:0;background-color:currentColor;-webkit-mask:url(/images/external-link.svg) center/contain no-repeat;mask:url(/images/external-link.svg) center/contain no-repeat}.nav-tabs-item[target=_blank]{gap:0}a[target=_blank]:has(>svg){display:inline-flex;align-items:center}#topbar-cta-button a[target=_blank] svg{display:none}#topbar-cta-button a[target=_blank]::after{position:relative;color:#fff}.docs-screenshot{border:1px solid rgba(0,0,0,.12);border-radius:20px}:is(.dark, [data-theme='dark']) .docs-screenshot{border-color:rgba(255,255,255,.12)}:not(pre)>code{padding-inline:.25em}"}],"page":{"pagePath":"api-reference/production-live/portfolio/get-portfolio","slug":"/api-reference/production-live/portfolio/get-portfolio","pageMetadata":{"title":"Get portfolio","description":"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an `_in_quote` suffix; native asset amounts omit the suffix.","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/production-live/portfolio/get-portfolio","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an \", _jsx(_components.code, {\n children: \"_in_quote\"\n }), \" suffix; native asset amounts omit the suffix.\"]\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 portfolio","description":"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an `_in_quote` suffix; native asset amounts omit the suffix.","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/production-live/portfolio/get-portfolio","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Portfolio"],"summary":"Get portfolio","description":"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an `_in_quote` suffix; native asset amounts omit the suffix.","operationId":"getPortfolio","parameters":["32c9ce72-1dc0-412c-aeb2-1a6cd6d0e9c7","53f8b001-188f-416f-bf83-83181edec1a0","2c57b8ce-309c-4fc2-8b9a-276feb92863a","d532353a-d709-4be1-b550-73f25afc6f4a"],"responses":{"200":"779a618a-7afc-45b9-8a26-44918a2977be","400":"799620e4-aa1f-4553-9d69-8c98ab09ebe0","401":"77a549d1-802b-46b7-9ac9-9163b50fa3a1","403":"9a41a499-822c-4f3c-8585-6e1f355ae433","404":"9befb5f2-2712-4d5e-9aae-fe43a5da04f0","429":"f65cccf9-3b88-4576-998d-de82837ed781","500":"5bfe152f-5e4a-444d-b91f-d4cfedde41ba","501":"a36c4e1d-09c3-424b-bc7d-68c6904acdfa","503":"0b3ca977-e33e-49a7-bd37-767ffa7bf66e","504":"bc2272d3-15b9-496a-8ea5-34220a3596d3"},"security":["8b25af00-4a0a-42a6-a66e-d89cc0d99f5b"],"method":"get","type":"path","servers":["c4ee5684-82a7-411b-9b3a-1e47b2fd86db"],"path":"/v1/accounts/{account_id}/portfolio","baseUrlOptions":["https://api.services.payward.com"],"title":"Get portfolio","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"32c9ce72-1dc0-412c-aeb2-1a6cd6d0e9c7":{"in":"query","name":"quote_symbol","schema":{"description":"Quote asset symbol.","type":"string","minLength":1,"maxLength":16,"default":"USD","uniqueKey":"","typeLabel":"string"},"style":"form","example":"USD"},"53f8b001-188f-416f-bf83-83181edec1a0":{"in":"query","name":"quote_type","schema":{"description":"Quote asset classification. Supports fiat and stablecoin.","type":"string","enum":["fiat","stablecoin"],"default":"fiat","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Quote asset classification. Supports fiat and stablecoin.","style":"form","example":"fiat"},"2c57b8ce-309c-4fc2-8b9a-276feb92863a":{"in":"query","name":"with_zero_balances","schema":{"type":"boolean","default":false,"description":"Whether to include assets with zero balances.","uniqueKey":"","typeLabel":"boolean"},"description":"Whether to include assets with zero balances.","style":"form","example":true},"d532353a-d709-4be1-b550-73f25afc6f4a":{"name":"account_id","in":"path","required":true,"example":"WVSD33HRMGSZUBM7","schema":{"description":"Globally unique public identifier for an account.","type":"string","minLength":14,"maxLength":42,"isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"779a618a-7afc-45b9-8a26-44918a2977be":{"description":"Successful response","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"A unified account portfolio snapshot.","type":"object","properties":{"as_of":{"description":"Time of the latest index-price update represented by this snapshot.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.as_of","typeLabel":"string\u003cdate-time>"},"quote":{"description":"Currency used for monetary values throughout the portfolio snapshot.","type":"object","properties":{"symbol":{"description":"Public quote-asset symbol.","type":"string","example":"USD","isRequired":true,"uniqueKey":"data.quote.symbol","typeLabel":"string"},"type":{"description":"Quote asset classification. Supports fiat and stablecoin.","type":"string","enum":["fiat","stablecoin"],"default":"fiat","isRequired":true,"uniqueKey":"data.quote.type","typeLabel":"enum\u003cstring>"},"usd_index_rate":{"description":"USD value of one unit of this quote asset. Omitted when unavailable.","type":"string","example":"1.14","uniqueKey":"data.quote.usd_index_rate","typeLabel":"string"}},"required":["symbol","type"],"isRequired":true,"uniqueKey":"data.quote","typeLabel":"object"},"total_in_quote":{"description":"Total account value across all holdings in the quote currency.","type":"string","isRequired":true,"uniqueKey":"data.total_in_quote","typeLabel":"string"},"availability":{"description":"Account-level availability and holds in the portfolio quote.","type":"object","properties":{"available_in_quote":{"description":"Funds available for trading or withdrawal after holds.","type":"string","isRequired":true,"uniqueKey":"data.availability.available_in_quote","typeLabel":"string"},"withheld":{"description":"Funds unavailable because of orders, earn allocation, or other temporary holds.","type":"object","properties":{"total_in_quote":{"description":"Total withheld value.","type":"string","isRequired":true,"uniqueKey":"data.availability.withheld.total_in_quote","typeLabel":"string"},"open_orders_in_quote":{"description":"Total value held for open orders.","type":"string","isRequired":true,"uniqueKey":"data.availability.withheld.open_orders_in_quote","typeLabel":"string"},"earn_in_quote":{"description":"Value withheld for earn products.","type":"string","isRequired":true,"uniqueKey":"data.availability.withheld.earn_in_quote","typeLabel":"string"},"other_in_quote":{"description":"Other temporary holds such as card holds, paylinks, or pending movements.","type":"string","isRequired":true,"uniqueKey":"data.availability.withheld.other_in_quote","typeLabel":"string"}},"required":["total_in_quote","open_orders_in_quote","earn_in_quote","other_in_quote"],"isRequired":true,"uniqueKey":"data.availability.withheld","typeLabel":"object"}},"required":["available_in_quote","withheld"],"isRequired":true,"uniqueKey":"data.availability","typeLabel":"object"},"assets":{"description":"Per-asset portfolio breakdown. Always present and empty when there are no assets.","type":"array","items":{"description":"Portfolio data for one asset.","type":"object","properties":{"symbol":{"description":"Public asset symbol.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].symbol","typeLabel":"string"},"type":{"description":"Asset classification for portfolio resources.","type":"string","enum":["fiat","crypto","xstock","stablecoin","equity"],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"balances":{"description":"Asset balance and its value in the top-level portfolio quote, with optional breakdowns by account balance source. `main` includes balances used by spot trading and balances received from swaps; it is not a transaction-origin classification. `total` is the native-asset sum of all balance sources, and `total_in_quote` is the quoted value of that same total.","type":"object","properties":{"total":{"description":"Total balance across all sources in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the total balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.total_in_quote","typeLabel":"string"},"main":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.main.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.main.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.main","typeLabel":"object"},"custody_pledged_collateral":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.custody_pledged_collateral.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.custody_pledged_collateral.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.custody_pledged_collateral","typeLabel":"object"},"custody_otc_trading":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.custody_otc_trading.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.custody_otc_trading.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.custody_otc_trading","typeLabel":"object"},"dual_currency_investment":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.dual_currency_investment.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.dual_currency_investment.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.dual_currency_investment","typeLabel":"object"},"custody_staking":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.custody_staking.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.custody_staking.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.custody_staking","typeLabel":"object"},"kraken_launch":{"description":"Balance held in one account balance source.","type":"object","properties":{"total":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances.kraken_launch.total","typeLabel":"string"},"total_in_quote":{"description":"Value of the balance in the top-level portfolio quote.","type":"string","uniqueKey":"data.assets.items.[INDEX].balances.kraken_launch.total_in_quote","typeLabel":"string"}},"required":["total"],"uniqueKey":"data.assets.items.[INDEX].balances.kraken_launch","typeLabel":"object"}},"required":["total"],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].balances","typeLabel":"object"},"index_price_in_quote":{"description":"Price of one unit of the asset in the top-level portfolio quote.","type":"string","minLength":1,"maxLength":64,"pattern":"^[0-9]+(\\.[0-9]+)?$","uniqueKey":"data.assets.items.[INDEX].index_price_in_quote","typeLabel":"string"},"held_for_orders":{"description":"Native asset amounts held for open orders.","type":"object","properties":{"main":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].held_for_orders.main.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].held_for_orders.main","typeLabel":"object"},"equities":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].held_for_orders.equities.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].held_for_orders.equities","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].held_for_orders","typeLabel":"object"},"earn":{"description":"Earn balances grouped by strategy liquidity.","type":"object","properties":{"locked":{"description":"Two views of the same earn total: lifecycle state and yield source. Do not add the lifecycle and yield-source breakdowns together.","type":"object","properties":{"total":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.total.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.total","typeLabel":"object"},"earning":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.earning.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.earning","typeLabel":"object"},"bonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.bonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.bonding","typeLabel":"object"},"unbonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.unbonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.unbonding","typeLabel":"object"},"exit_queue":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.exit_queue.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.exit_queue","typeLabel":"object"},"by_yield_source":{"description":"Earn total decomposed by yield source.","type":"object","properties":{"staking":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.staking.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.staking","typeLabel":"object"},"opt_in_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.opt_in_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.opt_in_rewards","typeLabel":"object"},"base_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.base_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source.base_rewards","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.locked.by_yield_source","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.locked","typeLabel":"object"},"flex":{"description":"Two views of the same earn total: lifecycle state and yield source. Do not add the lifecycle and yield-source breakdowns together.","type":"object","properties":{"total":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.total.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.total","typeLabel":"object"},"earning":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.earning.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.earning","typeLabel":"object"},"bonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.bonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.bonding","typeLabel":"object"},"unbonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.unbonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.unbonding","typeLabel":"object"},"exit_queue":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.exit_queue.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.exit_queue","typeLabel":"object"},"by_yield_source":{"description":"Earn total decomposed by yield source.","type":"object","properties":{"staking":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.staking.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.staking","typeLabel":"object"},"opt_in_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.opt_in_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.opt_in_rewards","typeLabel":"object"},"base_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.base_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source.base_rewards","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.flex.by_yield_source","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.flex","typeLabel":"object"},"hybrid":{"description":"Two views of the same earn total: lifecycle state and yield source. Do not add the lifecycle and yield-source breakdowns together.","type":"object","properties":{"total":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.total.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.total","typeLabel":"object"},"earning":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.earning.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.earning","typeLabel":"object"},"bonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.bonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.bonding","typeLabel":"object"},"unbonding":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.unbonding.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.unbonding","typeLabel":"object"},"exit_queue":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.exit_queue.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.exit_queue","typeLabel":"object"},"by_yield_source":{"description":"Earn total decomposed by yield source.","type":"object","properties":{"staking":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.staking.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.staking","typeLabel":"object"},"opt_in_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.opt_in_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.opt_in_rewards","typeLabel":"object"},"base_rewards":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.base_rewards.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source.base_rewards","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.hybrid.by_yield_source","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn.hybrid","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].earn","typeLabel":"object"},"availability":{"description":"Asset amounts available for specific actions.","type":"object","properties":{"trade":{"description":"Amount available for trading, in the asset's native display units.","type":"string","uniqueKey":"data.assets.items.[INDEX].availability.trade","typeLabel":"string"},"transfer":{"description":"Amount available for internal transfer, in the asset's native display units.","type":"string","uniqueKey":"data.assets.items.[INDEX].availability.transfer","typeLabel":"string"}},"uniqueKey":"data.assets.items.[INDEX].availability","typeLabel":"object"},"credit_line":{"description":"Credit usage and total limit. Remaining credit is limit minus used.","type":"object","properties":{"used":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].credit_line.used.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].credit_line.used","typeLabel":"object"},"limit":{"description":"An amount in the asset's native display units.","type":"object","properties":{"amount":{"description":"Balance in the asset's native display units.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].credit_line.limit.amount","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.assets.items.[INDEX].credit_line.limit","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].credit_line","typeLabel":"object"},"pnl":{"description":"Per-asset average-cost-basis PnL in the top-level portfolio quote.","type":"object","properties":{"reference_currency":{"description":"Currency Portfolio uses as the PnL calculation basis.","type":"object","properties":{"symbol":{"description":"Public symbol of the PnL reference currency.","type":"string","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].pnl.reference_currency.symbol","typeLabel":"string"},"type":{"description":"Asset classification for portfolio resources.","type":"string","enum":["fiat","crypto","xstock","stablecoin","equity"],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].pnl.reference_currency.type","typeLabel":"enum\u003cstring>"}},"required":["symbol","type"],"uniqueKey":"data.assets.items.[INDEX].pnl.reference_currency","typeLabel":"object"},"unrealized_in_quote":{"description":"Lots-based unrealized PnL.","type":"string","uniqueKey":"data.assets.items.[INDEX].pnl.unrealized_in_quote","typeLabel":"string"},"realized_in_quote":{"description":"Realized PnL.","type":"string","uniqueKey":"data.assets.items.[INDEX].pnl.realized_in_quote","typeLabel":"string"},"cost_basis_in_quote":{"description":"Total value spent to acquire the current balance.","type":"string","uniqueKey":"data.assets.items.[INDEX].pnl.cost_basis_in_quote","typeLabel":"string"},"avg_entry_price_in_quote":{"description":"Volume-weighted average acquisition price.","type":"string","minLength":1,"maxLength":64,"pattern":"^[0-9]+(\\.[0-9]+)?$","uniqueKey":"data.assets.items.[INDEX].pnl.avg_entry_price_in_quote","typeLabel":"string"},"status":{"description":"Readiness of average-cost-basis calculations.","type":"object","properties":{"avg_entry_price":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.assets.items.[INDEX].pnl.status.avg_entry_price","typeLabel":"enum\u003cstring>"},"cost_basis":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.assets.items.[INDEX].pnl.status.cost_basis","typeLabel":"enum\u003cstring>"},"unrealized":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.assets.items.[INDEX].pnl.status.unrealized","typeLabel":"enum\u003cstring>"},"realized":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.assets.items.[INDEX].pnl.status.realized","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.assets.items.[INDEX].pnl.status","typeLabel":"object"}},"uniqueKey":"data.assets.items.[INDEX].pnl","typeLabel":"object"}},"required":["symbol","type","balances"],"uniqueKey":"data.assets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.assets","typeLabel":"object[]"},"pnl":{"description":"Account-level average-cost-basis PnL in the portfolio quote.","type":"object","properties":{"reference_currency":{"description":"Currency Portfolio uses as the PnL calculation basis.","type":"object","properties":{"symbol":{"description":"Public symbol of the PnL reference currency.","type":"string","isRequired":true,"uniqueKey":"data.pnl.reference_currency.symbol","typeLabel":"string"},"type":{"description":"Asset classification for portfolio resources.","type":"string","enum":["fiat","crypto","xstock","stablecoin","equity"],"isRequired":true,"uniqueKey":"data.pnl.reference_currency.type","typeLabel":"enum\u003cstring>"}},"required":["symbol","type"],"uniqueKey":"data.pnl.reference_currency","typeLabel":"object"},"unrealized_in_quote":{"description":"Lots-based unrealized PnL.","type":"string","uniqueKey":"data.pnl.unrealized_in_quote","typeLabel":"string"},"realized_in_quote":{"description":"Realized PnL.","type":"string","uniqueKey":"data.pnl.realized_in_quote","typeLabel":"string"},"cost_basis_in_quote":{"description":"Total cost basis.","type":"string","uniqueKey":"data.pnl.cost_basis_in_quote","typeLabel":"string"},"status":{"description":"Readiness of average-cost-basis calculations.","type":"object","properties":{"avg_entry_price":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.pnl.status.avg_entry_price","typeLabel":"enum\u003cstring>"},"cost_basis":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.pnl.status.cost_basis","typeLabel":"enum\u003cstring>"},"unrealized":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.pnl.status.unrealized","typeLabel":"enum\u003cstring>"},"realized":{"description":"Processing state for a PnL calculation. `ready` means the value is complete. `in_progress` means calculation is still running, and the corresponding value may be absent or not final.","type":"string","enum":["ready","in_progress"],"uniqueKey":"data.pnl.status.realized","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.pnl.status","typeLabel":"object"}},"uniqueKey":"data.pnl","typeLabel":"object"}},"required":["as_of","quote","total_in_quote","availability","assets"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"portfolio":{"title":"portfolio","value":{"data":{"as_of":"2026-08-25T12:34:56Z","quote":{"symbol":"USD","type":"fiat","usd_index_rate":"1"},"total_in_quote":"41000.00","availability":{"available_in_quote":"30000.00","withheld":{"total_in_quote":"11000.00","open_orders_in_quote":"2000.00","earn_in_quote":"4000.00","other_in_quote":"5000.00"}},"pnl":{"unrealized_in_quote":"3500.00","realized_in_quote":"-3.7440","reference_currency":{"symbol":"USD","type":"fiat"},"status":{"unrealized":"ready","realized":"in_progress"}},"assets":[{"symbol":"BTC","type":"crypto","index_price_in_quote":"62000.00","balances":{"total":"0.5","total_in_quote":"31000.00","main":{"total":"0.5","total_in_quote":"31000.00"}},"availability":{"trade":"0.5"},"pnl":{"avg_entry_price_in_quote":"55000.00","cost_basis_in_quote":"27500.00","unrealized_in_quote":"3500.00","reference_currency":{"symbol":"USD","type":"fiat"},"status":{"avg_entry_price":"ready","cost_basis":"ready","unrealized":"ready","realized":"in_progress"}}},{"symbol":"USD","type":"fiat","index_price_in_quote":"1","balances":{"total":"10000.00","total_in_quote":"10000.00","main":{"total":"10000.00","total_in_quote":"10000.00"}}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"799620e4-aa1f-4553-9d69-8c98ab09ebe0":{"description":"Validation error","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Bad Request","description":"Error envelope for request validation failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for request validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":400,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["bad_request"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","description":"A single request validation failure.","required":["field","message"],"properties":{"field":{"type":"string","description":"Dot-notation path to the offending request field.","isRequired":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the failed validation rule.","isRequired":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Validation failures that contributed to the error.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Bad Request · object"},{"type":"object","title":"Gateway","description":"Gateway-level validation failure returned before the request reaches the service.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for request validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":400,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","description":"A single request validation failure.","required":["field","message"],"properties":{"field":{"type":"string","description":"Dot-notation path to the offending request field.","isRequired":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the failed validation rule.","isRequired":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Validation failures that contributed to the error.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Bad Request · object | Gateway · object"},"examples":{"invalid-request":{"title":"invalid-request","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":400,"code":"bad_request","causes":[{"field":"account_id","message":"must be a valid account identifier"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"77a549d1-802b-46b7-9ac9-9163b50fa3a1":{"description":"Authentication required","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Unauthenticated","description":"Error envelope for operational or domain failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":401,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unauthenticated"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Unauthenticated · object"},{"type":"object","title":"Gateway","description":"Authentication failure returned by the API gateway.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":401,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Unauthenticated · object | Gateway · object"},"examples":{"authentication-failed":{"title":"authentication-failed","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":401,"code":"unauthenticated"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9a41a499-822c-4f3c-8585-6e1f355ae433":{"description":"Forbidden","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Forbidden","description":"Error envelope for operational or domain failures.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"oneOf.0.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":403,"isRequired":true,"uniqueKey":"oneOf.0.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.0.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["forbidden"],"isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.0.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.0.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Forbidden · object"},{"type":"object","title":"Gateway","description":"Authorization failure returned by the API gateway.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","const":"service_error","isRequired":true,"uniqueKey":"oneOf.1.error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":403,"isRequired":true,"uniqueKey":"oneOf.1.error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"oneOf.1.error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","const":"gateway","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"oneOf.1.error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"oneOf.1.error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"oneOf.1.error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Gateway · object"}],"uniqueKey":"","typeLabel":"Forbidden · object | Gateway · object"},"examples":{"caller-is-not-allowed":{"title":"caller-is-not-allowed","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":403,"code":"forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9befb5f2-2712-4d5e-9aae-fe43a5da04f0":{"description":"Not found","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The requested resource was not found.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":404,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"not-found":{"title":"not-found","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":404,"code":"not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f65cccf9-3b88-4576-998d-de82837ed781":{"description":"Rate limit exceeded","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The request was rate limited or a resource quota was exhausted.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":429,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["resource_exhausted"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate-limit-exceeded":{"title":"rate-limit-exceeded","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":429,"code":"resource_exhausted"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5bfe152f-5e4a-444d-b91f-d4cfedde41ba":{"description":"Internal server error","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"An unexpected server-side error occurred.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":500,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["internal"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internal-error":{"title":"internal-error","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":500,"code":"internal"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a36c4e1d-09c3-424b-bc7d-68c6904acdfa":{"description":"Error response","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The requested operation is not implemented.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":501,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unimplemented"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"not-implemented":{"title":"not-implemented","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":501,"code":"unimplemented"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0b3ca977-e33e-49a7-bd37-767ffa7bf66e":{"description":"Service unavailable","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The service is temporarily unavailable.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":503,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"service-unavailable":{"title":"service-unavailable","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":503,"code":"unavailable"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bc2272d3-15b9-496a-8ea5-34220a3596d3":{"description":"Deadline exceeded","headers":{"X-Trace-Id":{"description":"Trace identifier for the request. Include it when contacting support.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}},"Strict-Transport-Security":{"description":"Enforces HTTPS for the duration specified by `max-age`.","schema":{"type":"string","example":"max-age=31536000; includeSubDomains; preload"}},"Cache-Control":{"description":"Prevents caching of sensitive financial data. Always `no-store`.","schema":{"type":"string","enum":["no-store"],"example":"no-store"}}},"content":{"application/json":{"schema":{"type":"object","description":"The request deadline was exceeded before a response could be produced.","required":["error"],"properties":{"error":{"type":"object","description":"Standard PWS API error object for non-validation failures.","required":["status","code","type","instance"],"properties":{"type":{"type":"string","description":"Machine-readable error class.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code returned for this error.","format":"int32","const":504,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer\u003cint32>"},"instance":{"type":"string","description":"Request identifier for this specific error occurrence.","isRequired":true,"uniqueKey":"error.instance","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code.","enum":["deadline_exceeded"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Optional link to documentation for this error.","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"causes":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.causes.items.[INDEX]","typeLabel":"object"},"description":"Additional error details, when present.","uniqueKey":"error.causes","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"request-deadline-exceeded":{"title":"request-deadline-exceeded","value":{"error":{"type":"portfolio_error","instance":"5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b","status":504,"code":"deadline_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8b25af00-4a0a-42a6-a66e-d89cc0d99f5b":{"ApiKey":{"type":"apiKey","in":"header","name":"API-Key","description":"Your public API key. Identifies the partner making the request.","scopes":[],"schemeName":"ApiKey"},"ApiSign":{"type":"apiKey","in":"header","name":"API-Sign","description":"HMAC signature over the request, computed with your private key.","scopes":[],"schemeName":"ApiSign"},"ApiNonce":{"type":"apiKey","in":"header","name":"API-Nonce","description":"Monotonically increasing nonce included in the request signature.","scopes":[],"schemeName":"ApiNonce"}}},"servers":{"c4ee5684-82a7-411b-9b3a-1e47b2fd86db":{"url":"https://api.services.payward.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"API-Key","description":"Your public API key. Identifies the partner making the request.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"API-Key","type":"string","description":"Your public API key. Identifies the partner making the request.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"API-Key"},{"scheme":{"type":"apiKey","in":"header","name":"API-Sign","description":"HMAC signature over the request, computed with your private key.","scopes":[],"schemeName":"ApiSign"},"schema":{"title":"API-Sign","type":"string","description":"HMAC signature over the request, computed with your private key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiSign","name":"API-Sign"},{"scheme":{"type":"apiKey","in":"header","name":"API-Nonce","description":"Monotonically increasing nonce included in the request signature.","scopes":[],"schemeName":"ApiNonce"},"schema":{"title":"API-Nonce","type":"string","description":"Monotonically increasing nonce included in the request signature.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiNonce","name":"API-Nonce"}],"title":"ApiKey \u0026 ApiSign \u0026 ApiNonce"}]},"originalFileLocation":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json"},"subdomain":"mintlify-0e856cf0","siteName":"Payward Developer Documentation","title":"Get portfolio - Payward Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T16:50:51.567Z","originalFileLocation":"api-reference/production-live/portfolio/get-portfolio.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 one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payward Developer 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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get portfolio - Payward Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payward Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mintlify-0e856cf0.mintlify.app/_mintlify/api/og/v2?division=Portfolio\u0026amp;title=Get+portfolio\u0026amp;description=Returns+one+account+portfolio+snapshot+containing+account-level+values+and+the+per-asset+breakdown.+Quote-denominated+monetary+amounts+use+an+%60_in_quote%60+suffix\u0026amp;theme=5b6df5bc8950a2e4e73d16b5\u0026amp;signature=28805a48e292828e251c6a53a24df2329fa596f4ee93f9677f14f091810d1189\">\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 portfolio - Payward Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mintlify-0e856cf0.mintlify.app/_mintlify/api/og/v2?division=Portfolio\u0026amp;title=Get+portfolio\u0026amp;description=Returns+one+account+portfolio+snapshot+containing+account-level+values+and+the+per-asset+breakdown.+Quote-denominated+monetary+amounts+use+an+%60_in_quote%60+suffix\u0026amp;theme=5b6df5bc8950a2e4e73d16b5\u0026amp;signature=28805a48e292828e251c6a53a24df2329fa596f4ee93f9677f14f091810d1189\">\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/mintlify-0e856cf0/qCKiWMQ7t-C00--C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payward Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D0D0D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/production-live/portfolio/get-portfolio.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.services.payward.com/#organization\",\"name\":\"Payward Developer Documentation\",\"url\":\"https://docs.services.payward.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mintlify-0e856cf0/MS2nSfkmrBCPqOvg/logo/light.svg?fit=max\u0026auto=format\u0026n=MS2nSfkmrBCPqOvg\u0026q=85\u0026s=38bcfc0cb2a1e7c2a308a1de91e5e778\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.services.payward.com#website\",\"name\":\"Payward Developer Documentation\",\"url\":\"https://docs.services.payward.com\",\"publisher\":{\"@id\":\"https://docs.services.payward.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio#webpage\",\"url\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio\",\"name\":\"Get portfolio\",\"description\":\"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.\",\"dateModified\":\"2026-10-28T16:50:51.567Z\",\"isPartOf\":{\"@id\":\"https://docs.services.payward.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payward Services API\",\"item\":\"https://docs.services.payward.com/api-reference/production-live/assets/list-assets\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get portfolio\",\"item\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio#apireference\",\"headline\":\"Get portfolio\",\"name\":\"Get portfolio\",\"description\":\"Returns one account portfolio snapshot containing account-level values and the per-asset breakdown. Quote-denominated monetary amounts use an _in_quote suffix; native asset amounts omit the suffix.\",\"url\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio\",\"mainEntityOfPage\":{\"@id\":\"https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio#webpage\"},\"dateModified\":\"2026-10-28T16:50:51.567Z\",\"publisher\":{\"@id\":\"https://docs.services.payward.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.services.payward.com#website\"}}]}\u003c/script>","siteName":"Payward Developer Documentation","nav":{"global":{"tabs":[{"tab":"Postman collection","href":"/tabs/developer-documentation/get-started/postman"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/tabs/concepts/overview"}]},{"tab":"Integration guides","pages":[{"title":"Integration guides","href":"/tabs/guides/overview"}]},{"tab":"API reference","dropdowns":[{"dropdown":"Production","icon":"server","description":"API reference for the production environment","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/api-reference"},{"group":"Payward Services API","expanded":true,"pages":[{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets","href":"/api-reference/production-live/assets/list-assets"},{"title":"Get asset","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}","href":"/api-reference/production-live/assets/get-asset"},{"title":"List asset rates","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/production-live/assets/list-asset-rates"},{"title":"List user assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets","href":"/api-reference/production-live/assets/list-user-assets"},{"title":"Get user asset","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}","href":"/api-reference/production-live/assets/get-user-asset"},{"title":"List user asset rates","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/production-live/assets/list-user-asset-rates"}]},{"group":"Conversions","pages":[{"title":"List on-demand conversions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/production-live/conversions/list-on-demand-conversions"},{"title":"Execute on-demand conversion","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/production-live/conversions/execute-on-demand-conversion"},{"title":"Get on-demand conversion","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/production-live/conversions/get-on-demand-conversion"},{"title":"List conversion rules","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions","href":"/api-reference/production-live/conversions/list-conversion-rules"},{"title":"Create conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/conversions","href":"/api-reference/production-live/conversions/create-conversion-rule"},{"title":"Get conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/get-conversion-rule"},{"title":"Update conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json put /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/update-conversion-rule"},{"title":"Delete conversion rule","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/production-live/conversions/delete-conversion-rule"},{"title":"List conversion rule transactions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}/transactions","href":"/api-reference/production-live/conversions/list-conversion-rule-transactions"}]},{"group":"Earn","pages":[{"title":"Get Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto","href":"/api-reference/production-live/earn/get-auto-earn-preferences"},{"title":"Set Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/accounts/{account_id}/earn/auto","href":"/api-reference/production-live/earn/set-auto-earn-preferences"},{"title":"Get Auto Earn allocations","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/allocations","href":"/api-reference/production-live/earn/get-auto-earn-allocations"},{"title":"Get account Auto Earn assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/assets","href":"/api-reference/production-live/earn/get-account-auto-earn-assets"},{"title":"Get Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards","href":"/api-reference/production-live/earn/get-auto-earn-rewards"},{"title":"Get Auto Earn assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/earn/auto/assets","href":"/api-reference/production-live/earn/get-auto-earn-assets"}]},{"group":"Funding","pages":[{"title":"Look up funding method metadata","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/methods/lookup","href":"/api-reference/production-live/funding/look-up-funding-method-metadata"},{"title":"Create deposit","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits","href":"/api-reference/production-live/funding/create-deposit"},{"title":"List deposit methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/methods","href":"/api-reference/production-live/funding/list-deposit-methods"},{"title":"Activate deposit method","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/methods/{method_id}/activation","href":"/api-reference/production-live/funding/activate-deposit-method"},{"title":"List deposit limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/limits/{asset_symbol}","href":"/api-reference/production-live/funding/list-deposit-limits"},{"title":"List withdrawal methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/methods","href":"/api-reference/production-live/funding/list-withdrawal-methods"},{"title":"List withdrawal limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/limits/{asset_symbol}","href":"/api-reference/production-live/funding/list-withdrawal-limits"},{"title":"List withdrawal holds","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/holds","href":"/api-reference/production-live/funding/list-withdrawal-holds"},{"title":"Calculate funding fees","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/fees","href":"/api-reference/production-live/funding/calculate-funding-fees"},{"title":"Create withdrawal","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/withdrawals","href":"/api-reference/production-live/funding/create-withdrawal"},{"title":"List deposit addresses","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/production-live/funding/list-deposit-addresses"},{"title":"Claim deposit address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/production-live/funding/claim-deposit-address"},{"title":"List funding addresses","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/production-live/funding/list-funding-addresses"},{"title":"Create funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/production-live/funding/create-funding-address"},{"title":"Create Lightning invoice","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/lightning-invoices","href":"/api-reference/production-live/funding/create-lightning-invoice"},{"title":"Get funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/get-funding-address"},{"title":"Delete funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/delete-funding-address"},{"title":"Update funding address","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/production-live/funding/update-funding-address"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/transfers","href":"/api-reference/production-live/funding/create-transfer"},{"title":"Simulate funding deposit","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/testing/deposit","href":"/api-reference/production-live/funding/simulate-funding-deposit"}]},{"group":"Derivative transfers","pages":[{"title":"Create derivatives transfer","description":"Creates a transfer between the selected account's spot and futures balances.\n\nThis operation is not idempotent. If the outcome is unknown, reconcile the balances before retrying.","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/transfers/derivatives","href":"/api-reference/production-live/derivative-transfers/create-derivatives-transfer"}]},{"group":"Portfolio","pages":[{"title":"Get portfolio","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/production-live/portfolio/get-portfolio"},{"title":"List portfolio history","description":"Returns daily portfolio valuation snapshots for an account over the requested time window. Use `assets` to include per-asset balances for selected holdings.","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio/history","href":"/api-reference/production-live/portfolio/list-portfolio-history"},{"title":"List portfolio transactions","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/portfolio/transactions","href":"/api-reference/production-live/portfolio/list-portfolio-transactions"}]},{"group":"Ramp","pages":[{"title":"List bank links","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/production-live/ramp/list-bank-links"},{"title":"Create bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/production-live/ramp/create-bank-link"},{"title":"List Ramp buy cryptocurrency assets","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/buy/crypto","href":"/api-reference/production-live/ramp/list-ramp-buy-cryptocurrency-assets"},{"title":"Get Ramp checkout URL","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/checkout","href":"/api-reference/production-live/ramp/get-ramp-checkout-url"},{"title":"List Ramp countries","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/countries","href":"/api-reference/production-live/ramp/list-ramp-countries"},{"title":"List Ramp fiat currencies","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/fiat-currencies","href":"/api-reference/production-live/ramp/list-ramp-fiat-currencies"},{"title":"Get Ramp limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/limits","href":"/api-reference/production-live/ramp/get-ramp-limits"},{"title":"List Ramp payment methods","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/payment-methods","href":"/api-reference/production-live/ramp/list-ramp-payment-methods"},{"title":"Get Ramp prospective quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/ramp/quotes/prospective","href":"/api-reference/production-live/ramp/get-ramp-prospective-quote"},{"title":"Create Ramp checkout session","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/ramp/checkouts","href":"/api-reference/production-live/ramp/create-ramp-checkout-session"},{"title":"Get bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/production-live/ramp/get-bank-link"},{"title":"Unlink bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/production-live/ramp/unlink-bank-link"},{"title":"Reconnect bank link","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect","href":"/api-reference/production-live/ramp/reconnect-bank-link"}]},{"group":"Reports","pages":[{"title":"List settlement reports","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/reports/settlement","href":"/api-reference/production-live/reports/list-settlement-reports"},{"title":"Get settlement report","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/reports/settlement/{id}","href":"/api-reference/production-live/reports/get-settlement-report"}]},{"group":"Swaps","pages":[{"title":"Create quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/quotes","href":"/api-reference/production-live/swaps/create-quote"},{"title":"Get quote limits","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/quotes/limits","href":"/api-reference/production-live/swaps/get-quote-limits"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/quotes/{quote_id}","href":"/api-reference/production-live/swaps/get-quote"},{"title":"Execute quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/quotes/{quote_id}/execute","href":"/api-reference/production-live/swaps/execute-quote"}]},{"group":"Onchain quotes","pages":[{"title":"List onchain quotes","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/production-live/onchain-quotes/list-onchain-quotes"},{"title":"Create onchain quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/production-live/onchain-quotes/create-onchain-quote"},{"title":"Get soft quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes/soft","href":"/api-reference/production-live/onchain-quotes/get-soft-quote"},{"title":"Get onchain quote","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes/{quote_id}","href":"/api-reference/production-live/onchain-quotes/get-onchain-quote"}]},{"group":"Price trigger swaps","pages":[{"title":"List price-triggered swaps","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/production-live/price-trigger-swaps/list-price-triggered-swaps"},{"title":"Create price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/production-live/price-trigger-swaps/create-price-triggered-swap"},{"title":"Get price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}","href":"/api-reference/production-live/price-trigger-swaps/get-price-triggered-swap"},{"title":"Cancel price-triggered swap","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}/cancel","href":"/api-reference/production-live/price-trigger-swaps/cancel-price-triggered-swap"}]},{"group":"Travel Rule verifications","pages":[{"title":"Create Travel Rule verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/travel-rule/verifications","href":"/api-reference/production-live/travel-rule-verifications/create-travel-rule-verification"},{"title":"Get Travel Rule verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/travel-rule/verifications/{verification_id}","href":"/api-reference/production-live/travel-rule-verifications/get-travel-rule-verification"}]},{"group":"Users","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users","href":"/api-reference/production-live/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}","href":"/api-reference/production-live/users/get-user"}]},{"group":"Verifications","pages":[{"title":"Get verification requirements","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/users/{user_id}/verifications/requirements","href":"/api-reference/production-live/verifications/get-verification-requirements"},{"title":"Create hosted verification","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/users/{user_id}/verifications/hosted","href":"/api-reference/production-live/verifications/create-hosted-verification"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks","href":"/api-reference/production-live/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks","href":"/api-reference/production-live/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/get-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json delete /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json patch /v1/webhooks/{webhook_id}","href":"/api-reference/production-live/webhooks/update-webhook"},{"title":"List webhook attempts","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json get /v1/webhooks/{webhook_id}/attempts","href":"/api-reference/production-live/webhooks/list-webhook-attempts"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks/{webhook_id}/secret/rotate","href":"/api-reference/production-live/webhooks/rotate-webhook-secret"},{"title":"Send webhook test event","deprecated":null,"version":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json post /v1/webhooks/{webhook_id}/test","href":"/api-reference/production-live/webhooks/send-webhook-test-event"},{"title":"Quote executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.executed","href":"/api-reference/production-live/webhooks/quote-executed"},{"title":"Quote canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.cancelled","href":"/api-reference/production-live/webhooks/quote-canceled"},{"title":"Quote execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook quote.execution_failed","href":"/api-reference/production-live/webhooks/quote-execution-failed"},{"title":"User closed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook user.closed","href":"/api-reference/production-live/webhooks/user-closed"},{"title":"User disabled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook user.disabled","href":"/api-reference/production-live/webhooks/user-disabled"},{"title":"Conversion deposit completed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_completed","href":"/api-reference/production-live/webhooks/conversion-deposit-completed"},{"title":"Conversion deposit failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_failed","href":"/api-reference/production-live/webhooks/conversion-deposit-failed"},{"title":"Conversion deposit held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.deposit_held","href":"/api-reference/production-live/webhooks/conversion-deposit-held"},{"title":"Conversion withdrawal completed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.withdrawal_completed","href":"/api-reference/production-live/webhooks/conversion-withdrawal-completed"},{"title":"Conversion withdrawal failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.withdrawal_failed","href":"/api-reference/production-live/webhooks/conversion-withdrawal-failed"},{"title":"Conversion quote execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.quote_execution_failed","href":"/api-reference/production-live/webhooks/conversion-quote-execution-failed"},{"title":"Conversion blocked by travel rule","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.travel_rule_blocked","href":"/api-reference/production-live/webhooks/conversion-blocked-by-travel-rule"},{"title":"Conversion quote executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook conversion.quote_executed","href":"/api-reference/production-live/webhooks/conversion-quote-executed"},{"title":"Swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.swap","href":"/api-reference/production-live/webhooks/swap-transaction-changed"},{"title":"Price trigger swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.price_trigger_swap","href":"/api-reference/production-live/webhooks/price-trigger-swap-transaction-changed"},{"title":"Earn reward transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.earn_reward","href":"/api-reference/production-live/webhooks/earn-reward-transaction-changed"},{"title":"Deposit transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.deposit","href":"/api-reference/production-live/webhooks/deposit-transaction-changed"},{"title":"Withdrawal transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.withdrawal","href":"/api-reference/production-live/webhooks/withdrawal-transaction-changed"},{"title":"Transfer transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.transfer","href":"/api-reference/production-live/webhooks/transfer-transaction-changed"},{"title":"Recurring swap transaction changed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook transaction.recurring_swap","href":"/api-reference/production-live/webhooks/recurring-swap-transaction-changed"},{"title":"Deposit received","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_received","href":"/api-reference/production-live/webhooks/deposit-received"},{"title":"Deposit held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_held","href":"/api-reference/production-live/webhooks/deposit-held"},{"title":"Deposit credited","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_credited","href":"/api-reference/production-live/webhooks/deposit-credited"},{"title":"Deposit returned","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_returned","href":"/api-reference/production-live/webhooks/deposit-returned"},{"title":"Deposit failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.deposit_failed","href":"/api-reference/production-live/webhooks/deposit-failed"},{"title":"Withdrawal held","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_held","href":"/api-reference/production-live/webhooks/withdrawal-held"},{"title":"Withdrawal complete","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_complete","href":"/api-reference/production-live/webhooks/withdrawal-complete"},{"title":"Withdrawal failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook funds.withdrawal_failed","href":"/api-reference/production-live/webhooks/withdrawal-failed"},{"title":"Verification requirements updated","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook verification.requirements_updated","href":"/api-reference/production-live/webhooks/verification-requirements-updated"},{"title":"Verification updated","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook verification.updated","href":"/api-reference/production-live/webhooks/verification-updated"},{"title":"Price trigger swap executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.executed","href":"/api-reference/production-live/webhooks/price-trigger-swap-executed"},{"title":"Price trigger swap execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.execution_failed","href":"/api-reference/production-live/webhooks/price-trigger-swap-execution-failed"},{"title":"Price trigger swap canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.cancelled","href":"/api-reference/production-live/webhooks/price-trigger-swap-canceled"},{"title":"Price trigger swap created","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.created","href":"/api-reference/production-live/webhooks/price-trigger-swap-created"},{"title":"Price trigger swap failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook price_trigger_swap.failed","href":"/api-reference/production-live/webhooks/price-trigger-swap-failed"},{"title":"Recurring swap created","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.created","href":"/api-reference/production-live/webhooks/recurring-swap-created"},{"title":"Recurring swap executed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.executed","href":"/api-reference/production-live/webhooks/recurring-swap-executed"},{"title":"Recurring swap execution failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.execution_failed","href":"/api-reference/production-live/webhooks/recurring-swap-execution-failed"},{"title":"Recurring swap canceled","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.cancelled","href":"/api-reference/production-live/webhooks/recurring-swap-canceled"},{"title":"Recurring swap failed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.failed","href":"/api-reference/production-live/webhooks/recurring-swap-failed"},{"title":"Recurring swap paused","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.paused","href":"/api-reference/production-live/webhooks/recurring-swap-paused"},{"title":"Recurring swap resumed","version":null,"deprecated":null,"openapi":"https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json webhook recurring_swap.resumed","href":"/api-reference/production-live/webhooks/recurring-swap-resumed"}]}]}]},{"dropdown":"Sandbox","icon":"flask","description":"API reference for the sandbox environment","groups":[{"group":"Payward Services API","expanded":true,"pages":[{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets","href":"/api-reference/sandbox/assets/list-assets"},{"title":"Get asset","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}","href":"/api-reference/sandbox/assets/get-asset"},{"title":"List asset rates","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/sandbox/assets/list-asset-rates"},{"title":"List user assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets","href":"/api-reference/sandbox/assets/list-user-assets"},{"title":"Get user asset","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}","href":"/api-reference/sandbox/assets/get-user-asset"},{"title":"List user asset rates","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/assets/{asset_type}/{asset_symbol}/rates","href":"/api-reference/sandbox/assets/list-user-asset-rates"}]},{"group":"Conversions","pages":[{"title":"List on-demand conversions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/sandbox/conversions/list-on-demand-conversions"},{"title":"Execute on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions","href":"/api-reference/sandbox/conversions/execute-on-demand-conversion"},{"title":"Estimate on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/estimate","href":"/api-reference/sandbox/conversions/estimate-on-demand-conversion"},{"title":"Prepare on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/prepare","href":"/api-reference/sandbox/conversions/prepare-on-demand-conversion"},{"title":"Get on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/sandbox/conversions/get-on-demand-conversion"},{"title":"Execute prepared on-demand conversion","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/on-demand-conversions/{conversion_id}","href":"/api-reference/sandbox/conversions/execute-prepared-on-demand-conversion"},{"title":"List conversion rules","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions","href":"/api-reference/sandbox/conversions/list-conversion-rules"},{"title":"Create conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/conversions","href":"/api-reference/sandbox/conversions/create-conversion-rule"},{"title":"Get conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/get-conversion-rule"},{"title":"Update conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json put /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/update-conversion-rule"},{"title":"Delete conversion rule","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/conversions/{conversion_rule_id}","href":"/api-reference/sandbox/conversions/delete-conversion-rule"},{"title":"List conversion rule transactions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/conversions/{conversion_rule_id}/transactions","href":"/api-reference/sandbox/conversions/list-conversion-rule-transactions"}]},{"group":"Auto Earn","pages":[{"title":"Get Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto","href":"/api-reference/sandbox/auto-earn/get-auto-earn-preferences"},{"title":"Set Auto Earn preferences","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/accounts/{account_id}/earn/auto","href":"/api-reference/sandbox/auto-earn/set-auto-earn-preferences"},{"title":"Get Auto Earn allocations","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/allocations","href":"/api-reference/sandbox/auto-earn/get-auto-earn-allocations"},{"title":"Get account Auto Earn assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/assets","href":"/api-reference/sandbox/auto-earn/get-account-auto-earn-assets"},{"title":"Get Auto Earn reward summary","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/summary","href":"/api-reference/sandbox/auto-earn/get-auto-earn-reward-summary"},{"title":"List Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards","href":"/api-reference/sandbox/auto-earn/list-auto-earn-rewards"},{"title":"List upcoming Auto Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/auto/rewards/upcoming","href":"/api-reference/sandbox/auto-earn/list-upcoming-auto-earn-rewards"},{"title":"Get Auto Earn assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/earn/auto/assets","href":"/api-reference/sandbox/auto-earn/get-auto-earn-assets"}]},{"group":"Bonded Earn","pages":[{"title":"Allocate to a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/allocate","href":"/api-reference/sandbox/bonded-earn/allocate-to-a-bonded-earn-strategy"},{"title":"Deallocate from a Bonded Earn strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/earn/bonded/strategies/{strategy_id}/deallocate","href":"/api-reference/sandbox/bonded-earn/deallocate-from-a-bonded-earn-strategy"},{"title":"List Bonded Earn allocations","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocations","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-allocations"},{"title":"List Bonded Earn allocation states","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocation-states","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-allocation-states"},{"title":"List pending Bonded Earn requests","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests","href":"/api-reference/sandbox/bonded-earn/list-pending-bonded-earn-requests"},{"title":"Get Bonded Earn request status","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/requests/{request_id}","href":"/api-reference/sandbox/bonded-earn/get-bonded-earn-request-status"},{"title":"List account Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/strategies","href":"/api-reference/sandbox/bonded-earn/list-account-bonded-earn-strategies"},{"title":"Get Bonded Earn reward summary","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/summary","href":"/api-reference/sandbox/bonded-earn/get-bonded-earn-reward-summary"},{"title":"List Bonded Earn rewards by strategy","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-rewards-by-strategy"},{"title":"List upcoming Bonded Earn rewards","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/rewards/upcoming","href":"/api-reference/sandbox/bonded-earn/list-upcoming-bonded-earn-rewards"},{"title":"List Bonded Earn strategies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/earn/bonded/strategies","href":"/api-reference/sandbox/bonded-earn/list-bonded-earn-strategies"}]},{"group":"Funding","pages":[{"title":"Look up funding method metadata","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/methods/lookup","href":"/api-reference/sandbox/funding/look-up-funding-method-metadata"},{"title":"Create deposit","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits","href":"/api-reference/sandbox/funding/create-deposit"},{"title":"List deposit methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/methods","href":"/api-reference/sandbox/funding/list-deposit-methods"},{"title":"Activate deposit method","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/methods/{method_id}/activation","href":"/api-reference/sandbox/funding/activate-deposit-method"},{"title":"List deposit limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/limits/{asset_symbol}","href":"/api-reference/sandbox/funding/list-deposit-limits"},{"title":"List withdrawal methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/methods","href":"/api-reference/sandbox/funding/list-withdrawal-methods"},{"title":"List withdrawal limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/limits/{asset_symbol}","href":"/api-reference/sandbox/funding/list-withdrawal-limits"},{"title":"List withdrawal holds","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/withdrawals/holds","href":"/api-reference/sandbox/funding/list-withdrawal-holds"},{"title":"Calculate funding fees","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/fees","href":"/api-reference/sandbox/funding/calculate-funding-fees"},{"title":"Create withdrawal","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/withdrawals","href":"/api-reference/sandbox/funding/create-withdrawal"},{"title":"List deposit addresses","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/sandbox/funding/list-deposit-addresses"},{"title":"Claim deposit address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/addresses","href":"/api-reference/sandbox/funding/claim-deposit-address"},{"title":"List funding addresses","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/sandbox/funding/list-funding-addresses"},{"title":"Create funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/addresses","href":"/api-reference/sandbox/funding/create-funding-address"},{"title":"Create Lightning invoice","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/deposits/lightning-invoices","href":"/api-reference/sandbox/funding/create-lightning-invoice"},{"title":"Get funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/get-funding-address"},{"title":"Delete funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/delete-funding-address"},{"title":"Update funding address","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/accounts/{account_id}/funds/addresses/{address_id}","href":"/api-reference/sandbox/funding/update-funding-address"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/transfers","href":"/api-reference/sandbox/funding/create-transfer"},{"title":"Simulate funding deposit","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/testing/deposit","href":"/api-reference/sandbox/funding/simulate-funding-deposit"}]},{"group":"Derivative transfers","pages":[{"title":"Create derivatives transfer","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/transfers/derivatives","href":"/api-reference/sandbox/derivative-transfers/create-derivatives-transfer"}]},{"group":"Portfolio","pages":[{"title":"Get portfolio","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio","href":"/api-reference/sandbox/portfolio/get-portfolio"},{"title":"List portfolio history","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio/history","href":"/api-reference/sandbox/portfolio/list-portfolio-history"},{"title":"List portfolio transactions","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/portfolio/transactions","href":"/api-reference/sandbox/portfolio/list-portfolio-transactions"}]},{"group":"Ramp","pages":[{"title":"List bank links","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/sandbox/ramp/list-bank-links"},{"title":"Create bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links","href":"/api-reference/sandbox/ramp/create-bank-link"},{"title":"List Ramp buy cryptocurrency assets","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/buy/crypto","href":"/api-reference/sandbox/ramp/list-ramp-buy-cryptocurrency-assets"},{"title":"Get Ramp checkout URL","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/checkout","href":"/api-reference/sandbox/ramp/get-ramp-checkout-url"},{"title":"List Ramp countries","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/countries","href":"/api-reference/sandbox/ramp/list-ramp-countries"},{"title":"List Ramp fiat currencies","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/fiat-currencies","href":"/api-reference/sandbox/ramp/list-ramp-fiat-currencies"},{"title":"Get Ramp limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/limits","href":"/api-reference/sandbox/ramp/get-ramp-limits"},{"title":"List Ramp payment methods","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/payment-methods","href":"/api-reference/sandbox/ramp/list-ramp-payment-methods"},{"title":"Get Ramp prospective quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/ramp/quotes/prospective","href":"/api-reference/sandbox/ramp/get-ramp-prospective-quote"},{"title":"Create Ramp checkout session","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/ramp/checkouts","href":"/api-reference/sandbox/ramp/create-ramp-checkout-session"},{"title":"Get bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/sandbox/ramp/get-bank-link"},{"title":"Unlink bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}","href":"/api-reference/sandbox/ramp/unlink-bank-link"},{"title":"Reconnect bank link","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect","href":"/api-reference/sandbox/ramp/reconnect-bank-link"}]},{"group":"Reports","pages":[{"title":"List settlement reports","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/reports/settlement","href":"/api-reference/sandbox/reports/list-settlement-reports"},{"title":"Get settlement report","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/reports/settlement/{id}","href":"/api-reference/sandbox/reports/get-settlement-report"}]},{"group":"Swaps","pages":[{"title":"Create quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/quotes","href":"/api-reference/sandbox/swaps/create-quote"},{"title":"Get quote limits","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/quotes/limits","href":"/api-reference/sandbox/swaps/get-quote-limits"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/quotes/{quote_id}","href":"/api-reference/sandbox/swaps/get-quote"},{"title":"Execute quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/quotes/{quote_id}/execute","href":"/api-reference/sandbox/swaps/execute-quote"}]},{"group":"Onchain quotes","pages":[{"title":"List onchain quotes","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/sandbox/onchain-quotes/list-onchain-quotes"},{"title":"Create onchain quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes","href":"/api-reference/sandbox/onchain-quotes/create-onchain-quote"},{"title":"Get soft quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/onchain-quotes/soft","href":"/api-reference/sandbox/onchain-quotes/get-soft-quote"},{"title":"Get onchain quote","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/onchain-quotes/{quote_id}","href":"/api-reference/sandbox/onchain-quotes/get-onchain-quote"}]},{"group":"Price trigger swaps","pages":[{"title":"List price-triggered swaps","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/sandbox/price-trigger-swaps/list-price-triggered-swaps"},{"title":"Create price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps","href":"/api-reference/sandbox/price-trigger-swaps/create-price-triggered-swap"},{"title":"Get price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}","href":"/api-reference/sandbox/price-trigger-swaps/get-price-triggered-swap"},{"title":"Cancel price-triggered swap","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/accounts/{account_id}/price-trigger-swaps/{price_trigger_swap_id}/cancel","href":"/api-reference/sandbox/price-trigger-swaps/cancel-price-triggered-swap"}]},{"group":"Travel Rule verifications","pages":[{"title":"Create Travel Rule verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/travel-rule/verifications","href":"/api-reference/sandbox/travel-rule-verifications/create-travel-rule-verification"},{"title":"Get Travel Rule verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/travel-rule/verifications/{verification_id}","href":"/api-reference/sandbox/travel-rule-verifications/get-travel-rule-verification"}]},{"group":"Users","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users","href":"/api-reference/sandbox/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}","href":"/api-reference/sandbox/users/get-user"},{"title":"Create user account","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/accounts","href":"/api-reference/sandbox/users/create-user-account"}]},{"group":"Verifications","pages":[{"title":"Get verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications/{verification_id}","href":"/api-reference/sandbox/verifications/get-verification"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications","href":"/api-reference/sandbox/verifications/list-verifications"},{"title":"Get verification requirements","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/users/{user_id}/verifications/requirements","href":"/api-reference/sandbox/verifications/get-verification-requirements"},{"title":"Create hosted verification","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/verifications/hosted","href":"/api-reference/sandbox/verifications/create-hosted-verification"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks","href":"/api-reference/sandbox/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks","href":"/api-reference/sandbox/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/get-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json delete /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/delete-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json patch /v1/webhooks/{webhook_id}","href":"/api-reference/sandbox/webhooks/update-webhook"},{"title":"List webhook attempts","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/webhooks/{webhook_id}/attempts","href":"/api-reference/sandbox/webhooks/list-webhook-attempts"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks/{webhook_id}/secret/rotate","href":"/api-reference/sandbox/webhooks/rotate-webhook-secret"},{"title":"Send webhook test event","deprecated":null,"version":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/webhooks/{webhook_id}/test","href":"/api-reference/sandbox/webhooks/send-webhook-test-event"},{"title":"Quote executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.executed","href":"/api-reference/sandbox/webhooks/quote-executed"},{"title":"Quote canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.cancelled","href":"/api-reference/sandbox/webhooks/quote-canceled"},{"title":"Quote execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook quote.execution_failed","href":"/api-reference/sandbox/webhooks/quote-execution-failed"},{"title":"User closed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook user.closed","href":"/api-reference/sandbox/webhooks/user-closed"},{"title":"User disabled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook user.disabled","href":"/api-reference/sandbox/webhooks/user-disabled"},{"title":"Conversion deposit completed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_completed","href":"/api-reference/sandbox/webhooks/conversion-deposit-completed"},{"title":"Conversion deposit failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_failed","href":"/api-reference/sandbox/webhooks/conversion-deposit-failed"},{"title":"Conversion deposit held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.deposit_held","href":"/api-reference/sandbox/webhooks/conversion-deposit-held"},{"title":"Conversion withdrawal completed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.withdrawal_completed","href":"/api-reference/sandbox/webhooks/conversion-withdrawal-completed"},{"title":"Conversion withdrawal failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.withdrawal_failed","href":"/api-reference/sandbox/webhooks/conversion-withdrawal-failed"},{"title":"Conversion quote execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.quote_execution_failed","href":"/api-reference/sandbox/webhooks/conversion-quote-execution-failed"},{"title":"Conversion blocked by travel rule","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.travel_rule_blocked","href":"/api-reference/sandbox/webhooks/conversion-blocked-by-travel-rule"},{"title":"Conversion quote executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook conversion.quote_executed","href":"/api-reference/sandbox/webhooks/conversion-quote-executed"},{"title":"Swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.swap","href":"/api-reference/sandbox/webhooks/swap-transaction-changed"},{"title":"Price trigger swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.price_trigger_swap","href":"/api-reference/sandbox/webhooks/price-trigger-swap-transaction-changed"},{"title":"Earn reward transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.earn_reward","href":"/api-reference/sandbox/webhooks/earn-reward-transaction-changed"},{"title":"Deposit transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.deposit","href":"/api-reference/sandbox/webhooks/deposit-transaction-changed"},{"title":"Withdrawal transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.withdrawal","href":"/api-reference/sandbox/webhooks/withdrawal-transaction-changed"},{"title":"Transfer transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.transfer","href":"/api-reference/sandbox/webhooks/transfer-transaction-changed"},{"title":"Recurring swap transaction changed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook transaction.recurring_swap","href":"/api-reference/sandbox/webhooks/recurring-swap-transaction-changed"},{"title":"Deposit received","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_received","href":"/api-reference/sandbox/webhooks/deposit-received"},{"title":"Deposit held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_held","href":"/api-reference/sandbox/webhooks/deposit-held"},{"title":"Deposit credited","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_credited","href":"/api-reference/sandbox/webhooks/deposit-credited"},{"title":"Deposit returned","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_returned","href":"/api-reference/sandbox/webhooks/deposit-returned"},{"title":"Deposit failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.deposit_failed","href":"/api-reference/sandbox/webhooks/deposit-failed"},{"title":"Withdrawal held","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_held","href":"/api-reference/sandbox/webhooks/withdrawal-held"},{"title":"Withdrawal complete","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_complete","href":"/api-reference/sandbox/webhooks/withdrawal-complete"},{"title":"Withdrawal failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook funds.withdrawal_failed","href":"/api-reference/sandbox/webhooks/withdrawal-failed"},{"title":"Verification requirements updated","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook verification.requirements_updated","href":"/api-reference/sandbox/webhooks/verification-requirements-updated"},{"title":"Verification updated","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook verification.updated","href":"/api-reference/sandbox/webhooks/verification-updated"},{"title":"Price trigger swap executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.executed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-executed"},{"title":"Price trigger swap execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.execution_failed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-execution-failed"},{"title":"Price trigger swap canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.cancelled","href":"/api-reference/sandbox/webhooks/price-trigger-swap-canceled"},{"title":"Price trigger swap created","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.created","href":"/api-reference/sandbox/webhooks/price-trigger-swap-created"},{"title":"Price trigger swap failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook price_trigger_swap.failed","href":"/api-reference/sandbox/webhooks/price-trigger-swap-failed"},{"title":"Recurring swap created","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.created","href":"/api-reference/sandbox/webhooks/recurring-swap-created"},{"title":"Recurring swap executed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.executed","href":"/api-reference/sandbox/webhooks/recurring-swap-executed"},{"title":"Recurring swap execution failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.execution_failed","href":"/api-reference/sandbox/webhooks/recurring-swap-execution-failed"},{"title":"Recurring swap canceled","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.cancelled","href":"/api-reference/sandbox/webhooks/recurring-swap-canceled"},{"title":"Recurring swap failed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.failed","href":"/api-reference/sandbox/webhooks/recurring-swap-failed"},{"title":"Recurring swap paused","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.paused","href":"/api-reference/sandbox/webhooks/recurring-swap-paused"},{"title":"Recurring swap resumed","version":null,"deprecated":null,"openapi":"https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json webhook recurring_swap.resumed","href":"/api-reference/sandbox/webhooks/recurring-swap-resumed"}]}]}]}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/tabs/changelog/overview"}]}]},"basePath":"","title":"Get portfolio - Payward Developer Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}