{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Coinbase Developer Documentation","colors":{"primary":"#004cec","light":"#578BFA","dark":"#0052FF"},"logo":{"light":"https://mintcdn.com/coinbase-prod/B68gj-lD9xkJGij4/logos/wordmark-light.svg?fit=max\u0026auto=format\u0026n=B68gj-lD9xkJGij4\u0026q=85\u0026s=0eb5640aeec58541851e1cba9c6ccc8b","dark":"https://mintcdn.com/coinbase-prod/B68gj-lD9xkJGij4/logos/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=B68gj-lD9xkJGij4\u0026q=85\u0026s=53721303b967eaae0304eee4d72b76a4"},"favicon":"https://mintcdn.com/coinbase-prod/kTyZlKSi8mNup8M7/favicon.png?fit=max\u0026auto=format\u0026n=kTyZlKSi8mNup8M7\u0026q=85\u0026s=e20bf52c43e47cfc76215fb56ff3bc09","appearance":{"default":"light"},"navbar":{"links":[{"icon":"discord","href":"https://discord.com/invite/cdp","label":"Get help"}],"primary":{"type":"button","label":"Dev portal","href":"https://portal.cdp.coinbase.com/"}},"footer":{"socials":{"x":"https://x.com/coinbasedev","github":"https://github.com/coinbase","linkedin":"https://www.linkedin.com/company/coinbasedeveloperplatform"},"links":[{"items":[{"label":"Join CDP Discord","href":"https://discord.com/invite/cdp"},{"label":"Status","href":"https://cdpstatus.coinbase.com/"},{"label":"Privacy Policy","href":"https://www.coinbase.com/legal/privacy"}]}]},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"CoinbaseSans","source":"https://mintlify-assets.b-cdn.net/fonts/CoinbaseSans-Regular.woff2","format":"woff2"},"body":{"family":"CoinbaseSans","source":"https://mintlify-assets.b-cdn.net/fonts/CoinbaseSans-Regular.woff2","format":"woff2"}},"integrations":{"amplitude":{"apiKey":"6cf69a22c0014f7608dd967f605ba0e7"},"ga4":{"measurementId":"G-1X60WF4D7F"},"customScripts":[{"src":"https://static-assets.coinbase.com/js/ucpm/v1.0.0.js","strategy":"beforeInteractive"}]},"contextual":{"options":["copy","view","mcp","cursor","vscode","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coinbase-prod","hasAudioNarration":false,"actualSubdomain":"coinbase-prod","customDomains":["docs.cdp.coinbase.com"],"gitSource":{"type":"github","owner":"c3","repo":"cdp-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebaecc4b25a6dfb40d9d00","collectionId":"c26db431-8292-4320-aa58-a5951f111ef3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebaecc4b25a6dfb40d9d00"},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebaecc4b25a6dfb40d9d00","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"SDKs","count":1524},{"language":"default","tag":"CRYPTO INFRASTRUCTURE","count":1429},{"language":"default","tag":"CDP SDKs","count":1427},{"language":"default","tag":"API Reference","count":914},{"language":"default","tag":"Frontend","count":795},{"language":"default","tag":"Typescript","count":793},{"language":"default","tag":"Backend","count":632},{"language":"default","tag":"Java","count":599},{"language":"default","tag":"REST API","count":554},{"language":"default","tag":"Docs","count":513}]},"assistantConfig":{"enableAskAiButton":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"dropdowns.css","content":".nav-dropdown-content{width:var(--radix-dropdown-menu-trigger-width)}"},{"filePath":"style.css","content":"@font-face{font-family:\"Coinbase Text Medium\";src:url(\"https://mintlify-assets.b-cdn.net/fonts/coinbase/Coinbase_Text-Medium-web-1.32.woff2\")\n format(\"woff2\");font-weight:500;font-style:normal}.dark li[id=\"topbar-cta-button\"]>a>span{background-color:#578bf9!important}.dark li[id=\"topbar-cta-button\"]>a>div>svg{color:#101521!important}.dark li[id=\"topbar-cta-button\"]>a>div>span{color:#101521!important}div[data-callout-type=\"info\"]{background-color:#f5f8fe!important;color:#0052fe!important;border-color:#ccdcfe!important}div[data-callout-type=\"info\"]>div>svg{color:white!important}div[data-callout-type=\"info\"]>div>svg>path{fill:#0052fe!important}.dark div[data-callout-type=\"info\"]{background-color:#001133!important;color:#578bf9!important;border-color:#2c406c!important}.dark div[data-callout-type=\"info\"]>div>svg>path{fill:#578bf9!important}div[data-callout-type=\"note\"]{background-color:rgba(250, 250, 250, 0.5)!important;color:#578bf9!important;border-color:rgba(113, 113, 122, 0.2)!important}div[data-callout-type=\"note\"]>div>svg{color:white!important}div[data-callout-type=\"note\"]>div>ul>li{color:#18181b!important}.dark div[data-callout-type=\"note\"]>div>ul>li{color:#e4e4e7!important}div[data-callout-type=\"note\"]>div>svg>path{fill:#0052fe!important}.dark div[data-callout-type=\"note\"]{background-color:rgba(113, 113, 122, 0.1)!important;color:#578bf9!important;border-color:rgba(113, 113, 122, 0.3)!important}.dark div[data-callout-type=\"note\"]>div>svg>path{fill:#578bf9!important}.dark div[data-callout-type=\"note\"]>div>p{color:#e4e4e7!important}div[data-callout-type=\"note\"]>div>p{color:#18181b!important}#\\/{display:none}h1,h2,span{letter-spacing:0.02em!important}h5:not(#sidebar-title),h6{font-weight:600!important;margin-top:1rem!important;margin-bottom:0.5rem!important}.nav-section-header{font-size:0.7rem!important;font-weight:600!important;text-transform:uppercase!important;letter-spacing:0.05em!important;color:#6b7280!important;padding:12px 8px 4px 8px!important;margin-bottom:4px!important}.nav-section-header.with-divider{border-top:1px solid #e5e7eb!important;margin-top:8px!important}.dark .nav-section-header{color:#9ca3af!important}.dark .nav-section-header.with-divider{border-top-color:rgba(255, 255, 255, 0.1)!important}.version-option:hover{background-color:#f1f5f9!important}.dark .version-option:hover{background-color:#4b5563!important}li[data-group-tag=\"v1\"][data-title=\"Server Wallet\"]{display:none!important}body.url-contains-v1 li[data-group-tag=\"v1\"][data-title=\"Server Wallet\"]{display:block!important}li[data-group-tag=\"v2\"][data-title=\"Server Wallet\"]{display:block!important}body.url-contains-v1 li[data-group-tag=\"v2\"][data-title=\"Server Wallet\"]{display:none!important}.nav-tag-pill-text[data-nav-tag=\"v1\"]{cursor:pointer!important;user-select:none!important;display:flex!important;align-items:center!important;padding:2px 8px!important}.nav-tag-pill-text[data-nav-tag=\"v2\"]{cursor:pointer!important;user-select:none!important;display:flex!important;align-items:center!important;padding:2px 8px!important}.nav-tag-pill-text[data-nav-tag=\"v1\"]::after,.nav-tag-pill-text[data-nav-tag=\"v2\"]::after{color:#004cec!important;content:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='0 0 24 24' fill='none' stroke='%23004cec' stroke-width='3' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m6 9 6 6 6-6'/%3E%3C/svg%3E\");margin-left:4px;padding-top:4px;opacity:0.6}#footer>div{padding-top:5rem!important;padding-bottom:4rem!important}.tab-container>ul{margin-bottom:1rem!important}.code-block{margin-top:0px!important}button[data-component-part=\"tab-button\"]{font-size:1rem!important}@media (min-width: 1024px){div[id=\"content-container\"]{padding-left:4rem!important;padding-right:1rem!important}#sidebar-content,#navbar .hidden.lg\\:flex{display:flex!important}}#sidebar-title{font-family:\"Coinbase Text Medium\", sans-serif!important;color:#111827!important;font-size:0.8rem!important;font-weight:500!important}.dark #sidebar-title{font-family:\"Coinbase Text Medium\", sans-serif!important;color:#e5e7eb!important;font-size:0.8rem!important;font-weight:500!important}img[data-component-part=\"card-image\"]{height:12rem;object-fit:cover}.home-demo-cards img[data-component-part=\"card-image\"],.learn-demo-cards img[data-component-part=\"card-image\"]{height:8rem}.frame img,[class*=\"Frame\"] img{border-radius:8px;overflow:hidden}.custom-card-group h1,.custom-card-group h2,.custom-card-group h3,.custom-card-group h4,.custom-card-group h5,.custom-card-group h6{margin-top:0!important;margin-bottom:0!important;font-size:inherit!important;font-weight:inherit!important;line-height:inherit!important}.custom-card-group a,.custom-card-group a:hover,.custom-card-group a:visited,.custom-card-group a:active{text-decoration:none!important;text-decoration-line:none!important}.custom-card-group img{margin-top:0!important;margin-bottom:0!important}.fix-table table{table-layout:fixed!important;width:100%!important}.fix-table table th:first-child,.fix-table table td:first-child{width:60px!important;white-space:nowrap!important}.fix-table table th:nth-child(3),.fix-table table td:nth-child(3){width:130px!important;white-space:nowrap!important}.fix-table table th:nth-child(4),.fix-table table td:nth-child(4){width:50px!important;white-space:nowrap!important}ul.contains-task-list{list-style:none!important;padding-left:1.5rem!important}li.task-list-item{list-style:none!important;padding-left:0!important}li.task-list-item::marker{content:none!important}li.task-list-item input[type=\"checkbox\"]{margin-right:0.5em!important}li.task-list-item::before{content:none!important;display:none!important}li.task-list-item ul{padding-left:2.5rem!important}"},{"filePath":"supported-networks.css","content":".network-support-table{width:100%;max-width:100%;overflow-x:auto;margin-bottom:1.5rem;-webkit-overflow-scrolling:touch}.network-support-table table{width:100%;table-layout:fixed;border-collapse:separate;border-spacing:0;border-radius:8px;border:1px solid #e5e7eb}[data-theme=\"dark\"] .network-support-table table,.dark .network-support-table table{border:1px solid #374151}.evm-table table th:nth-child(1),.evm-table table td:nth-child(1){width:35%}.evm-table table th:nth-child(2),.evm-table table td:nth-child(2),.evm-table table th:nth-child(3),.evm-table table td:nth-child(3),.evm-table table th:nth-child(4),.evm-table table td:nth-child(4),.evm-table table th:nth-child(5),.evm-table table td:nth-child(5){width:9%}.evm-table table th:last-child,.evm-table table td:last-child{width:29%}.non-evm-table table th:nth-child(1),.non-evm-table table td:nth-child(1){width:57.5%}.non-evm-table table th:nth-child(2),.non-evm-table table td:nth-child(2){width:6.75%}.non-evm-table table th:nth-child(3),.non-evm-table table td:nth-child(3){width:6.75%}.non-evm-table table th:last-child,.non-evm-table table td:last-child{width:29%}.network-support-table table td:nth-child(n+2):not(:last-child){text-align:center}.network-support-table table tbody tr:has(.category-header){background-color:#f3f4f6!important;border-top:2px solid #e5e7eb!important}.network-support-table table tbody tr:has(.category-header) td{padding:2px 12px!important;font-weight:600!important;border:none!important;color:#111827!important;line-height:20px!important;height:24px!important}.network-support-table table tbody tr:has(.category-header) td:empty{visibility:hidden}[data-theme=\"dark\"] .network-support-table table tbody tr:has(.category-header),.dark .network-support-table table tbody tr:has(.category-header){background-color:#374151!important;border-top:2px solid #374151!important}[data-theme=\"dark\"] .network-support-table table tbody tr:has(.category-header) td,.dark .network-support-table table tbody tr:has(.category-header) td{color:#f3f4f6!important}.network-support-table table tbody tr:has(.category-header)+tr td{padding-top:4px}.network-support-table table tbody tr:has(.category-header)+tr{border-top:none}.network-support-table table tbody tr:has(.category-header):not(:first-child){border-top:3px solid #e5e7eb}[data-theme=\"dark\"] .network-support-table table tbody tr:has(.category-header):not(:first-child),.dark .network-support-table table tbody tr:has(.category-header):not(:first-child){border-top:3px solid #374151}.network-support-table table tbody tr:not(:has(.category-header)):hover{background-color:rgba(0, 0, 0, 0.02)}[data-theme=\"dark\"] .network-support-table table tbody tr:not(:has(.category-header)):hover,.dark .network-support-table table tbody tr:not(:has(.category-header)):hover{background-color:rgba(255, 255, 255, 0.05)}.network-support-table table thead th{font-weight:600;background-color:#f9fafb;border-bottom:2px solid #e5e7eb;text-align:left!important}.network-support-table table thead th:first-child{border-top-left-radius:8px}.network-support-table table thead th:last-child{border-top-right-radius:8px}.network-support-table table tbody tr:last-child td:first-child{border-bottom-left-radius:8px}.network-support-table table tbody tr:last-child td:last-child{border-bottom-right-radius:8px}[data-theme=\"dark\"] .network-support-table table thead th,.dark .network-support-table table thead th{background-color:#1f2937;border-bottom:2px solid #374151;text-align:left!important}.network-support-table table td,.network-support-table table th{padding:8px 12px}.network-support-table tbody tr:has(td:first-child img) td,.network-support-table tbody tr:has(td:first-child>img+strong) td{padding-top:0!important;padding-bottom:0!important;height:24px!important;max-height:24px!important;overflow:hidden!important;vertical-align:middle!important;display:table-cell!important}.network-support-table table tbody tr:has(.category-header) td:first-child{text-align:center;font-size:14px;letter-spacing:0.5px;text-transform:uppercase}.category-header{display:block;width:100%}.network-support-table td:first-child strong:only-child{display:block;text-transform:uppercase;letter-spacing:0.5px;font-weight:700}.network-support-table tr:has(td:first-child>strong:only-child){background-color:#e5e7eb!important;border-top:2px solid #e5e7eb!important;height:24px!important;max-height:24px!important}.network-support-table tr:has(td:first-child>svg+strong),.network-support-table tr:has(td:first-child svg),.network-support-table tr:has(td:first-child>img+strong),.network-support-table tr:has(td:first-child img){background-color:#e5e7eb!important;border-top:2px solid #e5e7eb!important;height:24px!important;max-height:24px!important}.network-support-table tr:has(td:first-child>strong:only-child) td,.network-support-table tr:has(td:first-child>svg+strong) td,.network-support-table tr:has(td:first-child svg) td,.network-support-table tr:has(td:first-child>img+strong) td,.network-support-table tr:has(td:first-child img) td{padding:2px 12px!important;color:#374151!important;font-size:12px!important;line-height:20px!important;height:24px!important}.network-support-table tr:has(td:first-child>strong:only-child) td:first-child,.network-support-table tr:has(td:first-child>svg+strong) td:first-child,.network-support-table tr:has(td:first-child svg) td:first-child,.network-support-table tr:has(td:first-child>img+strong) td:first-child,.network-support-table tr:has(td:first-child img) td:first-child{font-size:12px!important;color:#374151!important;text-transform:uppercase!important;letter-spacing:0.8px!important;font-weight:600!important}[data-theme=\"dark\"] .network-support-table tr:has(td:first-child>strong:only-child),[data-theme=\"dark\"] .network-support-table tr:has(td:first-child>svg+strong),[data-theme=\"dark\"] .network-support-table tr:has(td:first-child svg),[data-theme=\"dark\"] .network-support-table tr:has(td:first-child>img+strong),[data-theme=\"dark\"] .network-support-table tr:has(td:first-child img),.dark .network-support-table tr:has(td:first-child>strong:only-child),.dark .network-support-table tr:has(td:first-child>svg+strong),.dark .network-support-table tr:has(td:first-child svg),.dark .network-support-table tr:has(td:first-child>img+strong),.dark .network-support-table tr:has(td:first-child img){background-color:#1f2937!important;border-top:2px solid #374151!important}[data-theme=\"dark\"] .network-support-table tr:has(td:first-child>strong:only-child) td:first-child,[data-theme=\"dark\"] .network-support-table tr:has(td:first-child>svg+strong) td:first-child,[data-theme=\"dark\"] .network-support-table tr:has(td:first-child svg) td:first-child,.dark .network-support-table tr:has(td:first-child>strong:only-child) td:first-child,.dark .network-support-table tr:has(td:first-child>svg+strong) td:first-child,.dark .network-support-table tr:has(td:first-child svg) td:first-child{color:#e5e7eb!important}.network-support-table tbody tr:first-child:has(td:first-child>strong:only-child),.network-support-table tbody tr:first-child:has(td:first-child>svg+strong),.network-support-table tbody tr:first-child:has(td:first-child svg){border-top:none!important}.network-support-table tr:has(td:first-child a){background-color:transparent!important}.network-support-table tr:has(td:first-child>img+strong) img,.network-support-table tr:has(td:first-child img) img{width:14px!important;height:14px!important;vertical-align:middle!important;margin-right:4px!important;margin-top:0!important;margin-bottom:0!important}.network-support-table tbody tr:has(td:first-child img){height:24px!important;max-height:24px!important;line-height:24px!important}.network-support-table.evm-table tbody tr:nth-child(1):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(4):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(8):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(10):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(14):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(20):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(22):has(td:first-child:has(strong)),.network-support-table.evm-table tbody tr:nth-child(24):has(td:first-child:has(strong)){background-color:#e5e7eb!important}"}],"page":{"pagePath":"api-reference/clearing-api/rest-api/trades/get-derivative-trades","slug":"/api-reference/clearing-api/rest-api/trades/get-derivative-trades","pageMetadata":{"title":"Get derivative trades","description":"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/trades/get-derivative-trades","href":"/api-reference/clearing-api/rest-api/trades/get-derivative-trades","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\"\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 derivative trades","description":"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/trades/get-derivative-trades","href":"/api-reference/clearing-api/rest-api/trades/get-derivative-trades","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coinbase-prod/6d906736c36798d6/add-scroll-gradient.js","/_mintlify/custom/coinbase-prod/e7f7008f5db24529/ai-assistant-message.js","/_mintlify/custom/coinbase-prod/af45c7ea51975839/dropdowns.js","/_mintlify/custom/coinbase-prod/06f253dee5fa900c/lint-staged.config.js","/_mintlify/custom/coinbase-prod/bef3f7e8e501ccfe/sprig.js"],"openApiReferenceData":{"operation":{"tags":["Trades"],"summary":"Get derivative trades","description":"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.","operationId":"getDerivativeTrades","requestBody":"9e654ec7-78d9-43b6-ba43-ab95c57a16df","responses":{"200":"93d8ceaf-c6ad-428d-a81c-d6cb3b5d08d6"},"method":"post","type":"path","servers":["3d6d4c4a-d8fa-45e8-9582-852640ce51d5"],"security":["02fadf0b-bd39-4104-a24a-ec88d259ed1e"],"path":"/api/trades/get-derivative-trades","baseUrlOptions":["https://{host}/cdp-api"],"title":"Get derivative trades","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Query request for trades.","required":["rangeLimit","paging"],"properties":{"rangeLimit":{"type":"integer","format":"int32","description":"Maximum number of results per page.","example":50,"isRequired":true,"uniqueKey":"rangeLimit","typeLabel":"integer\u003cint32>"},"paging":{"type":"string","description":"Page direction.","enum":["NEXT_PAGE","PREVIOUS_PAGE"],"example":"NEXT_PAGE","isRequired":true,"uniqueKey":"paging","typeLabel":"enum\u003cstring>"},"bookmark":{"oneOf":[{"type":"string","description":"Pagination cursor from the previous response. Use `null` for the first page.","example":null,"uniqueKey":"bookmark.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pagination cursor from the previous response. Use `null` for the first page.","example":null,"uniqueKey":"bookmark.oneOf.1","typeLabel":"null"}],"uniqueKey":"bookmark","typeLabel":"string | null"},"queryArgs":{"oneOf":[{"type":"object","description":"Filter and sort arguments. Use `null` to return all results unfiltered.","properties":{"trade":{"type":"object","description":"Filters on the trade entity.","properties":{"tradeKey":{"type":"object","description":"Filter by trade key.","properties":{"tradeId":{"type":"object","description":"Filter by trade ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey.tradeId","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeKey","typeLabel":"object"},"tradeType":{"type":"object","description":"Filter by trade type.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a trade type field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Type of the trade.","enum":["ORIGINAL_TRADE","CANCELLATION_TRADE","EXPIRATION_TRADE","TRANSFER"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeType.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeType.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeType","typeLabel":"object"},"tradeEntryType":{"type":"object","description":"Filter by trade entry type.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a trade entry type field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Sub-type of the trade.","enum":["REGULAR_TRADE","BLOCK","EFP","EFR","TAS","BTIC"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeEntryType","typeLabel":"object"},"dealId":{"type":"object","description":"Filter by deal ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.dealId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.dealId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.dealId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.dealId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.dealId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.dealId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.dealId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.dealId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.dealId","typeLabel":"object"},"memberId":{"type":"object","description":"Filter trades for a specific member.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.memberId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.memberId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.memberId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.memberId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.memberId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.memberId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.memberId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.memberId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.memberId","typeLabel":"object"},"accountId":{"type":"object","description":"Filter trades for a specific account.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.accountId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.accountId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.accountId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.accountId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.accountId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.accountId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.accountId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.accountId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.accountId","typeLabel":"object"},"subAccount":{"type":"object","description":"Filter by sub-account.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.subAccount.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.subAccount.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.subAccount","typeLabel":"object"},"productId":{"type":"object","description":"Filter by product ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.productId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.productId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.productId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.productId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.productId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.productId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.productId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.productId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.productId","typeLabel":"object"},"eventId":{"type":"object","description":"Filter by event ID. Typically used with event trades.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.eventId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.eventId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.eventId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.eventId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.eventId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.eventId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.eventId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.eventId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.eventId","typeLabel":"object"},"seriesId":{"type":"object","description":"Filter by series ID. Typically used with event trades.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.seriesId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.seriesId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.seriesId","typeLabel":"object"},"instrumentId":{"type":"object","description":"Filter trades for a specific instrument.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.instrumentId","typeLabel":"object"},"currency":{"type":"object","description":"Filter by currency code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.currency.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.currency.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.currency.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.currency.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.currency.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.currency.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.currency.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.currency.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.currency","typeLabel":"object"},"tradeDate":{"type":"object","description":"Filter by trade date range.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a date field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","AFTER","AFTER_OR_EQUALS","BEFORE","BEFORE_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","format":"date","description":"Date to compare, as `YYYY-MM-DD`.","example":"2026-01-01","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.filters.items.[INDEX].value","typeLabel":"string\u003cdate>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeDate","typeLabel":"object"},"clearingDate":{"type":"object","description":"Filter by clearing date.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a date field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","AFTER","AFTER_OR_EQUALS","BEFORE","BEFORE_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","format":"date","description":"Date to compare, as `YYYY-MM-DD`.","example":"2026-01-01","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.filters.items.[INDEX].value","typeLabel":"string\u003cdate>"}},"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.clearingDate","typeLabel":"object"},"tradeSide":{"type":"object","description":"Filter by `BUY` or `SELL`.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a trade side field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Buy or sell.","enum":["BUY","SELL"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSide","typeLabel":"object"},"positionEffect":{"type":"object","description":"Filter by position effect.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a position effect field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Whether the trade opens or closes a position.","enum":["OPEN","CLOSE"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.positionEffect","typeLabel":"object"},"price":{"type":"object","description":"Filter by trade price.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.price.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.price.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.price.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.price.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.price.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.price.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.price.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.price.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.price","typeLabel":"object"},"quantity":{"type":"object","description":"Filter by trade quantity.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.quantity.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.quantity.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.quantity.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.quantity.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.quantity.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.quantity.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.quantity.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.quantity.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.quantity","typeLabel":"object"},"tradeValue":{"type":"object","description":"Filter by trade value.","properties":{"amount":{"type":"object","description":"Filter by amount.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.amount","typeLabel":"object"},"currency":{"type":"object","description":"Filter by currency code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue.currency","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeValue","typeLabel":"object"},"reference":{"type":"object","description":"Filter by reference.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reference.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reference.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reference.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.reference.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.reference.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.reference.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.reference.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.reference.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.reference","typeLabel":"object"},"marketId":{"type":"object","description":"Filter by market ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a 64-bit integer field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.marketId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.marketId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","description":"Integer value to compare.","example":12345,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.marketId.filters.items.[INDEX].value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"queryArgs.oneOf.0.trade.marketId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.marketId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.marketId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.marketId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.marketId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.marketId","typeLabel":"object"},"reservedQuantity":{"type":"object","description":"Filter by reserved quantity.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.reservedQuantity","typeLabel":"object"},"availableQuantity":{"type":"object","description":"Filter by available quantity.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.availableQuantity","typeLabel":"object"},"fee":{"type":"object","description":"Filter by fee.","properties":{"amount":{"type":"object","description":"Filter by amount.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.amount","typeLabel":"object"},"currency":{"type":"object","description":"Filter by currency code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee.currency","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.fee","typeLabel":"object"},"tradeStatus":{"type":"object","description":"Filter by status: `ACTIVE`, `RESERVED`, or `INACTIVE`.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a trade status field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Current status of the trade.","enum":["ACTIVE","RESERVED","INACTIVE"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeStatus","typeLabel":"object"},"matchedTimestamp":{"type":"object","description":"Filter by match time.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a timestamp field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","AFTER","AFTER_OR_EQUALS","BEFORE","BEFORE_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","format":"date-time","description":"ISO-8601 date-time to compare.","example":"2026-01-15T14:30:00.123Z","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.filters.items.[INDEX].value","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.matchedTimestamp","typeLabel":"object"},"receivedTimestamp":{"type":"object","description":"Filter by receive time.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a timestamp field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","AFTER","AFTER_OR_EQUALS","BEFORE","BEFORE_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","format":"date-time","description":"ISO-8601 date-time to compare.","example":"2026-01-15T14:30:00.123Z","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.filters.items.[INDEX].value","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.receivedTimestamp","typeLabel":"object"},"orderId":{"type":"object","description":"Filter by order ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.orderId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.orderId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.orderId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.orderId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.orderId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.orderId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.orderId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.orderId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.orderId","typeLabel":"object"},"clOrderId":{"type":"object","description":"Filter by customer-assigned order ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.clOrderId","typeLabel":"object"},"sideExecutionId":{"type":"object","description":"Filter by side execution ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.sideExecutionId","typeLabel":"object"},"customerTypeIndicator":{"type":"object","description":"Filter by customer type indicator.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a customer type indicator field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"Customer type indicator (CTI).","enum":["CTI_1","CTI_2","CTI_3","CTI_4"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.customerTypeIndicator","typeLabel":"object"},"exchangeTradeId":{"type":"object","description":"Filter by exchange trade ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeId","typeLabel":"object"},"exchangeTradeReportId":{"type":"object","description":"Filter by exchange trade report ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchangeTradeReportId","typeLabel":"object"},"transferId":{"type":"object","description":"Filter by position transfer ID.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.transferId.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.transferId.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.transferId.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.transferId.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.transferId.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.transferId.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.transferId.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.transferId.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.transferId","typeLabel":"object"},"exchange":{"type":"object","description":"Filter by source exchange.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchange.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchange.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.exchange.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchange.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.exchange.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.exchange.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.exchange.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchange.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.exchange","typeLabel":"object"},"tradeSource":{"type":"object","description":"Filter by source: `EXCHANGE`, `MANUAL`, or `SYSTEM`.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a trade source field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"How the trade entered the clearing system.","enum":["EXCHANGE","MANUAL","SYSTEM"],"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.filters.items.[INDEX].value","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.tradeSource","typeLabel":"object"},"differentialPrice":{"type":"object","description":"Filter by differential price.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a decimal field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUALS","LESS_THAN","LESS_THAN_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Decimal number to compare.","example":142.5,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.filters.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.differentialPrice","typeLabel":"object"},"lastAction":{"type":"object","description":"Filter by last action.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.lastAction.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.lastAction.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.lastAction","typeLabel":"object"},"auditData":{"type":"object","description":"Filter by audit fields.","properties":{"lastUpdatedBy":{"type":"object","description":"Filter by the user who last updated the entity.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedBy","typeLabel":"object"},"lastUpdatedAt":{"type":"object","description":"Filter by when the entity was last updated.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a timestamp field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","AFTER","AFTER_OR_EQUALS","BEFORE","BEFORE_OR_EQUALS"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","format":"date-time","description":"ISO-8601 date-time to compare.","example":"2026-01-15T14:30:00.123Z","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.filters.items.[INDEX].value","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData.lastUpdatedAt","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade.auditData","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.trade","typeLabel":"object"},"accountCode":{"type":"object","description":"Filter by resolved account code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.accountCode.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.accountCode.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.accountCode.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.accountCode.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.accountCode.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.accountCode.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.accountCode.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.accountCode.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.accountCode","typeLabel":"object"},"clearingMemberCode":{"type":"object","description":"Filter by resolved clearing member code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.clearingMemberCode","typeLabel":"object"},"instrumentCode":{"type":"object","description":"Filter by resolved instrument code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.instrumentCode.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.instrumentCode.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.instrumentCode.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.instrumentCode.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.instrumentCode.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.instrumentCode.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.instrumentCode.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.instrumentCode.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.instrumentCode","typeLabel":"object"},"productCode":{"type":"object","description":"Filter by resolved product code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.productCode.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.productCode.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.productCode.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.productCode.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.productCode.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.productCode.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.productCode.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.productCode.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.productCode","typeLabel":"object"},"eventName":{"type":"object","description":"Filter by resolved event name.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.eventName.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.eventName.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.eventName.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.eventName.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.eventName.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.eventName.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.eventName.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.eventName.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.eventName","typeLabel":"object"},"seriesName":{"type":"object","description":"Filter by resolved series name.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.seriesName.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.seriesName.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.seriesName.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.seriesName.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.seriesName.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.seriesName.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.seriesName.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.seriesName.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.seriesName","typeLabel":"object"},"marketCode":{"type":"object","description":"Filter by resolved market code.","properties":{"filters":{"type":"array","description":"Filter conditions on this field.","items":{"type":"object","description":"Filter condition for a string field.","required":["group","operator","value"],"properties":{"group":{"type":"integer","format":"int32","description":"Filter group. Filters in the same group are combined with AND; groups are combined with OR.","example":0,"isRequired":true,"uniqueKey":"queryArgs.oneOf.0.marketCode.filters.items.[INDEX].group","typeLabel":"integer\u003cint32>"},"operator":{"type":"string","description":"Filter operator.","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH"],"example":"EQUALS","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.marketCode.filters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"String value to compare.","example":"ACC-5001","isRequired":true,"uniqueKey":"queryArgs.oneOf.0.marketCode.filters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"queryArgs.oneOf.0.marketCode.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"queryArgs.oneOf.0.marketCode.filters","typeLabel":"object[]"},"sorter":{"type":"object","description":"Sort configuration for a field.","properties":{"priority":{"type":"integer","format":"int32","description":"Sort priority. A lower value has a higher priority.","example":0,"uniqueKey":"queryArgs.oneOf.0.marketCode.sorter.priority","typeLabel":"integer\u003cint32>"},"sortingDirection":{"type":"string","description":"Sort direction.","enum":["ASCENDING","DESCENDING"],"example":"DESCENDING","uniqueKey":"queryArgs.oneOf.0.marketCode.sorter.sortingDirection","typeLabel":"enum\u003cstring>"}},"uniqueKey":"queryArgs.oneOf.0.marketCode.sorter","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0.marketCode","typeLabel":"object"}},"uniqueKey":"queryArgs.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"queryArgs.oneOf.1","typeLabel":"null"}],"uniqueKey":"queryArgs","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"bookmark":null,"queryArgs":{"trade":{"instrumentId":{"filters":[{"group":0,"operator":"EQUALS","value":12345}]},"tradeDate":{"filters":[{"group":0,"operator":"AFTER_OR_EQUALS","value":"2026-01-01"}]}}},"rangeLimit":100,"paging":"NEXT_PAGE"},"examples":{"Example":{"title":"Example","value":{"bookmark":null,"queryArgs":{"trade":{"instrumentId":{"filters":[{"group":0,"operator":"EQUALS","value":12345}]},"tradeDate":{"filters":[{"group":0,"operator":"AFTER_OR_EQUALS","value":"2026-01-01"}]}}},"rangeLimit":100,"paging":"NEXT_PAGE"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"93d8ceaf-c6ad-428d-a81c-d6cb3b5d08d6":{"description":"A page of results.","content":{"application/json":{"schema":{"type":"object","description":"Page of trades.","properties":{"bookmark":{"type":"string","description":"Cursor to fetch the next or previous page.","example":"eyJsYXN0S2V5IjoiMTAwMyJ9","uniqueKey":"bookmark","typeLabel":"string"},"atEnd":{"type":"boolean","description":"`true` when there are no more pages in the current direction.","example":false,"uniqueKey":"atEnd","typeLabel":"boolean"},"content":{"type":"array","description":"Page of trades.","items":{"type":"object","description":"Trade with resolved codes and names.","properties":{"trade":{"type":"object","description":"Trade entity.","properties":{"tradeKey":{"type":"object","description":"Unique key of the trade.","example":{"tradeId":"1001"},"properties":{"tradeId":{"type":"string","description":"Unique ID of the trade across all trades in the system.","example":"1001","uniqueKey":"content.items.[INDEX].trade.tradeKey.tradeId","typeLabel":"string"}},"uniqueKey":"content.items.[INDEX].trade.tradeKey","typeLabel":"object"},"tradeType":{"type":"string","description":"Type of the trade.","enum":["ORIGINAL_TRADE","CANCELLATION_TRADE","EXPIRATION_TRADE","TRANSFER"],"example":"ORIGINAL_TRADE","uniqueKey":"content.items.[INDEX].trade.tradeType","typeLabel":"enum\u003cstring>"},"tradeEntryType":{"type":"string","description":"Sub-type of the trade, kept on the original trade.","enum":["REGULAR_TRADE","BLOCK","EFP","EFR","TAS","BTIC"],"example":"REGULAR_TRADE","uniqueKey":"content.items.[INDEX].trade.tradeEntryType","typeLabel":"enum\u003cstring>"},"dealId":{"type":"string","description":"Deal ID, shared by all trades in the same deal (match). A deal is either a manual deal or a set of trades received from the exchange.","example":"DEAL-2026-0042","uniqueKey":"content.items.[INDEX].trade.dealId","typeLabel":"string"},"memberId":{"type":"integer","format":"int64","description":"ID of the member that owns the trade.","example":100,"uniqueKey":"content.items.[INDEX].trade.memberId","typeLabel":"integer\u003cint64>"},"accountId":{"type":"integer","format":"int64","description":"ID of the account the trade is booked on.","example":5001,"uniqueKey":"content.items.[INDEX].trade.accountId","typeLabel":"integer\u003cint64>"},"subAccount":{"type":"string","description":"Sub-account of the trade.","example":"HOUSE","uniqueKey":"content.items.[INDEX].trade.subAccount","typeLabel":"string"},"productId":{"oneOf":[{"type":"object","description":"ID of the product. Only applicable to derivative markets.","example":{"value":200},"properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200,"uniqueKey":"content.items.[INDEX].trade.productId.oneOf.0.value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"content.items.[INDEX].trade.productId.oneOf.0","typeLabel":"object"},{"type":"null","description":"ID of the product. Only applicable to derivative markets.","example":{"value":200},"properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200}},"uniqueKey":"content.items.[INDEX].trade.productId.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"content.items.[INDEX].trade.productId.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.productId","typeLabel":"object · null · null"},"eventId":{"oneOf":[{"type":"object","description":"ID of the event. Populated for event (prediction market) trades.","properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200,"uniqueKey":"content.items.[INDEX].trade.eventId.oneOf.0.value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"content.items.[INDEX].trade.eventId.oneOf.0","typeLabel":"object"},{"type":"null","description":"ID of the event. Populated for event (prediction market) trades.","properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200}},"uniqueKey":"content.items.[INDEX].trade.eventId.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"content.items.[INDEX].trade.eventId.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.eventId","typeLabel":"object · null · null"},"seriesId":{"oneOf":[{"type":"object","description":"ID of the series. Populated for event (prediction market) trades.","properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200,"uniqueKey":"content.items.[INDEX].trade.seriesId.oneOf.0.value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"content.items.[INDEX].trade.seriesId.oneOf.0","typeLabel":"object"},{"type":"null","description":"ID of the series. Populated for event (prediction market) trades.","properties":{"value":{"type":"integer","format":"int64","description":"The value.","example":200}},"uniqueKey":"content.items.[INDEX].trade.seriesId.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"content.items.[INDEX].trade.seriesId.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.seriesId","typeLabel":"object · null · null"},"instrumentId":{"type":"integer","format":"int64","description":"ID of the traded instrument.","example":12345,"uniqueKey":"content.items.[INDEX].trade.instrumentId","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"Code of the currency the trade value is denominated in.","example":"USDC","uniqueKey":"content.items.[INDEX].trade.currency","typeLabel":"string"},"tradeDate":{"type":"string","format":"date","description":"Business date the trade was placed or matched, as `YYYY-MM-DD`.","example":"2026-01-15","uniqueKey":"content.items.[INDEX].trade.tradeDate","typeLabel":"string\u003cdate>"},"clearingDate":{"type":"string","format":"date","description":"Clearing business date, as `YYYY-MM-DD`. Determined from the trade date and when the trade should be cleared.","example":"2026-01-15","uniqueKey":"content.items.[INDEX].trade.clearingDate","typeLabel":"string\u003cdate>"},"tradeSide":{"type":"string","description":"Whether the trade is a buy or a sell.","enum":["BUY","SELL"],"example":"BUY","uniqueKey":"content.items.[INDEX].trade.tradeSide","typeLabel":"enum\u003cstring>"},"positionEffect":{"type":"string","description":"Whether the trade opens or closes a position. For information only.","enum":["OPEN","CLOSE"],"example":"OPEN","uniqueKey":"content.items.[INDEX].trade.positionEffect","typeLabel":"enum\u003cstring>"},"price":{"type":"number","description":"Trade price.","example":142.5,"uniqueKey":"content.items.[INDEX].trade.price","typeLabel":"number"},"quantity":{"type":"number","description":"Trade quantity, in absolute terms. The trade side indicates whether the quantity is received or delivered. Greater than 0.","minimum":0,"exclusiveMinimum":true,"example":10,"uniqueKey":"content.items.[INDEX].trade.quantity","typeLabel":"number"},"tradeValue":{"type":"object","description":"Trade value, in absolute terms. The trade side indicates whether it is a credit or a debit.","example":{"amount":1425,"currency":"USDC"},"properties":{"amount":{"type":"number","description":"Amount.","example":1425,"uniqueKey":"content.items.[INDEX].trade.tradeValue.amount","typeLabel":"number"},"currency":{"type":"string","description":"Currency code.","example":"USDC","uniqueKey":"content.items.[INDEX].trade.tradeValue.currency","typeLabel":"string"}},"uniqueKey":"content.items.[INDEX].trade.tradeValue","typeLabel":"object"},"reference":{"oneOf":[{"type":"string","description":"Free-text reference or reason for creating or updating the trade, or a value from the trade message.","example":null,"uniqueKey":"content.items.[INDEX].trade.reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-text reference or reason for creating or updating the trade, or a value from the trade message.","example":null,"uniqueKey":"content.items.[INDEX].trade.reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.reference","typeLabel":"string | null"},"marketId":{"type":"integer","format":"int64","description":"ID of the market the instrument belongs to.","example":1,"uniqueKey":"content.items.[INDEX].trade.marketId","typeLabel":"integer\u003cint64>"},"reservedQuantity":{"type":"number","description":"Quantity reserved pending a trade management action.","example":0,"uniqueKey":"content.items.[INDEX].trade.reservedQuantity","typeLabel":"number"},"availableQuantity":{"type":"number","description":"Quantity still available for further trade management, such as allocation or give-up.","example":10,"uniqueKey":"content.items.[INDEX].trade.availableQuantity","typeLabel":"number"},"fee":{"type":"object","description":"Fee amount received on the trade from the exchange, with up to 6 decimal places.","example":{"amount":1.25,"currency":"USDC"},"properties":{"amount":{"type":"number","description":"Amount.","example":1425,"uniqueKey":"content.items.[INDEX].trade.fee.amount","typeLabel":"number"},"currency":{"type":"string","description":"Currency code.","example":"USDC","uniqueKey":"content.items.[INDEX].trade.fee.currency","typeLabel":"string"}},"uniqueKey":"content.items.[INDEX].trade.fee","typeLabel":"object"},"tradeStatus":{"type":"string","description":"Status of the trade. Indicates which actions can be performed on the trade and whether it currently contributes to a position.","enum":["ACTIVE","RESERVED","INACTIVE"],"example":"ACTIVE","uniqueKey":"content.items.[INDEX].trade.tradeStatus","typeLabel":"enum\u003cstring>"},"matchedTimestamp":{"type":"string","format":"date-time","description":"Date and time the trade was matched at the exchange, in ISO-8601. Set by the user for manual trades.","example":"2026-01-15T14:30:00.123Z","uniqueKey":"content.items.[INDEX].trade.matchedTimestamp","typeLabel":"string\u003cdate-time>"},"receivedTimestamp":{"type":"string","format":"date-time","description":"Date and time the trade was received by the clearing system, in ISO-8601.","example":"2026-01-15T14:30:00.100Z","uniqueKey":"content.items.[INDEX].trade.receivedTimestamp","typeLabel":"string\u003cdate-time>"},"orderId":{"type":"string","description":"Unique ID of the order or trade, when received from the exchange.","example":"ORD-98765","uniqueKey":"content.items.[INDEX].trade.orderId","typeLabel":"string"},"clOrderId":{"type":"string","description":"Order ID assigned by the customer.","example":"CLIENT-ORD-001","uniqueKey":"content.items.[INDEX].trade.clOrderId","typeLabel":"string"},"sideExecutionId":{"type":"string","description":"Side execution ID, as received in the trade message.","example":"EXEC-54321","uniqueKey":"content.items.[INDEX].trade.sideExecutionId","typeLabel":"string"},"customerTypeIndicator":{"type":"string","description":"Customer type indicator (CTI) of the trade.","enum":["CTI_1","CTI_2","CTI_3","CTI_4"],"example":"CTI_1","uniqueKey":"content.items.[INDEX].trade.customerTypeIndicator","typeLabel":"enum\u003cstring>"},"exchangeTradeId":{"type":"string","description":"Exchange ID that links all trades in a deal. Used to reconcile with the exchange.","example":"EXT-DEAL-2026-0042","uniqueKey":"content.items.[INDEX].trade.exchangeTradeId","typeLabel":"string"},"exchangeTradeReportId":{"oneOf":[{"type":"string","description":"Unique ID from the exchange trade message. Changes with each message, including cancellations. Received as a UUIDv7.","example":null,"uniqueKey":"content.items.[INDEX].trade.exchangeTradeReportId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique ID from the exchange trade message. Changes with each message, including cancellations. Received as a UUIDv7.","example":null,"uniqueKey":"content.items.[INDEX].trade.exchangeTradeReportId.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.exchangeTradeReportId","typeLabel":"string | null"},"transferId":{"oneOf":[{"type":"string","description":"Position transfer ID. Set when the trade type is `TRANSFER`.","example":null,"uniqueKey":"content.items.[INDEX].trade.transferId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Position transfer ID. Set when the trade type is `TRANSFER`.","example":null,"uniqueKey":"content.items.[INDEX].trade.transferId.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.transferId","typeLabel":"string | null"},"exchange":{"type":"string","description":"Exchange the trade came from, usually a MIC code. Exactly 4 uppercase letters or digits.","minLength":4,"maxLength":4,"pattern":"^[A-Z0-9]+$","example":"XCME","uniqueKey":"content.items.[INDEX].trade.exchange","typeLabel":"string"},"tradeSource":{"type":"string","description":"How the trade entered the clearing system: received from an exchange, entered by a clearing operator, or created by the system.","enum":["EXCHANGE","MANUAL","SYSTEM"],"example":"EXCHANGE","uniqueKey":"content.items.[INDEX].trade.tradeSource","typeLabel":"enum\u003cstring>"},"differentialPrice":{"oneOf":[{"type":"number","description":"Price adjustment relative to the settlement price, charged on the next settlement run. Only applicable to `BTIC` and `TAS` trades.","example":null,"uniqueKey":"content.items.[INDEX].trade.differentialPrice.oneOf.0","typeLabel":"number"},{"type":"null","description":"Price adjustment relative to the settlement price, charged on the next settlement run. Only applicable to `BTIC` and `TAS` trades.","example":null,"uniqueKey":"content.items.[INDEX].trade.differentialPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.differentialPrice","typeLabel":"number | null"},"refTradeId":{"type":"array","items":{"type":"string","uniqueKey":"content.items.[INDEX].trade.refTradeId.items.[INDEX]","typeLabel":"string"},"description":"References to the original trades, when trades were created by trade management actions or a trade cancellation.","example":[],"uniqueKey":"content.items.[INDEX].trade.refTradeId","typeLabel":"string[]"},"lastAction":{"oneOf":[{"type":"string","description":"Last action that created or changed the trade.","example":null,"uniqueKey":"content.items.[INDEX].trade.lastAction.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last action that created or changed the trade.","example":null,"uniqueKey":"content.items.[INDEX].trade.lastAction.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].trade.lastAction","typeLabel":"string | null"},"auditData":{"type":"object","description":"Audit data.","example":{"lastUpdatedBy":"system","lastUpdatedAt":"2026-01-15T14:30:00.150Z"},"properties":{"lastUpdatedBy":{"type":"string","description":"ID of the user who created or last updated the entity.","example":"system","uniqueKey":"content.items.[INDEX].trade.auditData.lastUpdatedBy","typeLabel":"string"},"lastUpdatedAt":{"type":"string","format":"date-time","description":"Date and time when the entity was last updated.","example":"2026-01-15T14:30:00.150Z","uniqueKey":"content.items.[INDEX].trade.auditData.lastUpdatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"content.items.[INDEX].trade.auditData","typeLabel":"object"}},"uniqueKey":"content.items.[INDEX].trade","typeLabel":"object"},"accountCode":{"type":"string","description":"Resolved account code.","example":"ACC-5001","uniqueKey":"content.items.[INDEX].accountCode","typeLabel":"string"},"clearingMemberCode":{"type":"string","description":"Resolved clearing member code.","example":"CM-100","uniqueKey":"content.items.[INDEX].clearingMemberCode","typeLabel":"string"},"instrumentCode":{"type":"string","description":"Resolved instrument code.","example":"BTCUSD-FUT-MAR26","uniqueKey":"content.items.[INDEX].instrumentCode","typeLabel":"string"},"productCode":{"oneOf":[{"type":"string","description":"Resolved product code. Only applicable to derivative markets.","example":"BTC-FUTURES","uniqueKey":"content.items.[INDEX].productCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved product code. Only applicable to derivative markets.","example":"BTC-FUTURES","uniqueKey":"content.items.[INDEX].productCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].productCode","typeLabel":"string | null"},"eventName":{"oneOf":[{"type":"string","description":"Resolved event name. Only applicable to prediction markets.","example":null,"uniqueKey":"content.items.[INDEX].eventName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved event name. Only applicable to prediction markets.","example":null,"uniqueKey":"content.items.[INDEX].eventName.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].eventName","typeLabel":"string | null"},"seriesName":{"oneOf":[{"type":"string","description":"Resolved series name. Only applicable to prediction markets.","example":null,"uniqueKey":"content.items.[INDEX].seriesName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved series name. Only applicable to prediction markets.","example":null,"uniqueKey":"content.items.[INDEX].seriesName.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.items.[INDEX].seriesName","typeLabel":"string | null"},"marketCode":{"type":"string","description":"Resolved market code.","example":"CME","uniqueKey":"content.items.[INDEX].marketCode","typeLabel":"string"}},"uniqueKey":"content.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"bookmark":"eyJsYXN0S2V5IjoiMTAwMy0xMjM0NSJ9","content":[{"trade":{"tradeKey":{"tradeId":"1001"},"tradeType":"ORIGINAL_TRADE","tradeEntryType":"REGULAR_TRADE","dealId":"DEAL-2026-0042","memberId":100,"accountId":5001,"subAccount":"HOUSE","productId":{"value":200},"eventId":null,"seriesId":null,"instrumentId":12345,"currency":"USDC","tradeDate":"2026-01-15","clearingDate":"2026-01-15","tradeSide":"BUY","positionEffect":"OPEN","price":142.5,"quantity":10,"tradeValue":{"amount":1425,"currency":"USDC"},"reference":null,"marketId":1,"reservedQuantity":0,"availableQuantity":10,"fee":{"amount":1.25,"currency":"USDC"},"tradeStatus":"ACTIVE","matchedTimestamp":"2026-01-15T14:30:00.123Z","receivedTimestamp":"2026-01-15T14:30:00.100Z","orderId":"ORD-98765","clOrderId":"CLIENT-ORD-001","sideExecutionId":"EXEC-54321","customerTypeIndicator":"CTI_1","exchangeTradeId":"EXT-DEAL-2026-0042","exchangeTradeReportId":null,"transferId":null,"exchange":"XCME","tradeSource":"EXCHANGE","differentialPrice":null,"refTradeId":[],"lastAction":null,"auditData":{"lastUpdatedBy":"system","lastUpdatedAt":"2026-01-15T14:30:00.150Z"}},"accountCode":"ACC-5001","clearingMemberCode":"CM-100","instrumentCode":"BTCUSD-FUT-MAR26","productCode":"BTC-FUTURES","eventName":null,"seriesName":null,"marketCode":"CME"}],"atEnd":false},"examples":{"Example":{"title":"Example","value":{"bookmark":"eyJsYXN0S2V5IjoiMTAwMy0xMjM0NSJ9","content":[{"trade":{"tradeKey":{"tradeId":"1001"},"tradeType":"ORIGINAL_TRADE","tradeEntryType":"REGULAR_TRADE","dealId":"DEAL-2026-0042","memberId":100,"accountId":5001,"subAccount":"HOUSE","productId":{"value":200},"eventId":null,"seriesId":null,"instrumentId":12345,"currency":"USDC","tradeDate":"2026-01-15","clearingDate":"2026-01-15","tradeSide":"BUY","positionEffect":"OPEN","price":142.5,"quantity":10,"tradeValue":{"amount":1425,"currency":"USDC"},"reference":null,"marketId":1,"reservedQuantity":0,"availableQuantity":10,"fee":{"amount":1.25,"currency":"USDC"},"tradeStatus":"ACTIVE","matchedTimestamp":"2026-01-15T14:30:00.123Z","receivedTimestamp":"2026-01-15T14:30:00.100Z","orderId":"ORD-98765","clOrderId":"CLIENT-ORD-001","sideExecutionId":"EXEC-54321","customerTypeIndicator":"CTI_1","exchangeTradeId":"EXT-DEAL-2026-0042","exchangeTradeReportId":null,"transferId":null,"exchange":"XCME","tradeSource":"EXCHANGE","differentialPrice":null,"refTradeId":[],"lastAction":null,"auditData":{"lastUpdatedBy":"system","lastUpdatedAt":"2026-01-15T14:30:00.150Z"}},"accountCode":"ACC-5001","clearingMemberCode":"CM-100","instrumentCode":"BTCUSD-FUT-MAR26","productCode":"BTC-FUTURES","eventName":null,"seriesName":null,"marketCode":"CME"}],"atEnd":false}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"02fadf0b-bd39-4104-a24a-ec88d259ed1e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT generated from a Coinbase Developer Platform (CDP) API key. See CDP API key JWT authentication.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3d6d4c4a-d8fa-45e8-9582-852640ce51d5":{"url":"https://{host}/cdp-api","variables":{"host":{"default":"host","description":"Host name for your environment. REST API host names are not published yet; environments are described on the Coinbase Clearing Connectivity page."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT generated from a Coinbase Developer Platform (CDP) API key. See CDP API key JWT authentication.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT generated from a Coinbase Developer Platform (CDP) API key. See CDP API key JWT authentication.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/clearing-api/rest-api/cbc-spec.json"},"subdomain":"coinbase-prod","siteName":"Coinbase Developer Documentation","title":"Get derivative trades - Coinbase Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T22:17:18.470Z","originalFileLocation":"api-reference/clearing-api/rest-api/trades/get-derivative-trades.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=\"light\"}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 a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Coinbase 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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_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/coinbase-prod/c38WXP1QDRE4hnu6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get derivative trades - Coinbase Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Coinbase Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coinbase-prod.mintlify.app/_mintlify/api/og/v2?division=Trades\u0026amp;title=Get+derivative+trades\u0026amp;description=Returns+a+page+of+derivative+%28futures+and+options%29+trades.+Uses+the+same+request+and+response+schema+as+Get+event+trades.\u0026amp;theme=77a5406d72fc6b056fdde5d3\u0026amp;signature=181de9082d5ab8f1ad973aec99524a0d260ecdd0103309af9e7a02c908942d63\">\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 derivative trades - Coinbase Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coinbase-prod.mintlify.app/_mintlify/api/og/v2?division=Trades\u0026amp;title=Get+derivative+trades\u0026amp;description=Returns+a+page+of+derivative+%28futures+and+options%29+trades.+Uses+the+same+request+and+response+schema+as+Get+event+trades.\u0026amp;theme=77a5406d72fc6b056fdde5d3\u0026amp;signature=181de9082d5ab8f1ad973aec99524a0d260ecdd0103309af9e7a02c908942d63\">\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/coinbase-prod/c38WXP1QDRE4hnu6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Coinbase Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#004cec\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/clearing-api/rest-api/trades/get-derivative-trades.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cdp.coinbase.com/#organization\",\"name\":\"Coinbase Developer Documentation\",\"url\":\"https://docs.cdp.coinbase.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coinbase-prod/B68gj-lD9xkJGij4/logos/wordmark-light.svg?fit=max\u0026auto=format\u0026n=B68gj-lD9xkJGij4\u0026q=85\u0026s=0eb5640aeec58541851e1cba9c6ccc8b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cdp.coinbase.com#website\",\"name\":\"Coinbase Developer Documentation\",\"url\":\"https://docs.cdp.coinbase.com\",\"publisher\":{\"@id\":\"https://docs.cdp.coinbase.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades#webpage\",\"url\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades\",\"name\":\"Get derivative trades\",\"description\":\"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\",\"dateModified\":\"2026-11-04T22:17:18.470Z\",\"isPartOf\":{\"@id\":\"https://docs.cdp.coinbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Coinbase Developer Documentation\",\"item\":\"https://docs.cdp.coinbase.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get derivative trades\",\"item\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades#apireference\",\"headline\":\"Get derivative trades\",\"name\":\"Get derivative trades\",\"description\":\"Returns a page of derivative (futures and options) trades. Uses the same request and response schema as Get event trades.\",\"url\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cdp.coinbase.com/api-reference/clearing-api/rest-api/trades/get-derivative-trades#webpage\"},\"dateModified\":\"2026-11-04T22:17:18.470Z\",\"publisher\":{\"@id\":\"https://docs.cdp.coinbase.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cdp.coinbase.com#website\"}}]}\u003c/script>","siteName":"Coinbase Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API Reference","dropdowns":[{"dropdown":"CDP API","icon":"https://mintlify-assets.b-cdn.net/developerSDKNavigation-0.svg","groups":[{"group":"CDP API","pages":[{"title":"Welcome to CDP API","sidebarTitle":"Overview","href":"/api-reference/v2/introduction"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/v2/authentication"},{"title":"API Conventions","sidebarTitle":"Conventions","href":"/api-reference/v2/conventions"},{"title":"Pagination","href":"/api-reference/v2/pagination"},{"title":"Idempotency","href":"/api-reference/v2/idempotency"},{"title":"Rate Limits","href":"/api-reference/v2/rate-limits"},{"title":"Errors","href":"/api-reference/v2/errors"},{"title":"OpenAPI Spec","sidebarTitle":"OpenAPI Spec","url":"https://docs.cdp.coinbase.com/api-reference/v2/cdp-api-v2.yaml","href":"/api-reference/v2/openapi-spec"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","href":"/api-reference/v2/troubleshooting"}]},{"group":"REST API","pages":[{"group":"Wallets","pages":[{"group":"Custodial","pages":[{"group":"Accounts","pages":[{"title":"Accounts","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/accounts/accounts"},{"openapi":"get /v2/accounts/{accountId}","title":"Get account","href":"/api-reference/v2/rest-api/accounts/get-account"},{"openapi":"get /v2/accounts/{accountId}/balances/{asset}","title":"Get balance for account","href":"/api-reference/v2/rest-api/accounts/get-balance-for-account"},{"openapi":"get /v2/accounts","title":"List accounts","href":"/api-reference/v2/rest-api/accounts/list-accounts"},{"openapi":"get /v2/accounts/{accountId}/balances","title":"List balances for account","href":"/api-reference/v2/rest-api/accounts/list-balances-for-account"},{"openapi":"post /v2/accounts","title":"Create account","href":"/api-reference/v2/rest-api/accounts/create-account"}]}]},{"group":"Non-custodial","pages":[{"group":"User Wallets","pages":[{"group":"End User Account Management","pages":[{"title":"End User Account Management","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/end-user-account-management/end-user-account-management"},{"openapi":"get /v2/end-users/{userId}","title":"Get end user","href":"/api-reference/v2/rest-api/end-user-account-management/get-end-user"},{"openapi":"get /v2/end-users","title":"List end users","href":"/api-reference/v2/rest-api/end-user-account-management/list-end-users"},{"openapi":"get /v2/end-users/lookup","title":"Look up end users by identity","href":"/api-reference/v2/rest-api/end-user-account-management/look-up-end-users-by-identity"},{"openapi":"post /v2/end-users/{userId}/evm","title":"Add EVM account to end user","href":"/api-reference/v2/rest-api/end-user-account-management/add-evm-account-to-end-user"},{"openapi":"post /v2/end-users/{userId}/evm-smart-account","title":"Add EVM smart account to end user","href":"/api-reference/v2/rest-api/end-user-account-management/add-evm-smart-account-to-end-user"},{"openapi":"post /v2/end-users/{userId}/solana","title":"Add Solana account to end user","href":"/api-reference/v2/rest-api/end-user-account-management/add-solana-account-to-end-user"},{"openapi":"post /v2/end-users","title":"Create end user","href":"/api-reference/v2/rest-api/end-user-account-management/create-end-user"},{"openapi":"post /v2/end-users/import","title":"Import end user private key","href":"/api-reference/v2/rest-api/end-user-account-management/import-end-user-private-key"},{"openapi":"post /v2/end-users/auth/validate-token","title":"Validate end user access token","href":"/api-reference/v2/rest-api/end-user-account-management/validate-end-user-access-token"}]},{"group":"End User Accounts","pages":[{"title":"End User Accounts","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/end-user-accounts/end-user-accounts"},{"openapi":"get /v2/embedded-wallet-api/evm/borrow-products/{borrowProductId}","title":"Get a borrow product","href":"/api-reference/v2/rest-api/end-user-accounts/get-a-borrow-product"},{"openapi":"get /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/user-operations/{userOpHash}","title":"Get a user operation for end user EVM Smart Account","href":"/api-reference/v2/rest-api/end-user-accounts/get-a-user-operation-for-end-user-evm-smart-account"},{"openapi":"get /v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation","title":"Get account-scoped delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/get-account-scoped-delegation-for-end-user"},{"openapi":"get /v2/embedded-wallet-api/end-users/{userId}/delegation","title":"Get delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/get-delegation-for-end-user"},{"openapi":"get /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions","title":"List borrow positions for an end user smart account","href":"/api-reference/v2/rest-api/end-user-accounts/list-borrow-positions-for-an-end-user-smart-account"},{"openapi":"get /v2/embedded-wallet-api/evm/borrow-products","title":"List borrow products","href":"/api-reference/v2/rest-api/end-user-accounts/list-borrow-products"},{"openapi":"get /v2/embedded-wallet-api/end-users/{userId}/evm/{address}/lend/positions","title":"List lend positions","href":"/api-reference/v2/rest-api/end-user-accounts/list-lend-positions"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions/adjust","title":"Adjust a borrow position for an end user smart account","href":"/api-reference/v2/rest-api/end-user-accounts/adjust-a-borrow-position-for-an-end-user-smart-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions/close","title":"Close a borrow position for an end user smart account","href":"/api-reference/v2/rest-api/end-user-accounts/close-a-borrow-position-for-an-end-user-smart-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions","title":"Create a borrow position for an end user smart account","href":"/api-reference/v2/rest-api/end-user-accounts/create-a-borrow-position-for-an-end-user-smart-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation","title":"Create account-scoped delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/create-account-scoped-delegation-for-end-user"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/eip7702/delegation","title":"Create EIP-7702 delegation for end user EVM account","href":"/api-reference/v2/rest-api/end-user-accounts/create-eip-7702-delegation-for-end-user-evm-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/{address}/lend/deposit","title":"Deposit into a vault","href":"/api-reference/v2/rest-api/end-user-accounts/deposit-into-a-vault"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/lend/deposit","title":"Deposit into a vault from a Smart Account","href":"/api-reference/v2/rest-api/end-user-accounts/deposit-into-a-vault-from-a-smart-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation/revoke","title":"Revoke account-scoped delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/revoke-account-scoped-delegation-for-end-user"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/delegation/revoke","title":"Revoke delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/revoke-delegation-for-end-user"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/send/transaction","title":"Send transaction via end user EVM account","href":"/api-reference/v2/rest-api/end-user-accounts/send-transaction-via-end-user-evm-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/solana/send/transaction","title":"Send transaction via end user Solana account","href":"/api-reference/v2/rest-api/end-user-accounts/send-transaction-via-end-user-solana-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/{address}/send/{asset}","title":"Send USDC on EVM","href":"/api-reference/v2/rest-api/end-user-accounts/send-usdc-on-evm"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/solana/{address}/send/{asset}","title":"Send USDC on Solana","href":"/api-reference/v2/rest-api/end-user-accounts/send-usdc-on-solana"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/send","title":"Send user operation for end user Smart Account","href":"/api-reference/v2/rest-api/end-user-accounts/send-user-operation-for-end-user-smart-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/solana/sign/message","title":"Sign Base64-encoded message","href":"/api-reference/v2/rest-api/end-user-accounts/sign-base64-encoded-message"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/sign/message","title":"Sign EIP-191 message via end user EVM account","href":"/api-reference/v2/rest-api/end-user-accounts/sign-eip-191-message-via-end-user-evm-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/sign/typed-data","title":"Sign EIP-712 typed data via end user EVM account","href":"/api-reference/v2/rest-api/end-user-accounts/sign-eip-712-typed-data-via-end-user-evm-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/sign/transaction","title":"Sign transaction via end user EVM account","href":"/api-reference/v2/rest-api/end-user-accounts/sign-transaction-via-end-user-evm-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/solana/sign/transaction","title":"Sign transaction via end user Solana account","href":"/api-reference/v2/rest-api/end-user-accounts/sign-transaction-via-end-user-solana-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/solana/sign/x402-payment","title":"Sign x402 payment via end user Solana account","href":"/api-reference/v2/rest-api/end-user-accounts/sign-x402-payment-via-end-user-solana-account"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/{address}/lend/withdraw","title":"Withdraw from a vault","href":"/api-reference/v2/rest-api/end-user-accounts/withdraw-from-a-vault"},{"openapi":"post /v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/lend/withdraw","title":"Withdraw from a vault from a Smart Account","href":"/api-reference/v2/rest-api/end-user-accounts/withdraw-from-a-vault-from-a-smart-account"},{"openapi":"delete /v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation","deprecated":true,"title":"Revoke account-scoped delegation for end user (deprecated)","href":"/api-reference/v2/rest-api/end-user-accounts/revoke-account-scoped-delegation-for-end-user-deprecated"},{"openapi":"delete /v2/embedded-wallet-api/end-users/{userId}/delegation","deprecated":true,"title":"Revoke delegation for end user (deprecated)","href":"/api-reference/v2/rest-api/end-user-accounts/revoke-delegation-for-end-user-deprecated"}]}]},{"group":"API Key Wallets","pages":[{"group":"EVM Accounts","pages":[{"title":"EVM Accounts","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/evm-accounts/evm-accounts"},{"openapi":"get /v2/evm/eip7702/delegation-operations/{delegationOperationId}","title":"Get EIP-7702 delegation operation by ID","href":"/api-reference/v2/rest-api/evm-accounts/get-eip-7702-delegation-operation-by-id"},{"openapi":"get /v2/evm/accounts/{address}","title":"Get EVM account by address","href":"/api-reference/v2/rest-api/evm-accounts/get-evm-account-by-address"},{"openapi":"get /v2/evm/accounts/by-name/{name}","title":"Get EVM account by name","href":"/api-reference/v2/rest-api/evm-accounts/get-evm-account-by-name"},{"openapi":"get /v2/evm/accounts","title":"List EVM accounts","href":"/api-reference/v2/rest-api/evm-accounts/list-evm-accounts"},{"openapi":"post /v2/evm/accounts/{address}/eip7702/delegation","title":"Create EIP-7702 delegation","href":"/api-reference/v2/rest-api/evm-accounts/create-eip-7702-delegation"},{"openapi":"post /v2/evm/accounts","title":"Create EVM account","href":"/api-reference/v2/rest-api/evm-accounts/create-evm-account"},{"openapi":"post /v2/evm/accounts/{address}/export","title":"Export EVM account","href":"/api-reference/v2/rest-api/evm-accounts/export-evm-account"},{"openapi":"post /v2/evm/accounts/export/by-name/{name}","title":"Export EVM account by name","href":"/api-reference/v2/rest-api/evm-accounts/export-evm-account-by-name"},{"openapi":"post /v2/evm/accounts/import","title":"Import EVM account","href":"/api-reference/v2/rest-api/evm-accounts/import-evm-account"},{"openapi":"post /v2/evm/accounts/{address}/send/transaction","title":"Send transaction","href":"/api-reference/v2/rest-api/evm-accounts/send-transaction"},{"openapi":"post /v2/evm/accounts/{address}/sign/message","title":"Sign EIP-191 message","href":"/api-reference/v2/rest-api/evm-accounts/sign-eip-191-message"},{"openapi":"post /v2/evm/accounts/{address}/sign/typed-data","title":"Sign EIP-712 typed data","href":"/api-reference/v2/rest-api/evm-accounts/sign-eip-712-typed-data"},{"openapi":"post /v2/evm/accounts/{address}/sign","title":"Sign hash","href":"/api-reference/v2/rest-api/evm-accounts/sign-hash"},{"openapi":"post /v2/evm/accounts/{address}/sign/transaction","title":"Sign transaction","href":"/api-reference/v2/rest-api/evm-accounts/sign-transaction"},{"openapi":"put /v2/evm/accounts/{address}","title":"Update EVM account","href":"/api-reference/v2/rest-api/evm-accounts/update-evm-account"}]},{"group":"EVM Smart Accounts","pages":[{"title":"EVM Smart Accounts","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/evm-smart-accounts/evm-smart-accounts"},{"openapi":"get /v2/evm/smart-accounts/{address}","title":"Get Smart Account by address","href":"/api-reference/v2/rest-api/evm-smart-accounts/get-smart-account-by-address"},{"openapi":"get /v2/evm/smart-accounts/by-name/{name}","title":"Get Smart Account by name","href":"/api-reference/v2/rest-api/evm-smart-accounts/get-smart-account-by-name"},{"openapi":"get /v2/evm/smart-accounts/{address}/user-operations/{userOpHash}","title":"Get user operation","href":"/api-reference/v2/rest-api/evm-smart-accounts/get-user-operation"},{"openapi":"get /v2/evm/smart-accounts","title":"List Smart Accounts","href":"/api-reference/v2/rest-api/evm-smart-accounts/list-smart-accounts"},{"openapi":"get /v2/evm/smart-accounts/{address}/spend-permissions/list","title":"List spend permissions","href":"/api-reference/v2/rest-api/evm-smart-accounts/list-spend-permissions"},{"openapi":"post /v2/evm/smart-accounts","title":"Create Smart Account","href":"/api-reference/v2/rest-api/evm-smart-accounts/create-smart-account"},{"openapi":"post /v2/evm/smart-accounts/{address}/spend-permissions","title":"Create spend permission","href":"/api-reference/v2/rest-api/evm-smart-accounts/create-spend-permission"},{"openapi":"post /v2/evm/smart-accounts/{address}/user-operations/prepare-and-send","title":"Prepare and send user operation","href":"/api-reference/v2/rest-api/evm-smart-accounts/prepare-and-send-user-operation"},{"openapi":"post /v2/evm/smart-accounts/{address}/user-operations","title":"Prepare user operation","href":"/api-reference/v2/rest-api/evm-smart-accounts/prepare-user-operation"},{"openapi":"post /v2/evm/smart-accounts/{address}/spend-permissions/revoke","title":"Revoke spend permission","href":"/api-reference/v2/rest-api/evm-smart-accounts/revoke-spend-permission"},{"openapi":"post /v2/evm/smart-accounts/{address}/user-operations/{userOpHash}/send","title":"Send user operation","href":"/api-reference/v2/rest-api/evm-smart-accounts/send-user-operation"},{"openapi":"put /v2/evm/smart-accounts/{address}","title":"Update EVM Smart Account","href":"/api-reference/v2/rest-api/evm-smart-accounts/update-evm-smart-account"}]},{"group":"Solana Accounts","pages":[{"title":"Solana Accounts","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/solana-accounts/solana-accounts"},{"openapi":"get /v2/solana/accounts/{address}","title":"Get Solana account by address","href":"/api-reference/v2/rest-api/solana-accounts/get-solana-account-by-address"},{"openapi":"get /v2/solana/accounts/by-name/{name}","title":"Get Solana account by name","href":"/api-reference/v2/rest-api/solana-accounts/get-solana-account-by-name"},{"openapi":"get /v2/solana/accounts","title":"List Solana accounts","href":"/api-reference/v2/rest-api/solana-accounts/list-solana-accounts"},{"openapi":"post /v2/solana/accounts","title":"Create Solana account","href":"/api-reference/v2/rest-api/solana-accounts/create-solana-account"},{"openapi":"post /v2/solana/accounts/{address}/export","title":"Export Solana account","href":"/api-reference/v2/rest-api/solana-accounts/export-solana-account"},{"openapi":"post /v2/solana/accounts/export/by-name/{name}","title":"Export Solana account by name","href":"/api-reference/v2/rest-api/solana-accounts/export-solana-account-by-name"},{"openapi":"post /v2/solana/accounts/import","title":"Import Solana account","href":"/api-reference/v2/rest-api/solana-accounts/import-solana-account"},{"openapi":"post /v2/solana/accounts/send/transaction","title":"Send Solana transaction","href":"/api-reference/v2/rest-api/solana-accounts/send-solana-transaction"},{"openapi":"post /v2/solana/accounts/{address}/sign/message","title":"Sign message","href":"/api-reference/v2/rest-api/solana-accounts/sign-message"},{"openapi":"post /v2/solana/accounts/{address}/sign/transaction","title":"Sign transaction","href":"/api-reference/v2/rest-api/solana-accounts/sign-transaction"},{"openapi":"put /v2/solana/accounts/{address}","title":"Update Solana account","href":"/api-reference/v2/rest-api/solana-accounts/update-solana-account"}]}]},{"group":"Lend","tag":"Beta","pages":[{"title":"Lend","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/lend/lend"},{"openapi":"post /v2/evm/accounts/{address}/lend/redeem-fees","title":"Redeem vault fees with an EVM account","href":"/api-reference/v2/rest-api/lend/redeem-vault-fees-with-an-evm-account"},{"openapi":"post /v2/evm/smart-accounts/{address}/lend/redeem-fees","title":"Redeem vault fees with an EVM Smart Account","href":"/api-reference/v2/rest-api/lend/redeem-vault-fees-with-an-evm-smart-account"}]},{"group":"Policy Engine","pages":[{"title":"Policy Engine","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/policy-engine/policy-engine"},{"openapi":"get /v2/policy-engine/policies/{policyId}","title":"Get policy by ID","href":"/api-reference/v2/rest-api/policy-engine/get-policy-by-id"},{"openapi":"get /v2/policy-engine/policies","title":"List policies","href":"/api-reference/v2/rest-api/policy-engine/list-policies"},{"openapi":"post /v2/policy-engine/policies","title":"Create policy","href":"/api-reference/v2/rest-api/policy-engine/create-policy"},{"openapi":"post /v2/policy-engine/policies/{policyId}/pause","title":"Pause policy","href":"/api-reference/v2/rest-api/policy-engine/pause-policy"},{"openapi":"post /v2/policy-engine/policies/{policyId}/resume","title":"Resume policy","href":"/api-reference/v2/rest-api/policy-engine/resume-policy"},{"openapi":"post /v2/policy-engine/simulate","title":"Simulate policies","href":"/api-reference/v2/rest-api/policy-engine/simulate-policies"},{"openapi":"put /v2/policy-engine/policies/{policyId}","title":"Update policy","href":"/api-reference/v2/rest-api/policy-engine/update-policy"},{"openapi":"delete /v2/policy-engine/policies/{policyId}","title":"Delete policy","href":"/api-reference/v2/rest-api/policy-engine/delete-policy"}]},{"group":"Wallet Webhooks","pages":[{"title":"Wallet Webhooks","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/wallet-webhooks/wallet-webhooks"},{"openapi":"webhook walletDelegationCreated","sidebarTitle":"Wallet delegation created","title":"Wallet delegation created","href":"/api-reference/v2/webhooks/webhook-wallet-delegation-created"},{"openapi":"webhook walletDelegationRevoked","sidebarTitle":"Wallet delegation revoked","title":"Wallet delegation revoked","href":"/api-reference/v2/webhooks/webhook-wallet-delegation-revoked"},{"openapi":"webhook walletHashSigned","sidebarTitle":"Wallet hash signed","title":"Wallet hash signed","href":"/api-reference/v2/webhooks/webhook-wallet-hash-signed"},{"openapi":"webhook walletMessageSigned","sidebarTitle":"Wallet message signed","title":"Wallet message signed","href":"/api-reference/v2/webhooks/webhook-wallet-message-signed"},{"openapi":"webhook walletTransactionBroadcast","sidebarTitle":"Wallet transaction broadcast","title":"Wallet transaction broadcast","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-broadcast"},{"openapi":"webhook walletTransactionConfirmed","sidebarTitle":"Wallet transaction confirmed","title":"Wallet transaction confirmed","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-confirmed"},{"openapi":"webhook walletTransactionCreated","sidebarTitle":"Wallet transaction created","title":"Wallet transaction created","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-created"},{"openapi":"webhook walletTransactionFailed","sidebarTitle":"Wallet transaction failed","title":"Wallet transaction failed","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-failed"},{"openapi":"webhook walletTransactionPending","sidebarTitle":"Wallet transaction pending","title":"Wallet transaction pending","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-pending"},{"openapi":"webhook walletTransactionReplaced","sidebarTitle":"Wallet transaction replaced","title":"Wallet transaction replaced","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-replaced"},{"openapi":"webhook walletTransactionSigned","sidebarTitle":"Wallet transaction signed","title":"Wallet transaction signed","href":"/api-reference/v2/webhooks/webhook-wallet-transaction-signed"},{"openapi":"webhook walletTypedDataSigned","sidebarTitle":"Wallet typed data signed","title":"Wallet typed data signed","href":"/api-reference/v2/webhooks/webhook-wallet-typed-data-signed"}]}]}]},{"group":"Payments","pages":[{"group":"Acceptance","pages":[{"group":"Payment Sessions","pages":[{"title":"Payment Sessions","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/payment-sessions/payment-sessions"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}","title":"Get a payment session","href":"/api-reference/v2/rest-api/payment-sessions/get-a-payment-session"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations/{authorizationId}","title":"Get a payment session authorization","href":"/api-reference/v2/rest-api/payment-sessions/get-a-payment-session-authorization"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/captures/{captureId}","title":"Get a payment session capture","href":"/api-reference/v2/rest-api/payment-sessions/get-a-payment-session-capture"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/refunds/{refundId}","title":"Get a payment session refund","href":"/api-reference/v2/rest-api/payment-sessions/get-a-payment-session-refund"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/voids/{voidId}","title":"Get a payment session void","href":"/api-reference/v2/rest-api/payment-sessions/get-a-payment-session-void"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations/wallet/options","title":"Get wallet authorization options","href":"/api-reference/v2/rest-api/payment-sessions/get-wallet-authorization-options"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations","title":"List payment session authorizations","href":"/api-reference/v2/rest-api/payment-sessions/list-payment-session-authorizations"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/captures","title":"List payment session captures","href":"/api-reference/v2/rest-api/payment-sessions/list-payment-session-captures"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/refunds","title":"List payment session refunds","href":"/api-reference/v2/rest-api/payment-sessions/list-payment-session-refunds"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/voids","title":"List payment session voids","href":"/api-reference/v2/rest-api/payment-sessions/list-payment-session-voids"},{"openapi":"get /v2/payment-sessions","title":"List payment sessions","href":"/api-reference/v2/rest-api/payment-sessions/list-payment-sessions"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/coinbase","title":"Authorize a payment session with a Coinbase account","href":"/api-reference/v2/rest-api/payment-sessions/authorize-a-payment-session-with-a-coinbase-account"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/mandate","title":"Authorize a payment session with a mandate","href":"/api-reference/v2/rest-api/payment-sessions/authorize-a-payment-session-with-a-mandate"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/wallet","title":"Authorize a payment session with a wallet","href":"/api-reference/v2/rest-api/payment-sessions/authorize-a-payment-session-with-a-wallet"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/x402","title":"Authorize a payment session with x402","href":"/api-reference/v2/rest-api/payment-sessions/authorize-a-payment-session-with-x402"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/cancel","title":"Cancel a payment session","href":"/api-reference/v2/rest-api/payment-sessions/cancel-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/captures","title":"Capture a payment session","href":"/api-reference/v2/rest-api/payment-sessions/capture-a-payment-session"},{"openapi":"post /v2/payment-sessions","title":"Create a payment session","href":"/api-reference/v2/rest-api/payment-sessions/create-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/refunds","title":"Refund a payment session","href":"/api-reference/v2/rest-api/payment-sessions/refund-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/voids","title":"Void a payment session","href":"/api-reference/v2/rest-api/payment-sessions/void-a-payment-session"},{"group":"Webhooks","pages":[{"openapi":"webhook acceptancePaymentSessionAuthorizationFailed","sidebarTitle":"Payment session authorization failed","title":"Payment session authorization failed","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-authorization-failed"},{"openapi":"webhook acceptancePaymentSessionAuthorizationPending","sidebarTitle":"Payment session authorization pending","title":"Payment session authorization pending","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-authorization-pending"},{"openapi":"webhook acceptancePaymentSessionAuthorizationSucceeded","sidebarTitle":"Payment session authorization succeeded","title":"Payment session authorization succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-authorization-succeeded"},{"openapi":"webhook acceptancePaymentSessionCanceled","sidebarTitle":"Payment session canceled","title":"Payment session canceled","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-canceled"},{"openapi":"webhook acceptancePaymentSessionCaptureFailed","sidebarTitle":"Payment session capture failed","title":"Payment session capture failed","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-capture-failed"},{"openapi":"webhook acceptancePaymentSessionCapturePending","sidebarTitle":"Payment session capture pending","title":"Payment session capture pending","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-capture-pending"},{"openapi":"webhook acceptancePaymentSessionCaptureSucceeded","sidebarTitle":"Payment session capture succeeded","title":"Payment session capture succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-capture-succeeded"},{"openapi":"webhook acceptancePaymentSessionCreated","sidebarTitle":"Payment session created","title":"Payment session created","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-created"},{"openapi":"webhook acceptancePaymentSessionRefundFailed","sidebarTitle":"Payment session refund failed","title":"Payment session refund failed","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-refund-failed"},{"openapi":"webhook acceptancePaymentSessionRefundPending","sidebarTitle":"Payment session refund pending","title":"Payment session refund pending","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-refund-pending"},{"openapi":"webhook acceptancePaymentSessionRefundSucceeded","sidebarTitle":"Payment session refund succeeded","title":"Payment session refund succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-refund-succeeded"},{"openapi":"webhook acceptancePaymentSessionVoidFailed","sidebarTitle":"Payment session void failed","title":"Payment session void failed","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-void-failed"},{"openapi":"webhook acceptancePaymentSessionVoidPending","sidebarTitle":"Payment session void pending","title":"Payment session void pending","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-void-pending"},{"openapi":"webhook acceptancePaymentSessionVoidSucceeded","sidebarTitle":"Payment session void succeeded","title":"Payment session void succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-payment-session-void-succeeded"}]}]},{"group":"Disbursements","pages":[{"title":"Disbursements","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/disbursements/disbursements"},{"openapi":"get /v2/disbursements/{disbursementId}","title":"Get a disbursement","href":"/api-reference/v2/rest-api/disbursements/get-a-disbursement"},{"openapi":"get /v2/disbursements","title":"List disbursements","href":"/api-reference/v2/rest-api/disbursements/list-disbursements"},{"openapi":"post /v2/disbursements","title":"Create a disbursement","href":"/api-reference/v2/rest-api/disbursements/create-a-disbursement"},{"group":"Webhooks","pages":[{"openapi":"webhook acceptanceDisbursementFailed","sidebarTitle":"Disbursement failed","title":"Disbursement failed","href":"/api-reference/v2/webhooks/webhook-acceptance-disbursement-failed"},{"openapi":"webhook acceptanceDisbursementPending","sidebarTitle":"Disbursement pending","title":"Disbursement pending","href":"/api-reference/v2/webhooks/webhook-acceptance-disbursement-pending"},{"openapi":"webhook acceptanceDisbursementSucceeded","sidebarTitle":"Disbursement succeeded","title":"Disbursement succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-disbursement-succeeded"}]}]},{"group":"Mandates","tag":"Beta","pages":[{"title":"Mandates","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/mandates/mandates"},{"openapi":"get /v2/mandates/{mandateId}","title":"Get a mandate","href":"/api-reference/v2/rest-api/mandates/get-a-mandate"},{"openapi":"get /v2/mandates/{mandateId}/approvals/{approvalId}","title":"Get a mandate approval","href":"/api-reference/v2/rest-api/mandates/get-a-mandate-approval"},{"openapi":"get /v2/mandates/{mandateId}/revocations/{revocationId}","title":"Get a mandate revocation","href":"/api-reference/v2/rest-api/mandates/get-a-mandate-revocation"},{"openapi":"get /v2/mandates/{mandateId}/approvals/wallet/options","title":"Get wallet approval options","href":"/api-reference/v2/rest-api/mandates/get-wallet-approval-options"},{"openapi":"get /v2/mandates/{mandateId}/revocations/wallet/options","title":"Get wallet revocation options","href":"/api-reference/v2/rest-api/mandates/get-wallet-revocation-options"},{"openapi":"get /v2/mandates/{mandateId}/approvals","title":"List mandate approvals","href":"/api-reference/v2/rest-api/mandates/list-mandate-approvals"},{"openapi":"get /v2/mandates/{mandateId}/revocations","title":"List mandate revocations","href":"/api-reference/v2/rest-api/mandates/list-mandate-revocations"},{"openapi":"get /v2/mandates","title":"List mandates","href":"/api-reference/v2/rest-api/mandates/list-mandates"},{"openapi":"post /v2/mandates/{mandateId}/approvals/wallet","title":"Approve a mandate with a wallet","href":"/api-reference/v2/rest-api/mandates/approve-a-mandate-with-a-wallet"},{"openapi":"post /v2/mandates/{mandateId}/cancel","title":"Cancel a mandate","href":"/api-reference/v2/rest-api/mandates/cancel-a-mandate"},{"openapi":"post /v2/mandates","title":"Create a mandate","href":"/api-reference/v2/rest-api/mandates/create-a-mandate"},{"openapi":"post /v2/mandates/{mandateId}/revocations/wallet","title":"Revoke a mandate with a wallet","href":"/api-reference/v2/rest-api/mandates/revoke-a-mandate-with-a-wallet"},{"group":"Webhooks","pages":[{"openapi":"webhook acceptanceMandateApprovalFailed","sidebarTitle":"Mandate approval failed","title":"Mandate approval failed","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-approval-failed"},{"openapi":"webhook acceptanceMandateApprovalInitiated","sidebarTitle":"Mandate approval initiated","title":"Mandate approval initiated","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-approval-initiated"},{"openapi":"webhook acceptanceMandateApprovalSucceeded","sidebarTitle":"Mandate approval succeeded","title":"Mandate approval succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-approval-succeeded"},{"openapi":"webhook acceptanceMandateCanceled","sidebarTitle":"Mandate canceled","title":"Mandate canceled","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-canceled"},{"openapi":"webhook acceptanceMandateCreated","sidebarTitle":"Mandate created","title":"Mandate created","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-created"},{"openapi":"webhook acceptanceMandateRevocationFailed","sidebarTitle":"Mandate revocation failed","title":"Mandate revocation failed","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-revocation-failed"},{"openapi":"webhook acceptanceMandateRevocationInitiated","sidebarTitle":"Mandate revocation initiated","title":"Mandate revocation initiated","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-revocation-initiated"},{"openapi":"webhook acceptanceMandateRevocationSucceeded","sidebarTitle":"Mandate revocation succeeded","title":"Mandate revocation succeeded","href":"/api-reference/v2/webhooks/webhook-acceptance-mandate-revocation-succeeded"}]}]},{"group":"Top-Up Links","tag":"Beta","pages":[{"title":"Top-Up Links","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/top-up-links/top-up-links"},{"openapi":"post /v2/acceptance/top-up-links","title":"Create a Top-Up Link","href":"/api-reference/v2/rest-api/top-up-links/create-a-top-up-link"},{"group":"Webhooks","pages":[{"openapi":"webhook acceptanceTopUpLinkCreated","sidebarTitle":"Top-Up Link created","title":"Top-Up Link created","href":"/api-reference/v2/webhooks/webhook-acceptance-top-up-link-created"},{"openapi":"webhook acceptanceTopUpLinkFundsAdded","sidebarTitle":"Top-Up Link funds added","title":"Top-Up Link funds added","href":"/api-reference/v2/webhooks/webhook-acceptance-top-up-link-funds-added"}]}]}]},{"group":"Deposit Destinations","tag":"Beta","pages":[{"title":"Deposit Destinations","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/deposit-destinations/deposit-destinations"},{"openapi":"get /v2/deposit-destinations/{depositDestinationId}","title":"Get deposit destination","href":"/api-reference/v2/rest-api/deposit-destinations/get-deposit-destination"},{"openapi":"get /v2/deposit-destinations","title":"List deposit destinations","href":"/api-reference/v2/rest-api/deposit-destinations/list-deposit-destinations"},{"openapi":"post /v2/deposit-destinations","title":"Create deposit destination","href":"/api-reference/v2/rest-api/deposit-destinations/create-deposit-destination"},{"group":"Webhooks","pages":[{"openapi":"webhook paymentsDepositDestinationsActivated","sidebarTitle":"Deposit destination activated","title":"Deposit destination activated","href":"/api-reference/v2/webhooks/webhook-payments-deposit-destinations-activated"},{"openapi":"webhook paymentsDepositDestinationsDeactivated","sidebarTitle":"Deposit destination deactivated","title":"Deposit destination deactivated","href":"/api-reference/v2/webhooks/webhook-payments-deposit-destinations-deactivated"},{"openapi":"webhook paymentsDepositDestinationsInitiated","sidebarTitle":"Deposit destination initiated","title":"Deposit destination initiated","href":"/api-reference/v2/webhooks/webhook-payments-deposit-destinations-initiated"}]}]},{"group":"Payment Methods","tag":"Beta","pages":[{"title":"Payment Methods","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/payment-methods/payment-methods"},{"openapi":"get /v2/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/v2/rest-api/payment-methods/get-payment-method"},{"openapi":"get /v2/payment-methods","title":"List payment methods","href":"/api-reference/v2/rest-api/payment-methods/list-payment-methods"}]},{"group":"Transfers","tag":"Beta","pages":[{"title":"Transfers","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/transfers/transfers"},{"openapi":"get /v2/transfers/{transferId}","title":"Get transfer","href":"/api-reference/v2/rest-api/transfers/get-transfer"},{"openapi":"get /v2/transfers","title":"List transfers","href":"/api-reference/v2/rest-api/transfers/list-transfers"},{"openapi":"post /v2/transfers","title":"Create transfer","href":"/api-reference/v2/rest-api/transfers/create-transfer"},{"openapi":"post /v2/transfers/{transferId}/execute","title":"Execute transfer","href":"/api-reference/v2/rest-api/transfers/execute-transfer"},{"openapi":"post /v2/transfers/{transferId}/travel-rule","title":"Submit deposit travel rule information","href":"/api-reference/v2/rest-api/transfers/submit-deposit-travel-rule-information"},{"group":"Webhooks","pages":[{"openapi":"webhook paymentsTransfersCompleted","sidebarTitle":"Payments transfers completed","title":"Payments transfers completed","href":"/api-reference/v2/webhooks/webhook-payments-transfers-completed"},{"openapi":"webhook paymentsTransfersExpired","sidebarTitle":"Payments transfers expired","title":"Payments transfers expired","href":"/api-reference/v2/webhooks/webhook-payments-transfers-expired"},{"openapi":"webhook paymentsTransfersFailed","sidebarTitle":"Payments transfers failed","title":"Payments transfers failed","href":"/api-reference/v2/webhooks/webhook-payments-transfers-failed"},{"openapi":"webhook paymentsTransfersProcessing","sidebarTitle":"Payments transfers processing","title":"Payments transfers processing","href":"/api-reference/v2/webhooks/webhook-payments-transfers-processing"},{"openapi":"webhook paymentsTransfersQuoted","sidebarTitle":"Payments transfers quoted","title":"Payments transfers quoted","href":"/api-reference/v2/webhooks/webhook-payments-transfers-quoted"},{"openapi":"webhook paymentsTransfersTravelRuleCompleted","sidebarTitle":"Payments transfers travel rule completed","title":"Payments transfers travel rule completed","href":"/api-reference/v2/webhooks/webhook-payments-transfers-travel-rule-completed"},{"openapi":"webhook paymentsTransfersTravelRuleIncomplete","sidebarTitle":"Payments transfers travel rule incomplete","title":"Payments transfers travel rule incomplete","href":"/api-reference/v2/webhooks/webhook-payments-transfers-travel-rule-incomplete"}]}]},{"group":"Onramp","pages":[{"title":"Onramp","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/onramp/onramp"},{"openapi":"get /v2/onramp/orders/{orderId}","title":"Get an onramp order by ID","href":"/api-reference/v2/rest-api/onramp/get-an-onramp-order-by-id"},{"openapi":"post /v2/onramp/orders","title":"Create an onramp order","href":"/api-reference/v2/rest-api/onramp/create-an-onramp-order"},{"openapi":"post /v2/onramp/sessions","title":"Create an onramp session","href":"/api-reference/v2/rest-api/onramp/create-an-onramp-session"},{"openapi":"post /v2/onramp/limits","title":"Get onramp user limits","href":"/api-reference/v2/rest-api/onramp/get-onramp-user-limits"},{"openapi":"post /v2/onramp/verifications","title":"Initiate onramp verification","href":"/api-reference/v2/rest-api/onramp/initiate-onramp-verification"},{"openapi":"post /v2/onramp/limits/upgrade","title":"Request limit upgrade","href":"/api-reference/v2/rest-api/onramp/request-limit-upgrade"},{"openapi":"post /v2/onramp/verifications/{verificationId}/submit","title":"Submit onramp verification","href":"/api-reference/v2/rest-api/onramp/submit-onramp-verification"},{"group":"Webhooks","pages":[{"openapi":"webhook offrampTransactionCreated","sidebarTitle":"Offramp transaction created","title":"Offramp transaction created","href":"/api-reference/v2/webhooks/webhook-offramp-transaction-created"},{"openapi":"webhook offrampTransactionFailed","sidebarTitle":"Offramp transaction failed","title":"Offramp transaction failed","href":"/api-reference/v2/webhooks/webhook-offramp-transaction-failed"},{"openapi":"webhook offrampTransactionSuccess","sidebarTitle":"Offramp transaction succeeded","title":"Offramp transaction succeeded","href":"/api-reference/v2/webhooks/webhook-offramp-transaction-success"},{"openapi":"webhook offrampTransactionUpdated","sidebarTitle":"Offramp transaction updated","title":"Offramp transaction updated","href":"/api-reference/v2/webhooks/webhook-offramp-transaction-updated"},{"openapi":"webhook onrampTransactionCreated","sidebarTitle":"Onramp transaction created","title":"Onramp transaction created","href":"/api-reference/v2/webhooks/webhook-onramp-transaction-created"},{"openapi":"webhook onrampTransactionFailed","sidebarTitle":"Onramp transaction failed","title":"Onramp transaction failed","href":"/api-reference/v2/webhooks/webhook-onramp-transaction-failed"},{"openapi":"webhook onrampTransactionSuccess","sidebarTitle":"Onramp transaction succeeded","title":"Onramp transaction succeeded","href":"/api-reference/v2/webhooks/webhook-onramp-transaction-success"},{"openapi":"webhook onrampTransactionUpdated","sidebarTitle":"Onramp transaction updated","title":"Onramp transaction updated","href":"/api-reference/v2/webhooks/webhook-onramp-transaction-updated"}]}]},{"group":"Onramp (App2App)","pages":[{"title":"Onramp (App2App)","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/onramp-app2app/onramp-app2app"},{"openapi":"post /v2/onramp/mobile/attestation/challenges","title":"Create an onramp iOS attestation challenge","href":"/api-reference/v2/rest-api/onramp-app2app/create-an-onramp-ios-attestation-challenge"},{"openapi":"post /v2/onramp/mobile/sessions/challenges","title":"Create an onramp mobile challenge","href":"/api-reference/v2/rest-api/onramp-app2app/create-an-onramp-mobile-challenge"},{"openapi":"post /v2/onramp/mobile/sessions","title":"Create an onramp mobile session","href":"/api-reference/v2/rest-api/onramp-app2app/create-an-onramp-mobile-session"},{"openapi":"post /v2/onramp/mobile/attestation/registrations","title":"Register a device key for iOS App Attest","href":"/api-reference/v2/rest-api/onramp-app2app/register-a-device-key-for-ios-app-attest"}]},{"group":"x402 Facilitator","tag":"Beta","pages":[{"title":"x402 Facilitator","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/x402-facilitator/x402-facilitator"},{"openapi":"get /v2/x402/discovery/bundles/{bundleSlug}","title":"Get an x402 bundle","href":"/api-reference/v2/rest-api/x402-facilitator/get-an-x402-bundle"},{"openapi":"get /v2/x402/supported","title":"Get supported payment schemes and networks","href":"/api-reference/v2/rest-api/x402-facilitator/get-supported-payment-schemes-and-networks"},{"openapi":"get /v2/x402/discovery/merchant","title":"List merchant discovery info","href":"/api-reference/v2/rest-api/x402-facilitator/list-merchant-discovery-info"},{"openapi":"get /v2/x402/discovery/bundles","title":"List x402 bundles","href":"/api-reference/v2/rest-api/x402-facilitator/list-x402-bundles"},{"openapi":"get /v2/x402/discovery/resources","title":"List x402 resources","href":"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources"},{"openapi":"get /v2/x402/discovery/search","title":"Search x402 resources","href":"/api-reference/v2/rest-api/x402-facilitator/search-x402-resources"},{"openapi":"post /v2/x402/discovery/mcp","title":"Handle MCP JSON-RPC request","href":"/api-reference/v2/rest-api/x402-facilitator/handle-mcp-json-rpc-request"},{"openapi":"post /v2/x402/settle","title":"Settle payment","href":"/api-reference/v2/rest-api/x402-facilitator/settle-payment"},{"openapi":"post /v2/x402/validate","title":"Validate x402 endpoint","href":"/api-reference/v2/rest-api/x402-facilitator/validate-x402-endpoint"},{"openapi":"post /v2/x402/verify","title":"Verify payment","href":"/api-reference/v2/rest-api/x402-facilitator/verify-payment"}]}]},{"group":"Trading","pages":[{"group":"EVM Swaps","tag":"Beta","pages":[{"title":"EVM Swaps","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/evm-swaps/evm-swaps"},{"openapi":"get /v2/evm/swaps/quote","title":"Get swap price estimate","href":"/api-reference/v2/rest-api/evm-swaps/get-swap-price-estimate"},{"openapi":"post /v2/evm/swaps","title":"Create swap quote","href":"/api-reference/v2/rest-api/evm-swaps/create-swap-quote"}]}]},{"group":"Onchain Tools","pages":[{"group":"EVM Token Balances","pages":[{"title":"EVM Token Balances","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/evm-token-balances/evm-token-balances"},{"openapi":"get /v2/evm/token-balances/{network}/{address}","title":"List EVM token balances","href":"/api-reference/v2/rest-api/evm-token-balances/list-evm-token-balances"}]},{"group":"Faucets","pages":[{"title":"Faucets","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/faucets/faucets"},{"openapi":"post /v2/evm/faucet","title":"Request funds on EVM test networks","href":"/api-reference/v2/rest-api/faucets/request-funds-on-evm-test-networks"},{"openapi":"post /v2/solana/faucet","title":"Request funds on Solana devnet","href":"/api-reference/v2/rest-api/faucets/request-funds-on-solana-devnet"}]},{"group":"Onchain Data","pages":[{"title":"Onchain Data","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/onchain-data/onchain-data"},{"openapi":"get /v2/data/evm/token-balances/{network}/{address}","title":"List EVM token balances","href":"/api-reference/v2/rest-api/onchain-data/list-evm-token-balances"},{"openapi":"get /v2/data/evm/token-ownership/{network}/{address}","title":"List token addresses for account","href":"/api-reference/v2/rest-api/onchain-data/list-token-addresses-for-account"},{"group":"Webhooks","pages":[{"openapi":"webhook onchainActivityDetected","sidebarTitle":"Onchain activity detected","title":"Onchain activity detected","href":"/api-reference/v2/webhooks/webhook-onchain-activity-detected"},{"openapi":"webhook walletActivityDetected","sidebarTitle":"Wallet activity detected","title":"Wallet activity detected","href":"/api-reference/v2/webhooks/webhook-wallet-activity-detected"},{"openapi":"webhook walletActivityMulti","sidebarTitle":"Wallet activity multi","title":"Wallet activity multi","href":"/api-reference/v2/webhooks/webhook-wallet-activity-multi"}]}]},{"group":"Solana Token Balances","pages":[{"title":"Solana Token Balances","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/solana-token-balances/solana-token-balances"},{"openapi":"get /v2/solana/token-balances/{network}/{address}","title":"List Solana token balances","href":"/api-reference/v2/rest-api/solana-token-balances/list-solana-token-balances"}]},{"group":"SQL API","pages":[{"title":"SQL API","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/sql-api/sql-api"},{"openapi":"get /v2/data/query/schema","title":"Get schema details","href":"/api-reference/v2/rest-api/sql-api/get-schema-details"},{"openapi":"get /v2/data/query/grammar","title":"Get SQL grammar","href":"/api-reference/v2/rest-api/sql-api/get-sql-grammar"},{"openapi":"post /v2/data/query/run","title":"Run SQL Query","href":"/api-reference/v2/rest-api/sql-api/run-sql-query"}]}]},{"group":"Customers","tag":"Beta","pages":[{"title":"Customers","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/customers/customers"},{"openapi":"get /v2/customers/{customerId}","title":"Get a customer","href":"/api-reference/v2/rest-api/customers/get-a-customer"},{"openapi":"get /v2/customers/requirements","title":"Get customer requirements","href":"/api-reference/v2/rest-api/customers/get-customer-requirements"},{"openapi":"get /v2/customers","title":"List customers","href":"/api-reference/v2/rest-api/customers/list-customers"},{"openapi":"post /v2/customers","title":"Create a customer","href":"/api-reference/v2/rest-api/customers/create-a-customer"},{"openapi":"put /v2/customers/{customerId}","title":"Update a customer","href":"/api-reference/v2/rest-api/customers/update-a-customer"},{"openapi":"delete /v2/customers/{customerId}","title":"Delete a customer","href":"/api-reference/v2/rest-api/customers/delete-a-customer"},{"group":"Webhooks","pages":[{"openapi":"webhook customersCustomerDeleted","sidebarTitle":"Customer deleted","title":"Customer deleted","href":"/api-reference/v2/webhooks/webhook-customers-customer-deleted"},{"openapi":"webhook customersCapabilityChanged","sidebarTitle":"Customers capability changed","title":"Customers capability changed","href":"/api-reference/v2/webhooks/webhook-customers-capability-changed"},{"openapi":"webhook customersRequirementChanged","sidebarTitle":"Customers requirement changed","title":"Customers requirement changed","href":"/api-reference/v2/webhooks/webhook-customers-requirement-changed"}]}]},{"group":"Health","tag":"Beta","pages":[{"title":"Health","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/health/health"},{"openapi":"webhook healthMaintenanceCanceled","sidebarTitle":"Maintenance canceled","title":"Maintenance canceled","href":"/api-reference/v2/webhooks/webhook-health-maintenance-canceled"},{"openapi":"webhook healthMaintenanceCompleted","sidebarTitle":"Maintenance completed","title":"Maintenance completed","href":"/api-reference/v2/webhooks/webhook-health-maintenance-completed"},{"openapi":"webhook healthMaintenanceScheduled","sidebarTitle":"Maintenance scheduled","title":"Maintenance scheduled","href":"/api-reference/v2/webhooks/webhook-health-maintenance-scheduled"},{"openapi":"webhook healthMaintenanceStarted","sidebarTitle":"Maintenance started","title":"Maintenance started","href":"/api-reference/v2/webhooks/webhook-health-maintenance-started"},{"openapi":"webhook healthStatusUpdated","sidebarTitle":"Service health updated","title":"Service health updated","href":"/api-reference/v2/webhooks/webhook-health-status-updated"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/api-reference/v2/rest-api/webhooks/webhooks"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Get webhook subscription","href":"/api-reference/v2/rest-api/webhooks/get-webhook-subscription"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/deliveries/{deliveryId}","title":"Get webhook subscription delivery","href":"/api-reference/v2/rest-api/webhooks/get-webhook-subscription-delivery"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}","title":"Get webhook subscription matched event","href":"/api-reference/v2/rest-api/webhooks/get-webhook-subscription-matched-event"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/deliveries","title":"List webhook subscription deliveries","href":"/api-reference/v2/rest-api/webhooks/list-webhook-subscription-deliveries"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/events","deprecated":true,"title":"List webhook subscription events","href":"/api-reference/v2/rest-api/webhooks/list-webhook-subscription-events"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/matches","title":"List webhook subscription matched events","href":"/api-reference/v2/rest-api/webhooks/list-webhook-subscription-matched-events"},{"openapi":"get /v2/data/webhooks/subscriptions","title":"List webhook subscriptions","href":"/api-reference/v2/rest-api/webhooks/list-webhook-subscriptions"},{"openapi":"post /v2/data/webhooks/subscriptions","title":"Create webhook subscription","href":"/api-reference/v2/rest-api/webhooks/create-webhook-subscription"},{"openapi":"put /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Update webhook subscription","href":"/api-reference/v2/rest-api/webhooks/update-webhook-subscription"},{"openapi":"delete /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Delete webhook subscription","href":"/api-reference/v2/rest-api/webhooks/delete-webhook-subscription"}]}]}]},{"dropdown":"Coinbase Advanced Trade API","icon":"https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg","groups":[{"group":"Get Started","pages":[{"title":"Coinbase Advanced Trade API","sidebarTitle":"Overview","href":"/api-reference/advanced-trade-api/rest-api/introduction"}]},{"group":"Spot \u0026 US Derivatives - REST","pages":[{"group":"Accounts","pages":[{"title":"Get Account","openapi":"GET /api/v3/brokerage/accounts/{account_uuid}","href":"/api-reference/advanced-trade-api/rest-api/accounts/get-account"},{"title":"List Accounts","openapi":"GET /api/v3/brokerage/accounts","href":"/api-reference/advanced-trade-api/rest-api/accounts/list-accounts"}]},{"group":"Convert","pages":[{"title":"Commit Convert Trade","openapi":"POST /api/v3/brokerage/convert/trade/{trade_id}","href":"/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade"},{"title":"Create Convert Quote","openapi":"POST /api/v3/brokerage/convert/quote","href":"/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote"},{"title":"Get Convert Trade","openapi":"GET /api/v3/brokerage/convert/trade/{trade_id}","href":"/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade"}]},{"group":"Data API","pages":[{"title":"Get API Key Permissions","openapi":"GET /api/v3/brokerage/key_permissions","href":"/api-reference/advanced-trade-api/rest-api/data-api/get-api-key-permissions"}]},{"group":"Fees","pages":[{"title":"Get Transaction Summary","openapi":"GET /api/v3/brokerage/transaction_summary","href":"/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary"}]},{"group":"US Derivatives","pages":[{"title":"Cancel Pending US Derivatives Sweep","openapi":"DELETE /api/v3/brokerage/cfm/sweeps","href":"/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep"},{"title":"Get Current Margin Window","openapi":"GET /api/v3/brokerage/cfm/intraday/current_margin_window","href":"/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window"},{"title":"Get US Derivatives Balance Summary","openapi":"GET /api/v3/brokerage/cfm/balance_summary","href":"/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary"},{"title":"Get US Derivatives Position","openapi":"GET /api/v3/brokerage/cfm/positions/{product_id}","href":"/api-reference/advanced-trade-api/rest-api/futures/get-futures-position"},{"title":"Get Intraday Margin Setting","openapi":"GET /api/v3/brokerage/cfm/intraday/margin_setting","href":"/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting"},{"title":"List US Derivatives Positions","openapi":"GET /api/v3/brokerage/cfm/positions","href":"/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions"},{"title":"List US Derivatives Sweeps","openapi":"GET /api/v3/brokerage/cfm/sweeps","href":"/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps"},{"title":"Schedule US Derivatives Sweep","openapi":"POST /api/v3/brokerage/cfm/sweeps/schedule","href":"/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep"},{"title":"Set Intraday Margin Setting","openapi":"POST /api/v3/brokerage/cfm/intraday/margin_setting","href":"/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings"}]},{"group":"Orders","pages":[{"title":"Cancel Orders","openapi":"POST /api/v3/brokerage/orders/batch_cancel","href":"/api-reference/advanced-trade-api/rest-api/orders/cancel-order"},{"title":"Close Position","openapi":"POST /api/v3/brokerage/orders/close_position","href":"/api-reference/advanced-trade-api/rest-api/orders/close-position"},{"title":"Create Order","openapi":"POST /api/v3/brokerage/orders","href":"/api-reference/advanced-trade-api/rest-api/orders/create-order"},{"title":"Edit Order","openapi":"POST /api/v3/brokerage/orders/edit","href":"/api-reference/advanced-trade-api/rest-api/orders/edit-order"},{"title":"Edit Order Preview","openapi":"POST /api/v3/brokerage/orders/edit_preview","href":"/api-reference/advanced-trade-api/rest-api/orders/edit-order-preview"},{"title":"Get Order","openapi":"GET /api/v3/brokerage/orders/historical/{order_id}","href":"/api-reference/advanced-trade-api/rest-api/orders/get-order"},{"title":"List Fills","openapi":"GET /api/v3/brokerage/orders/historical/fills","href":"/api-reference/advanced-trade-api/rest-api/orders/list-fills"},{"title":"List Orders","openapi":"GET /api/v3/brokerage/orders/historical/batch","href":"/api-reference/advanced-trade-api/rest-api/orders/list-orders"},{"title":"Preview Order","openapi":"POST /api/v3/brokerage/orders/preview","href":"/api-reference/advanced-trade-api/rest-api/orders/preview-orders"}]},{"group":"Payment Methods","pages":[{"title":"Get Payment Method","openapi":"GET /api/v3/brokerage/payment_methods/{payment_method_id}","href":"/api-reference/advanced-trade-api/rest-api/payment-methods/get-payment-method"},{"title":"List Payment Methods","openapi":"GET /api/v3/brokerage/payment_methods","href":"/api-reference/advanced-trade-api/rest-api/payment-methods/list-payment-methods"}]},{"group":"INTX (deprecated)","pages":[{"title":"Allocate Portfolio","openapi":"POST /api/v3/brokerage/intx/allocate","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/allocate-portfolio"},{"title":"Get Perpetuals Portfolio Summary","openapi":"GET /api/v3/brokerage/intx/portfolio/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/get-perpetuals-portfolio-summary"},{"title":"Get Perpetuals Position","openapi":"GET /api/v3/brokerage/intx/positions/{portfolio_uuid}/{symbol}","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/get-perpetuals-position"},{"title":"Get Portfolios Balances","openapi":"GET /api/v3/brokerage/intx/balances/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/get-portfolio-balances"},{"title":"List Perpetuals Positions","openapi":"GET /api/v3/brokerage/intx/positions/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/list-perpetuals-positions"},{"title":"Opt In or Out of Multi Asset Collateral","openapi":"POST /api/v3/brokerage/intx/multi_asset_collateral","href":"/api-reference/advanced-trade-api/rest-api/perpetuals/opt-in-or-out"}]},{"group":"Portfolios","pages":[{"title":"Create Portfolio","openapi":"POST /api/v3/brokerage/portfolios","href":"/api-reference/advanced-trade-api/rest-api/portfolios/create-portfolio"},{"title":"Delete Portfolio","openapi":"DELETE /api/v3/brokerage/portfolios/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/portfolios/delete-portfolio"},{"title":"Edit Portfolio","openapi":"PUT /api/v3/brokerage/portfolios/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/portfolios/edit-portfolio"},{"title":"Get Portfolio Breakdown","openapi":"GET /api/v3/brokerage/portfolios/{portfolio_uuid}","href":"/api-reference/advanced-trade-api/rest-api/portfolios/get-portfolio-breakdown"},{"title":"List Portfolios","openapi":"GET /api/v3/brokerage/portfolios","href":"/api-reference/advanced-trade-api/rest-api/portfolios/list-portfolios"},{"title":"Move Portfolio Funds","openapi":"POST /api/v3/brokerage/portfolios/move_funds","href":"/api-reference/advanced-trade-api/rest-api/portfolios/move-portfolios-funds"}]},{"group":"Products","pages":[{"title":"Get Best Bid/Ask","openapi":"GET /api/v3/brokerage/best_bid_ask","href":"/api-reference/advanced-trade-api/rest-api/products/get-best-bid-ask"},{"title":"Get Market Trades","openapi":"GET /api/v3/brokerage/products/{product_id}/ticker","href":"/api-reference/advanced-trade-api/rest-api/products/get-market-trades"},{"title":"Get Product","openapi":"GET /api/v3/brokerage/products/{product_id}","href":"/api-reference/advanced-trade-api/rest-api/products/get-product"},{"title":"Get Product Book","openapi":"GET /api/v3/brokerage/product_book","href":"/api-reference/advanced-trade-api/rest-api/products/get-product-book"},{"title":"Get Product Candles","openapi":"GET /api/v3/brokerage/products/{product_id}/candles","href":"/api-reference/advanced-trade-api/rest-api/products/get-product-candles"},{"title":"List Products","openapi":"GET /api/v3/brokerage/products","href":"/api-reference/advanced-trade-api/rest-api/products/list-products"}]},{"group":"Public","pages":[{"title":"Get Public Market Trades","openapi":"GET /api/v3/brokerage/market/products/{product_id}/ticker","href":"/api-reference/advanced-trade-api/rest-api/public/get-public-market-trades"},{"title":"Get Public Product","openapi":"GET /api/v3/brokerage/market/products/{product_id}","href":"/api-reference/advanced-trade-api/rest-api/public/get-public-product"},{"title":"Get Public Product Book","openapi":"GET /api/v3/brokerage/market/product_book","href":"/api-reference/advanced-trade-api/rest-api/public/get-public-product-book"},{"title":"Get Public Product Candles","openapi":"GET /api/v3/brokerage/market/products/{product_id}/candles","href":"/api-reference/advanced-trade-api/rest-api/public/get-public-product-candles"},{"title":"Get Server Time","openapi":"GET /api/v3/brokerage/time","href":"/api-reference/advanced-trade-api/rest-api/public/get-server-time"},{"title":"List Public Products","openapi":"GET /api/v3/brokerage/market/products","href":"/api-reference/advanced-trade-api/rest-api/public/list-public-products"}]}]},{"group":"Spot \u0026 US Derivatives - WS Streams","pages":[{"group":"Market Data","pages":[{"title":"Heartbeats","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json heartbeats","href":"/api-reference/advanced-trade-api/websocket/heartbeats"},{"title":"Candles","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json candles","href":"/api-reference/advanced-trade-api/websocket/candles"},{"title":"Product status","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json status","href":"/api-reference/advanced-trade-api/websocket/product-status"},{"title":"Ticker","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json ticker","href":"/api-reference/advanced-trade-api/websocket/ticker"},{"title":"Ticker (batched)","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json ticker_batch","href":"/api-reference/advanced-trade-api/websocket/ticker-batch"},{"title":"Level 2 order book","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json level2","href":"/api-reference/advanced-trade-api/websocket/level2"},{"title":"Market trades","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json market_trades","href":"/api-reference/advanced-trade-api/websocket/market-trades"}]},{"group":"Private","pages":[{"title":"User orders and positions","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json user","href":"/api-reference/advanced-trade-api/websocket/user"},{"title":"Futures balance summary","asyncapi":"api-reference/advanced-trade-api/advanced-trade-asyncapi.json futures_balance_summary","href":"/api-reference/advanced-trade-api/websocket/futures-balance-summary"}]}]},{"group":"Global Derivatives - REST / WS","pages":[{"group":"Trading","pages":[{"title":"private/buy","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/buy","href":"/api-reference/trading/private-buy"},{"title":"private/cancel","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel","href":"/api-reference/trading/private-cancel"},{"title":"private/cancel_all","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_all","href":"/api-reference/trading/private-cancel_all"},{"title":"private/cancel_all_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_all_by_currency","href":"/api-reference/trading/private-cancel_all_by_currency"},{"title":"private/cancel_all_by_currency_pair","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_all_by_currency_pair","href":"/api-reference/trading/private-cancel_all_by_currency_pair"},{"title":"private/cancel_all_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_all_by_instrument","href":"/api-reference/trading/private-cancel_all_by_instrument"},{"title":"private/cancel_all_by_kind_or_type","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_all_by_kind_or_type","href":"/api-reference/trading/private-cancel_all_by_kind_or_type"},{"title":"private/cancel_by_label","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/cancel_by_label","href":"/api-reference/trading/private-cancel_by_label"},{"title":"private/close_position","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/close_position","href":"/api-reference/trading/private-close_position"},{"title":"private/edit","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/edit","href":"/api-reference/trading/private-edit"},{"title":"private/edit_by_label","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/edit_by_label","href":"/api-reference/trading/private-edit_by_label"},{"title":"private/get_margins","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_margins","href":"/api-reference/trading/private-get_margins"},{"title":"private/get_max_order_size","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_max_order_size","href":"/api-reference/trading/private-get_max_order_size"},{"title":"private/get_open_orders","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_open_orders","href":"/api-reference/trading/private-get_open_orders"},{"title":"private/get_open_orders_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_open_orders_by_currency","href":"/api-reference/trading/private-get_open_orders_by_currency"},{"title":"private/get_open_orders_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_open_orders_by_instrument","href":"/api-reference/trading/private-get_open_orders_by_instrument"},{"title":"private/get_open_orders_by_label","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_open_orders_by_label","href":"/api-reference/trading/private-get_open_orders_by_label"},{"title":"private/get_order_history_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_order_history_by_currency","href":"/api-reference/trading/private-get_order_history_by_currency"},{"title":"private/get_order_history_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_order_history_by_instrument","href":"/api-reference/trading/private-get_order_history_by_instrument"},{"title":"private/get_order_margin_by_ids","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_order_margin_by_ids","href":"/api-reference/trading/private-get_order_margin_by_ids"},{"title":"private/get_order_state","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_order_state","href":"/api-reference/trading/private-get_order_state"},{"title":"private/get_order_state_by_label","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_order_state_by_label","href":"/api-reference/trading/private-get_order_state_by_label"},{"title":"private/get_settlement_history_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_settlement_history_by_currency","href":"/api-reference/trading/private-get_settlement_history_by_currency"},{"title":"private/get_settlement_history_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_settlement_history_by_instrument","href":"/api-reference/trading/private-get_settlement_history_by_instrument"},{"title":"private/get_trigger_order_history","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_trigger_order_history","href":"/api-reference/trading/private-get_trigger_order_history"},{"title":"private/get_user_trades_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_trades_by_currency","href":"/api-reference/trading/private-get_user_trades_by_currency"},{"title":"private/get_user_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_trades_by_currency_and_time","href":"/api-reference/trading/private-get_user_trades_by_currency_and_time"},{"title":"private/get_user_trades_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_trades_by_instrument","href":"/api-reference/trading/private-get_user_trades_by_instrument"},{"title":"private/get_user_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_trades_by_instrument_and_time","href":"/api-reference/trading/private-get_user_trades_by_instrument_and_time"},{"title":"private/get_user_trades_by_order","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_trades_by_order","href":"/api-reference/trading/private-get_user_trades_by_order"},{"title":"private/sell","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/sell","href":"/api-reference/trading/private-sell"},{"title":"private/set_leverage","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/set_leverage","href":"/api-reference/trading/private-set_leverage"}]},{"group":"Account Management","pages":[{"title":"private/change_margin_model","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/change_margin_model","href":"/api-reference/account-management/private-change_margin_model"},{"title":"private/get_access_log","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_access_log","href":"/api-reference/account-management/private-get_access_log"},{"title":"private/get_account_summaries","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_account_summaries","href":"/api-reference/account-management/private-get_account_summaries"},{"title":"private/get_account_summary","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_account_summary","href":"/api-reference/account-management/private-get_account_summary"},{"title":"private/get_leverage","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_leverage","href":"/api-reference/account-management/private-get_leverage"},{"title":"private/get_pme_params","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_pme_params","href":"/api-reference/account-management/private-get_pme_params"},{"title":"private/get_position","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_position","href":"/api-reference/account-management/private-get_position"},{"title":"private/get_positions","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_positions","href":"/api-reference/account-management/private-get_positions"},{"title":"private/get_risk_profile","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_risk_profile","href":"/api-reference/account-management/private-get_risk_profile"},{"title":"private/get_subaccounts","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_subaccounts","href":"/api-reference/account-management/private-get_subaccounts"},{"title":"private/get_subaccounts_details","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_subaccounts_details","href":"/api-reference/account-management/private-get_subaccounts_details"},{"title":"private/get_trading_limits","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_trading_limits","href":"/api-reference/account-management/private-get_trading_limits"},{"title":"private/get_transaction_log","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_transaction_log","href":"/api-reference/account-management/private-get_transaction_log"},{"title":"private/get_user_locks","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_user_locks","href":"/api-reference/account-management/private-get_user_locks"},{"title":"private/pme/simulate","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/pme/simulate","href":"/api-reference/account-management/private-simulate"},{"title":"private/simulate_portfolio","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/simulate_portfolio","href":"/api-reference/account-management/private-simulate_portfolio"},{"title":"public/get_announcements","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_announcements","href":"/api-reference/account-management/public-get_announcements"}]},{"group":"Combo Books","pages":[{"title":"private/create_combo","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/create_combo","href":"/api-reference/combo-books/private-create_combo"},{"title":"private/get_leg_prices","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_leg_prices","href":"/api-reference/combo-books/private-get_leg_prices"},{"title":"public/get_combo_details","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_combo_details","href":"/api-reference/combo-books/public-get_combo_details"},{"title":"public/get_combo_ids","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_combo_ids","href":"/api-reference/combo-books/public-get_combo_ids"},{"title":"public/get_combos","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_combos","href":"/api-reference/combo-books/public-get_combos"}]},{"group":"Session Management","pages":[{"title":"private/disable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/disable_cancel_on_disconnect","href":"/api-reference/session-management/private-disable_cancel_on_disconnect"},{"title":"private/enable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/enable_cancel_on_disconnect","href":"/api-reference/session-management/private-enable_cancel_on_disconnect"},{"title":"private/get_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_cancel_on_disconnect","href":"/api-reference/session-management/private-get_cancel_on_disconnect"},{"title":"public/disable_heartbeat","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/disable_heartbeat","href":"/api-reference/session-management/public-disable_heartbeat"},{"title":"public/set_heartbeat","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/set_heartbeat","href":"/api-reference/session-management/public-set_heartbeat"}]},{"group":"Authentication","pages":[{"title":"private/logout","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/logout","href":"/api-reference/authentication/private-logout"},{"title":"public/auth","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json post /public/auth","href":"/api-reference/coinbase-deribit-app-api/rest-api/authentication/post-publicauth"}]},{"group":"Wallet","pages":[{"title":"private/submit_transfer_between_subaccounts","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/submit_transfer_between_subaccounts","href":"/api-reference/wallet/private-submit_transfer_between_subaccounts"}]},{"group":"Subscription Management","pages":[{"title":"private/subscribe","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/subscribe","href":"/api-reference/subscription-management/private-subscribe"},{"title":"private/unsubscribe","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/unsubscribe","href":"/api-reference/subscription-management/private-unsubscribe"},{"title":"private/unsubscribe_all","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/unsubscribe_all","href":"/api-reference/subscription-management/private-unsubscribe_all"},{"title":"public/subscribe","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/subscribe","href":"/api-reference/subscription-management/public-subscribe"},{"title":"public/unsubscribe","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/unsubscribe","href":"/api-reference/subscription-management/public-unsubscribe"},{"title":"public/unsubscribe_all","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/unsubscribe_all","href":"/api-reference/subscription-management/public-unsubscribe_all"}]},{"group":"Market Data","pages":[{"title":"public/get_book_summary_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_book_summary_by_currency","href":"/api-reference/market-data/public-get_book_summary_by_currency"},{"title":"public/get_book_summary_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_book_summary_by_instrument","href":"/api-reference/market-data/public-get_book_summary_by_instrument"},{"title":"public/get_contract_size","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_contract_size","href":"/api-reference/market-data/public-get_contract_size"},{"title":"public/get_currencies","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_currencies","href":"/api-reference/market-data/public-get_currencies"},{"title":"public/get_delivery_prices","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_delivery_prices","href":"/api-reference/market-data/public-get_delivery_prices"},{"title":"public/get_expirations","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_expirations","href":"/api-reference/market-data/public-get_expirations"},{"title":"public/get_funding_chart_data","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_funding_chart_data","href":"/api-reference/market-data/public-get_funding_chart_data"},{"title":"public/get_funding_rate_history","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_funding_rate_history","href":"/api-reference/market-data/public-get_funding_rate_history"},{"title":"public/get_funding_rate_value","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_funding_rate_value","href":"/api-reference/market-data/public-get_funding_rate_value"},{"title":"public/get_historical_volatility","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_historical_volatility","href":"/api-reference/market-data/public-get_historical_volatility"},{"title":"public/get_index_chart_data","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_index_chart_data","href":"/api-reference/market-data/public-get_index_chart_data"},{"title":"public/get_index_price","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_index_price","href":"/api-reference/market-data/public-get_index_price"},{"title":"public/get_index_price_names","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_index_price_names","href":"/api-reference/market-data/public-get_index_price_names"},{"title":"public/get_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_instrument","href":"/api-reference/market-data/public-get_instrument"},{"title":"public/get_instruments","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_instruments","href":"/api-reference/market-data/public-get_instruments"},{"title":"public/get_last_settlements_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_settlements_by_currency","href":"/api-reference/market-data/public-get_last_settlements_by_currency"},{"title":"public/get_last_settlements_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_settlements_by_instrument","href":"/api-reference/market-data/public-get_last_settlements_by_instrument"},{"title":"public/get_last_trades_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_trades_by_currency","href":"/api-reference/market-data/public-get_last_trades_by_currency"},{"title":"public/get_last_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_trades_by_currency_and_time","href":"/api-reference/market-data/public-get_last_trades_by_currency_and_time"},{"title":"public/get_last_trades_by_instrument","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_trades_by_instrument","href":"/api-reference/market-data/public-get_last_trades_by_instrument"},{"title":"public/get_last_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_last_trades_by_instrument_and_time","href":"/api-reference/market-data/public-get_last_trades_by_instrument_and_time"},{"title":"public/get_mark_price_history","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_mark_price_history","href":"/api-reference/market-data/public-get_mark_price_history"},{"title":"public/get_order_book","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_order_book","href":"/api-reference/market-data/public-get_order_book"},{"title":"public/get_order_book_by_instrument_id","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_order_book_by_instrument_id","href":"/api-reference/market-data/public-get_order_book_by_instrument_id"},{"title":"public/get_supported_index_names","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_supported_index_names","href":"/api-reference/market-data/public-get_supported_index_names"},{"title":"public/get_trade_volumes","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_trade_volumes","href":"/api-reference/market-data/public-get_trade_volumes"},{"title":"public/get_tradingview_chart_data","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_tradingview_chart_data","href":"/api-reference/market-data/public-get_tradingview_chart_data"},{"title":"public/get_volatility_index_data","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_volatility_index_data","href":"/api-reference/market-data/public-get_volatility_index_data"},{"title":"public/ticker","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/ticker","href":"/api-reference/market-data/public-ticker"},{"title":"public/tickers_by_currency","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/tickers_by_currency","href":"/api-reference/market-data/public-tickers_by_currency"}]},{"group":"Supporting","pages":[{"title":"public/get_time","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/get_time","href":"/api-reference/supporting/public-get_time"},{"title":"public/hello","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/hello","href":"/api-reference/supporting/public-hello"},{"title":"public/status","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/status","href":"/api-reference/supporting/public-status"},{"title":"public/test","deprecated":null,"version":null,"openapi":"/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /public/test","href":"/api-reference/supporting/public-test"}]}]},{"group":"Global Derivatives - WS Streams","pages":[{"group":"Announcements","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json announcements","title":"announcements ","href":"/api-reference/coinbase-deribit-app-api/websocket/announcements/announcements"}]},{"group":"Orderbook","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json book.(instrument_name).(group).(depth).(interval)","title":"book.(instrument_name).(group).(depth).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_namegroupdepthinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json book.(instrument_name).(interval)","title":"book.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_nameinterval"}]},{"group":"Market Data","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json chart.trades.(instrument_name).(resolution)","title":"chart.trades.(instrument_name).(resolution) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/charttradesinstrument_nameresolution"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json deribit_price_index.(index_name)","title":"deribit_price_index.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_indexindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json deribit_price_ranking.(index_name)","title":"deribit_price_ranking.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_rankingindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json deribit_price_statistics.(index_name)","title":"deribit_price_statistics.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_statisticsindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json deribit_volatility_index.(index_name)","title":"deribit_volatility_index.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_volatility_indexindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json estimated_expiration_price.(index_name)","title":"estimated_expiration_price.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/estimated_expiration_priceindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json incremental_ticker.(instrument_name)","title":"incremental_ticker.(instrument_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/incremental_tickerinstrument_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json instrument.creation.(kind).(currency)","title":"instrument.creation.(kind).(currency) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/instrumentcreationkindcurrency"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json instrument.state.(kind).(currency)","title":"instrument.state.(kind).(currency) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/instrumentstatekindcurrency"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json markprice.options.(index_name)","title":"markprice.options.(index_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/markpriceoptionsindex_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json perpetual.(instrument_name).(interval)","title":"perpetual.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/perpetualinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json quote.(instrument_name)","title":"quote.(instrument_name) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/quoteinstrument_name"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json ticker.(instrument_name).(interval)","title":"ticker.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval"}]},{"group":"Platform","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json platform_state","title":"platform_state ","href":"/api-reference/coinbase-deribit-app-api/websocket/platform/platform_state"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json platform_state.public_methods_state","title":"platform_state.public_methods_state ","href":"/api-reference/coinbase-deribit-app-api/websocket/platform/platform_statepublic_methods_state"}]},{"group":"Trades","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json trades.(instrument_name).(interval)","title":"trades.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/trades/tradesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json trades.(kind).(currency).(interval)","title":"trades.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/trades/tradeskindcurrencyinterval"}]},{"group":"User","pages":[{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.access_log","title":"user.access_log ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/useraccess_log"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.changes.(instrument_name).(interval)","title":"user.changes.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userchangesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.changes.(kind).(currency).(interval)","title":"user.changes.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userchangeskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.combo_trades.(instrument_name).(interval)","title":"user.combo_trades.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/usercombo_tradesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.combo_trades.(kind).(currency).(interval)","title":"user.combo_trades.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/usercombo_tradeskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.changes.(instrument_name).(interval)","title":"user.isolated.changes.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedchangesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.changes.(kind).(currency).(interval)","title":"user.isolated.changes.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedchangeskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.liquidation","title":"user.isolated.liquidation ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedliquidation"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.orders.(instrument_name).(interval)","title":"user.isolated.orders.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedordersinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.orders.(kind).(currency).(interval)","title":"user.isolated.orders.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedorderskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.portfolio.(currency)","title":"user.isolated.portfolio.(currency) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedportfoliocurrency"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.trades.(instrument_name).(interval)","title":"user.isolated.trades.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedtradesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.isolated.trades.(kind).(currency).(interval)","title":"user.isolated.trades.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userisolatedtradeskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.lock","title":"user.lock ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userlock"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.orders.(instrument_name).(interval)","title":"user.orders.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.orders.(instrument_name).raw","title":"user.orders.(instrument_name).raw ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameraw"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.orders.(kind).(currency).(interval)","title":"user.orders.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userorderskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.orders.(kind).(currency).raw","title":"user.orders.(kind).(currency).raw ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userorderskindcurrencyraw"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.portfolio.(currency)","title":"user.portfolio.(currency) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userportfoliocurrency"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.position_lock","title":"user.position_lock ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/userposition_lock"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.trades.(instrument_name).(interval)","title":"user.trades.(instrument_name).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/usertradesinstrument_nameinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.trades.(kind).(currency).(interval)","title":"user.trades.(kind).(currency).(interval) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/usertradeskindcurrencyinterval"},{"asyncapi":"api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json user.trailing_orders.trigger_price.(currency)","title":"user.trailing_orders.trigger_price.(currency) ","href":"/api-reference/coinbase-deribit-app-api/websocket/user/usertrailing_orderstrigger_pricecurrency"}]}]}]},{"dropdown":"Coinbase Business API","icon":"https://mintlify-assets.b-cdn.net/coinbase-0.svg","groups":[{"group":"REST API","pages":[{"title":"Welcome to Coinbase Business API","sidebarTitle":"Overview","href":"/api-reference/business-api/rest-api/introduction"},{"group":"Checkouts","pages":[{"title":"Checkouts API Reference","sidebarTitle":"Overview","href":"/api-reference/business-api/rest-api/checkouts/introduction"},{"openapi":"post /api/v1/checkouts","playground":"simple","title":"Create Checkout","href":"/api-reference/business-api/rest-api/checkouts/create-checkout"},{"openapi":"get /api/v1/checkouts","playground":"simple","title":"List Checkouts","href":"/api-reference/business-api/rest-api/checkouts/list-checkouts"},{"openapi":"get /api/v1/checkouts/{id}","playground":"simple","title":"Get Checkout","href":"/api-reference/business-api/rest-api/checkouts/get-checkout"},{"openapi":"post /api/v1/checkouts/{id}/deactivate","playground":"simple","title":"Deactivate Checkout","href":"/api-reference/business-api/rest-api/checkouts/deactivate-checkout"},{"openapi":"post /api/v1/checkouts/{id}/refund","playground":"simple","title":"Refund Checkout","href":"/api-reference/business-api/rest-api/checkouts/refund-checkout"}]},{"group":"Invoicing","pages":[{"title":"Invoicing API Reference","sidebarTitle":"Overview","href":"/api-reference/business-api/rest-api/invoicing/introduction"},{"openapi":"get /api/v1/invoices","playground":"simple","title":"List Invoices","href":"/api-reference/business-api/rest-api/invoicing/list-invoices"},{"openapi":"get /api/v1/invoices/{invoiceUuid}","playground":"simple","title":"Get Invoice","href":"/api-reference/business-api/rest-api/invoicing/get-invoice"}]},{"group":"Advanced Trade APIs","pages":[{"title":"API Reference","url":"/api-reference/advanced-trade-api/rest-api/introduction","href":"/coinbase-business/advanced-trade-apis/api-reference"}]},{"group":"Transfer APIs","pages":[{"title":"Send Crypto","href":"/coinbase-business/transfer-apis/send-crypto"},{"title":"Onchain Addresses","href":"/coinbase-business/transfer-apis/onchain-addresses"},{"title":"Fiat Deposits","sidebarTitle":"Deposits Fiat","href":"/coinbase-business/transfer-apis/deposit-fiat"},{"title":"Fiat Withdrawals","sidebarTitle":"Withdrawals Fiat","href":"/coinbase-business/transfer-apis/withdraw-fiat"},{"title":"Travel Rule Fields for Crypto Sends Guide","sidebarTitle":"Travel Rule","href":"/coinbase-business/transfer-apis/travel-rule"},{"title":"Supported Virtual Asset Service Provider (VASP) Tables","sidebarTitle":"VASPs","href":"/coinbase-business/transfer-apis/vasps"}]},{"group":"Track APIs","pages":[{"title":"Accounts","href":"/coinbase-business/track-apis/accounts"},{"title":"Transactions","href":"/coinbase-business/track-apis/transactions"},{"title":"Data API - Currencies","sidebarTitle":"Currencies","href":"/coinbase-business/track-apis/currencies"},{"title":"Data API- Exchange Rates","sidebarTitle":"Exchange Rates","href":"/coinbase-business/track-apis/exchange-rates"},{"title":"Data API- Prices","sidebarTitle":"Prices","href":"/coinbase-business/track-apis/prices"},{"title":"Data API- Time","sidebarTitle":"Time","href":"/coinbase-business/track-apis/time"}]}]}]},{"dropdown":"Coinbase Exchange API","icon":"https://mintlify-assets.b-cdn.net/exchangeProduct-1.svg","groups":[{"group":"REST API","pages":[{"title":"Welcome to Coinbase Exchange API","sidebarTitle":"Overview","href":"/api-reference/exchange-api/rest-api/introduction"},{"title":"Exchange REST API Requests","sidebarTitle":"Requests","href":"/exchange/rest-api/requests"},{"title":"Exchange REST API Authentication","sidebarTitle":"Authentication","href":"/exchange/rest-api/authentication"},{"title":"REST Rate Limits Overview","sidebarTitle":"Rate Limits","href":"/exchange/rest-api/rate-limits"},{"title":"Exchange REST API Pagination","sidebarTitle":"Pagination","href":"/exchange/rest-api/pagination"},{"title":"Exchange REST API SDKs","sidebarTitle":"SDKs","href":"/exchange/rest-api/sdks"},{"title":"Exchange Types","sidebarTitle":"Types","href":"/exchange/rest-api/types"},{"group":"Accounts","pages":[{"title":"Get a single account by id","openapi":"GET /accounts/{account_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/accounts/get-single-account-by-id"},{"title":"Get a single account's holds","openapi":"GET /accounts/{account_id}/holds","playground":"simple","href":"/api-reference/exchange-api/rest-api/accounts/get-single-account-hold"},{"title":"Get a single account's ledger","openapi":"GET /accounts/{account_id}/ledger","playground":"simple","href":"/api-reference/exchange-api/rest-api/accounts/get-single-account-ledger"},{"title":"Get a single account's transfers","openapi":"GET /accounts/{account_id}/transfers","playground":"simple","href":"/api-reference/exchange-api/rest-api/accounts/get-single-account-transfer"},{"title":"Get all accounts for a profile","openapi":"GET /accounts","playground":"simple","href":"/api-reference/exchange-api/rest-api/accounts/get-all-account-profile"}]},{"group":"Address Book","pages":[{"title":"Add addresses","openapi":"POST /address-book","playground":"simple","href":"/api-reference/exchange-api/rest-api/address-book/add-addresses"},{"title":"Delete address","openapi":"DELETE /address-book/{id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/address-book/delete-address"},{"title":"Get address book","openapi":"GET /address-book","playground":"simple","href":"/api-reference/exchange-api/rest-api/address-book/get-address-book"},{"title":"Get counterparty address book","openapi":"get /address-book/counterparty","playground":"simple","href":"/api-reference/exchange-api/rest-api/address-book/get-counterparty-address-book"},{"openapi":"put /address-book/{id}","playground":"simple","title":"Update address book","href":"/api-reference/exchange-api/rest-api/address-book/update-address-book"}]},{"group":"Coinbase Accounts","pages":[{"title":"Generate crypto address","openapi":"POST /coinbase-accounts/{account_id}/addresses","playground":"simple","href":"/api-reference/exchange-api/rest-api/coinbase-accounts/generate-crypto-address"},{"title":"Get all Coinbase wallets","openapi":"GET /coinbase-accounts","playground":"simple","href":"/api-reference/exchange-api/rest-api/coinbase-accounts/get-all-coinbase-wallets"}]},{"group":"Conversions","pages":[{"title":"Convert currency","openapi":"POST /conversions","playground":"simple","href":"/api-reference/exchange-api/rest-api/conversions/convert-currency"},{"title":"Get a conversion","openapi":"GET /conversions/{conversion_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/conversions/get-a-conversion"},{"title":"Get all conversions","openapi":"GET /conversions","playground":"simple","href":"/api-reference/exchange-api/rest-api/conversions/get-all-conversions"},{"title":"Get conversion fee rates","openapi":"GET /conversions/fees","playground":"simple","href":"/api-reference/exchange-api/rest-api/conversions/get-conversion-fee-rates"}]},{"group":"Currencies","pages":[{"title":"Get a currency","openapi":"GET /currencies/{currency_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/currencies/get-a-currency"},{"title":"Get all known currencies","openapi":"GET /currencies","playground":"simple","href":"/api-reference/exchange-api/rest-api/currencies/get-all-known-currencies"}]},{"group":"Fees","pages":[{"title":"Get fees","openapi":"GET /fees","playground":"simple","href":"/api-reference/exchange-api/rest-api/fees/get-fee"}]},{"group":"Futures","pages":[{"title":"Get auto loan setting","openapi":"GET /margin/auto-loan","playground":"simple","href":"/api-reference/exchange-api/rest-api/futures/get-auto-loan-setting"},{"title":"Get USDC conversion","openapi":"GET /margin/usdc","playground":"simple","href":"/api-reference/exchange-api/rest-api/futures/get-usdc-conversion"},{"title":"Set auto loan","openapi":"POST /margin/auto-loan","playground":"simple","href":"/api-reference/exchange-api/rest-api/futures/set-auto-loan"},{"title":"Set USDC conversion","openapi":"POST /margin/usdc","playground":"simple","href":"/api-reference/exchange-api/rest-api/futures/set-usdc-conversion"}]},{"group":"Loan","pages":[{"title":"Get lending overview","openapi":"GET /loans/lending-overview","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-lending-overview"},{"title":"Get lending overview XM","openapi":"GET /loans/lending-overview-xm","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-lending-overview-xm"},{"title":"Get new loan preview","openapi":"GET /loans/loan-preview","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-new-loan-preview"},{"title":"Get loan preview XM","openapi":"GET /loans/loan-preview-xm","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-loan-preview-xm"},{"title":"Get principal repayment preview","openapi":"GET /loans/repayment-preview","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-principal-repayment-preview"},{"title":"Get repayment preview XM","openapi":"GET /loans/repayment-preview-xm","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/get-repayment-preview-xm"},{"title":"List interest charges","openapi":"GET /loans/interest/{loan_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-interest-charges"},{"title":"List interest rate history","openapi":"GET /loans/interest/history/{loan_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-interest-rate-history"},{"title":"List interest summaries","openapi":"GET /loans/interest","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-interest-summaries"},{"title":"List loan assets","openapi":"GET /loans/assets","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-loan-assets"},{"title":"List loans","openapi":"GET /loans","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-loans"},{"title":"List new loan options","openapi":"GET /loans/options","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/list-new-loan-options"},{"title":"Open new loan","openapi":"POST /loans/open","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/open-new-loan"},{"title":"Repay loan interest","openapi":"POST /loans/repay-interest","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/repay-loan-interest"},{"title":"Repay loan principal","openapi":"POST /loans/repay-principal","playground":"simple","href":"/api-reference/exchange-api/rest-api/loan/repay-loan-principal"}]},{"group":"Orders","pages":[{"title":"Cancel all orders","openapi":"DELETE /orders","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/cancel-all-orders"},{"title":"Cancel an order","openapi":"DELETE /orders/{order_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/cancel-an-order"},{"title":"Create a new order","openapi":"POST /orders","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/create-new-order"},{"title":"Get all fills","openapi":"GET /fills","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/get-all-fills"},{"title":"Get all orders","openapi":"GET /orders","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/get-all-orders"},{"title":"Get single order","openapi":"GET /orders/{order_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/orders/get-single-order"}]},{"group":"Products","pages":[{"title":"Get all known trading pairs","openapi":"GET /products","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-all-known-trading-pairs"},{"title":"Get all product volume","openapi":"GET /products/volume-summary","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-all-product-volume"},{"title":"Get product book","openapi":"GET /products/{product_id}/book","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-product-book"},{"title":"Get product candles","openapi":"GET /products/{product_id}/candles","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-product-candles"},{"title":"Get product stats","openapi":"GET /products/{product_id}/stats","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-product-stats"},{"title":"Get product ticker","openapi":"GET /products/{product_id}/ticker","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-product-ticker"},{"title":"Get product trades","openapi":"GET /products/{product_id}/trades","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-product-trades"},{"title":"Get single product","openapi":"GET /products/{product_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/products/get-single-product"}]},{"group":"Profiles","pages":[{"title":"Create a profile","openapi":"POST /profiles","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/create-profile"},{"title":"Delete a profile","openapi":"PUT /profiles/{profile_id}/deactivate","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/delete-profile"},{"title":"Get profile by id","openapi":"GET /profiles/{profile_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/get-profile-by-id"},{"title":"Get profiles","openapi":"GET /profiles","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/get-profiles"},{"title":"Rename a profile","openapi":"PUT /profiles/{profile_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/rename-profile"},{"title":"Transfer funds between profiles","openapi":"POST /profiles/transfer","playground":"simple","href":"/api-reference/exchange-api/rest-api/profiles/transfer-funds-profile"}]},{"group":"Reports","pages":[{"title":"Create a report","openapi":"POST /reports","playground":"simple","href":"/api-reference/exchange-api/rest-api/reports/create-report"},{"title":"Get a report","openapi":"GET /reports/{report_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/reports/get-report"},{"title":"Get all reports","openapi":"GET /reports","playground":"simple","href":"/api-reference/exchange-api/rest-api/reports/get-all-reports"}]},{"group":"Transfers","pages":[{"title":"Deposit from Coinbase account","openapi":"POST /deposits/coinbase-account","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/deposit-from-coinbase-account"},{"title":"Deposit from payment method","openapi":"POST /deposits/payment-method","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/deposit-from-payment-method"},{"title":"Get a single transfer","openapi":"GET /transfers/{transfer_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/get-single-transfer"},{"title":"Get all payment methods","openapi":"GET /payment-methods","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/get-all-payment-methods"},{"title":"Get all transfers","openapi":"GET /transfers","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/get-all-transfers"},{"title":"Get fee estimate for crypto withdrawal","openapi":"GET /withdrawals/fee-estimate","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/get-fee-estimate"},{"title":"Submit travel information for a transfer","openapi":"POST /transfers/{transfer_id}/travel-rules","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/submit-travel-info"},{"title":"Withdraw to Coinbase account","openapi":"POST /withdrawals/coinbase-account","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/withdraw-to-coinbase-account"},{"title":"Withdraw to counterparty Id","openapi":"post /withdrawals/counterparty","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/withdraw-to-counterparty"},{"title":"Withdraw to crypto address","openapi":"POST /withdrawals/crypto","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/withdraw-to-crypto-address"},{"title":"Withdraw to payment method","openapi":"POST /withdrawals/payment-method","playground":"simple","href":"/api-reference/exchange-api/rest-api/transfers/withdraw-to-payment-method"}]},{"group":"Travel Rules","pages":[{"title":"Create travel rule entry","openapi":"POST /travel-rules","playground":"simple","href":"/api-reference/exchange-api/rest-api/travel-rules/create-travel-rule"},{"title":"Delete existing travel rule entry","openapi":"DELETE /travel-rules/{id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/travel-rules/delete-existing-travel-rule"},{"title":"Get all travel rule information","openapi":"GET /travel-rules","playground":"simple","href":"/api-reference/exchange-api/rest-api/travel-rules/get-all-travel-rule"}]},{"group":"Users","pages":[{"title":"Get user exchange limits","openapi":"GET /users/{user_id}/exchange-limits","playground":"simple","href":"/api-reference/exchange-api/rest-api/users/get-user-exchange-limits"},{"title":"Get user trading volume","openapi":"GET /users/{user_id}/trading-volumes","playground":"simple","href":"/api-reference/exchange-api/rest-api/users/get-user-trading-volume"},{"title":"Update settlement preference","openapi":"POST /users/{user_id}/settlement-preferences","playground":"simple","href":"/api-reference/exchange-api/rest-api/users/update-settlement-preference"}]},{"group":"Wrapped Assets","pages":[{"title":"Create a new redeem","openapi":"POST /wrapped-assets/redeem","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/create-new-redeem"},{"title":"Create a new stake-wrap","openapi":"POST /wrapped-assets/stake-wrap","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/create-new-stake-wrap"},{"title":"Get a single redeem","openapi":"GET /wrapped-assets/redeem/{redeem_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-single-redeem"},{"title":"Get a single stake-wrap","openapi":"GET /wrapped-assets/stake-wrap/{stake_wrap_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-a-single-stake-wrap"},{"title":"Get all redeems","openapi":"GET /wrapped-assets/redeem","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-all-redeems"},{"title":"Get all stake-wraps","openapi":"GET /wrapped-assets/stake-wrap","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-all-stake-wraps"},{"title":"Get all wrapped assets","openapi":"GET /wrapped-assets","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-all-wrapped-assets"},{"title":"Get wrapped asset conversion rate","openapi":"GET /wrapped-assets/{wrapped_asset_id}/conversion-rate","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-wrapped-asset-conversion-rate"},{"title":"Get wrapped asset details","openapi":"GET /wrapped-assets/{wrapped_asset_id}","playground":"simple","href":"/api-reference/exchange-api/rest-api/wrapped-assets/get-wrapped-asset-details"}]}]},{"group":"FIX API","pages":[{"title":"Exchange FIX API Connectivity","sidebarTitle":"Connectivity","href":"/exchange/fix-api/connectivity"},{"title":"Exchange FIX Best Practices","sidebarTitle":"Best Practices","href":"/exchange/fix-api/best-practices"},{"title":"FIX Rate Limits Overview","sidebarTitle":"Rate Limits","href":"/exchange/fix-api/rate-limits"},{"title":"Exchange FIX Drop Copy 5.0","sidebarTitle":"Drop Copy","href":"/exchange/fix-api/drop-copy"},{"group":"Order Entry Messages","pages":[{"title":"Exchange FIX Order Entry Messages 5.0","sidebarTitle":"Order Entry Messages 5.0","href":"/exchange/fix-api/order-entry-messages/order-entry-messages5"},{"title":"Exchange Take Profit Stop Loss Orders","sidebarTitle":"TPSL Orders","href":"/exchange/fix-api/order-entry-messages/tpsl-orders"},{"title":"Exchange Limit With Funds Orders","sidebarTitle":"Limit With Funds Orders","href":"/exchange/fix-api/order-entry-messages/limit-orders"},{"title":"Exchange Synthetic Product Orders","sidebarTitle":"Synthetic Product Orders","href":"/exchange/fix-api/order-entry-messages/synthetic-product-orders"}]},{"title":"Exchange FIX Market Data Messages 5.0","sidebarTitle":"Market Data Messages","href":"/exchange/fix-api/market-data"},{"title":"Exchange FIX Dictionary Downloads","sidebarTitle":"Dictionary Downloads","href":"/exchange/fix-api/dictionary-downloads"}]},{"group":"Websocket Feed","pages":[{"title":"Exchange WebSocket Overview","sidebarTitle":"Overview","href":"/exchange/websocket-feed/overview"},{"title":"Exchange WebSocket Best Practices","sidebarTitle":"Best Practices","href":"/exchange/websocket-feed/best-practices"},{"title":"Exchange WebSocket Authentication","sidebarTitle":"Authentication","href":"/exchange/websocket-feed/authentication"},{"title":"Exchange WebSocket Channels","sidebarTitle":"Channels","href":"/exchange/websocket-feed/channels"},{"title":"Exchange WebSocket Rate Limits","sidebarTitle":"Rate Limits","href":"/exchange/websocket-feed/rate-limits"},{"title":"Exchange WebSocket Errors","sidebarTitle":"Errors","href":"/exchange/websocket-feed/errors"}]}]},{"dropdown":"Coinbase International Exchange API","icon":"https://mintlify-assets.b-cdn.net/internationalExchangeProduct-0.svg","groups":[{"group":"REST API","pages":[{"title":"Welcome to Coinbase INTX API","sidebarTitle":"Overview","href":"/api-reference/international-exchange-api/rest-api/introduction"},{"title":"INTX REST API Authentication","sidebarTitle":"Authentication","href":"/api-reference/international-exchange-api/rest-api/authentication"},{"group":"Address Book","pages":[{"title":"Get address book","openapi":"GET /api/v1/address-book","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/address-book/get-address-book"}]},{"group":"Portfolios","pages":[{"title":"Get balance for portfolio/asset","openapi":"GET /api/v1/portfolios/{portfolio}/balances/{asset}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-balance-for-assests"},{"title":"Get portfolio summary","openapi":"GET /api/v1/portfolios/{portfolio}/summary","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-summary"},{"title":"Get position for portfolio/instrument","openapi":"GET /api/v1/portfolios/{portfolio}/positions/{instrument}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-position-portfolio"},{"title":"Get user portfolio","openapi":"GET /api/v1/portfolios/{portfolio}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-user-portfolio"},{"title":"List all user portfolios","openapi":"GET /api/v1/portfolios","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-all-user-portfolios"},{"title":"List fills by portfolios","openapi":"GET /api/v1/portfolios/fills","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-fills-portfolio"},{"title":"List portfolio balances","openapi":"GET /api/v1/portfolios/{portfolio}/balances","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-balances"},{"title":"List portfolio fills","openapi":"GET /api/v1/portfolios/{portfolio}/fills","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-fills"},{"title":"List portfolio positions","openapi":"GET /api/v1/portfolios/{portfolio}/positions","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-positions"}]},{"group":"Transfers","pages":[{"title":"Get transfer","openapi":"GET /api/v1/transfers/{transfer_uuid}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/get-transfer"},{"title":"List matching transfers","openapi":"GET /api/v1/transfers","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/list-matching-transfers"}]}]}]},{"dropdown":"Coinbase Prime API","icon":"https://mintlify-assets.b-cdn.net/primeProduct-1.svg","groups":[{"group":"REST API","pages":[{"title":"Welcome to Coinbase Prime API","sidebarTitle":"Overview","href":"/api-reference/prime-api/rest-api/introduction"},{"title":"Prime Overview","href":"/prime/concepts/overview"},{"title":"Prime REST API Requests","sidebarTitle":"Requests","href":"/prime/rest-api/requests"},{"title":"Prime REST API Rate Limits","sidebarTitle":"Rate Limits","href":"/prime/rest-api/rate-limits"},{"title":"Prime REST API Authentication","sidebarTitle":"Authentication","href":"/prime/rest-api/authentication"},{"title":"API Key Rotation","sidebarTitle":"API Key Rotation","href":"/prime/rest-api/api-key-rotation"},{"title":"Prime REST API Pagination","sidebarTitle":"Pagination","href":"/prime/rest-api/pagination"},{"title":"Prime REST API CLI Setup Guide","sidebarTitle":"CLI Setup","href":"/prime/rest-api/cli-setup"},{"title":"Prime REST API SDKs","sidebarTitle":"SDKs","href":"/prime/rest-api/sdks"},{"title":"Prime Types","sidebarTitle":"Types","href":"/prime/rest-api/types"},{"title":"Error Dictionary","href":"/api-reference/prime-api/rest-api/errors"},{"group":"Activities","pages":[{"title":"Get Activity by Activity ID","openapi":"GET /v1/activities/{activity_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/activities/get-activity-by-activity-id"},{"title":"Get Portfolio Activity by Activity ID","openapi":"GET /v1/portfolios/{portfolio_id}/activities/{activity_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/activities/get-portfolio-activity-by-activity-id"},{"title":"List Activities","openapi":"GET /v1/portfolios/{portfolio_id}/activities","playground":"simple","href":"/api-reference/prime-api/rest-api/activities/list-activities"},{"title":"List Entity Activities","openapi":"GET /v1/entities/{entity_id}/activities","playground":"simple","href":"/api-reference/prime-api/rest-api/activities/list-entity-activities"}]},{"group":"Address Book","pages":[{"title":"Get Address Book","openapi":"GET /v1/portfolios/{portfolio_id}/address_book","playground":"simple","href":"/api-reference/prime-api/rest-api/address-book/get-address-book"},{"title":"Create Address Book Entry","openapi":"POST /v1/portfolios/{portfolio_id}/address_book","playground":"simple","href":"/api-reference/prime-api/rest-api/address-book/create-address-book-entry"}]},{"group":"Advanced Transfer","pages":[{"openapi":"get /v1/portfolios/{portfolio_id}/counterparty","playground":"simple","title":"Get Portfolio Counterparty ID","href":"/api-reference/prime-api/rest-api/advanced-transfer/get-portfolio-counterparty-id"},{"openapi":"get /v1/portfolios/{portfolio_id}/advanced_transfers","playground":"simple","title":"List Advanced Transfers","href":"/api-reference/prime-api/rest-api/advanced-transfer/list-advanced-transfers"},{"openapi":"post /v1/portfolios/{portfolio_id}/advanced_transfers/{advanced_transfer_id}/cancel","playground":"simple","title":"Cancel Advanced Transfer","href":"/api-reference/prime-api/rest-api/advanced-transfer/cancel-advanced-transfer"},{"openapi":"post /v1/portfolios/{portfolio_id}/advanced_transfers","playground":"simple","title":"Create Advanced Transfer","href":"/api-reference/prime-api/rest-api/advanced-transfer/create-advanced-transfer"}]},{"group":"Allocations","pages":[{"title":"Get Allocation by ID","openapi":"GET /v1/portfolios/{portfolio_id}/allocations/{allocation_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/allocations/get-allocation-by-id"},{"title":"Get Net Allocations by Netting ID","openapi":"GET /v1/portfolios/{portfolio_id}/allocations/net/{netting_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/allocations/get-net-allocations-by-netting-id"},{"openapi":"get /v1/portfolios/{portfolio_id}/allocations","playground":"simple","title":"List Portfolio Allocations","href":"/api-reference/prime-api/rest-api/allocations/list-portfolio-allocations"},{"title":"Create Portfolio Allocations","openapi":"POST /v1/allocations","playground":"simple","href":"/api-reference/prime-api/rest-api/allocations/create-portfolio-allocations"},{"title":"Create Portfolio Net Allocations","openapi":"POST /v1/allocations/net","playground":"simple","href":"/api-reference/prime-api/rest-api/allocations/create-portfolio-net-allocations"}]},{"group":"API Key Management","pages":[{"title":"Rotate API Key","openapi":"POST /v1/api-keys/rotate","playground":"simple","href":"/api-reference/prime-api/rest-api/api-key-management/rotate-api-key"}]},{"group":"Assets","pages":[{"title":"List Assets","openapi":"GET /v1/entities/{entity_id}/assets","playground":"simple","href":"/api-reference/prime-api/rest-api/assets/list-assets"}]},{"group":"Balances","pages":[{"title":"Get Wallet Balance","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/balance","playground":"simple","href":"/api-reference/prime-api/rest-api/balances/get-wallet-balance"},{"title":"List Entity Balances","openapi":"GET /v1/entities/{entity_id}/balances","playground":"simple","href":"/api-reference/prime-api/rest-api/balances/list-entity-balances"},{"title":"List Onchain Wallet Balances","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/web3_balances","playground":"simple","href":"/api-reference/prime-api/rest-api/balances/list-onchain-wallet-balances"},{"title":"List Portfolio Balances","openapi":"GET /v1/portfolios/{portfolio_id}/balances","playground":"simple","href":"/api-reference/prime-api/rest-api/balances/list-portfolio-balances"}]},{"group":"Commission","pages":[{"title":"Get Portfolio Commission","openapi":"GET /v1/portfolios/{portfolio_id}/commission","playground":"simple","href":"/api-reference/prime-api/rest-api/commission/get-portfolio-commission"}]},{"group":"Financing","pages":[{"openapi":"get /v1/conversion/fees","playground":"simple","title":"Get Conversion Fees","href":"/api-reference/prime-api/rest-api/financing/get-conversion-fees"},{"openapi":"get /v1/entities/{entity_id}/cross_margin/liquidation","playground":"simple","title":"Get Cross Margin Liquidation","href":"/api-reference/prime-api/rest-api/financing/get-cross-margin-liquidation"},{"openapi":"get /v1/entities/{entity_id}/cross_margin/risk_parameters","playground":"simple","title":"Get Cross Margin Risk Parameters","href":"/api-reference/prime-api/rest-api/financing/get-cross-margin-risk-parameters"},{"title":"Get Entity Locate Availabilities","openapi":"GET /v1/entities/{entity_id}/locates_availability","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-entity-locate-availabilities"},{"openapi":"get /v1/entities/{entity_id}/rewards/rate","playground":"simple","title":"Get Entity Rewards Rate (Beta)","href":"/api-reference/prime-api/rest-api/financing/get-entity-rewards-rate-beta"},{"openapi":"get /v1/entities/{entity_id}/cross_margin","playground":"simple","title":"Get Exchange Cross Margin Overview","href":"/api-reference/prime-api/rest-api/financing/get-exchange-cross-margin-overview"},{"title":"Get Margin Information","openapi":"GET /v1/entities/{entity_id}/margin","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-margin-information"},{"openapi":"get /v1/entities/{entity_id}/market_data","playground":"simple","title":"Get Market Data","href":"/api-reference/prime-api/rest-api/financing/get-market-data"},{"title":"Get Portfolio Buying Power","openapi":"GET /v1/portfolios/{portfolio_id}/buying_power","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-portfolio-buying-power"},{"title":"Get Portfolio Credit Information","openapi":"GET /v1/portfolios/{portfolio_id}/credit","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-portfolio-credit-information"},{"openapi":"get /v1/portfolios/{portfolio_id}/rewards/rate","playground":"simple","title":"Get Portfolio Rewards Rate (Beta)","href":"/api-reference/prime-api/rest-api/financing/get-portfolio-rewards-rate-beta"},{"title":"Get Portfolio Withdrawal Power","openapi":"GET /v1/portfolios/{portfolio_id}/withdrawal_power","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-portfolio-withdrawal-power"},{"openapi":"get /v2/entities/{entity_id}/cross_margin/prime","playground":"simple","title":"Get Prime Cross Margin Overview","href":"/api-reference/prime-api/rest-api/financing/get-prime-cross-margin-overview"},{"title":"Get Trade Finance Tiered Pricing Fees","openapi":"GET /v1/entities/{entity_id}/tf_tiered_fees","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/get-trade-finance-tiered-pricing-fees"},{"openapi":"get /v1/entities/{entity_id}/cross_margin/liquidations","playground":"simple","title":"List Cross Margin Liquidations","href":"/api-reference/prime-api/rest-api/financing/list-cross-margin-liquidations"},{"title":"List Existing Locates","openapi":"GET /v1/portfolios/{portfolio_id}/locates","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/list-existing-locates"},{"openapi":"get /v1/financing/eligible-assets","playground":"simple","title":"List Financing Eligible Assets","href":"/api-reference/prime-api/rest-api/financing/list-financing-eligible-assets"},{"title":"List Interest Accruals","openapi":"GET /v1/entities/{entity_id}/accruals","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/list-interest-accruals"},{"title":"List Interest Accruals For Portfolio","openapi":"GET /v1/portfolios/{portfolio_id}/accruals","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/list-interest-accruals-for-portfolio"},{"title":"List Margin Call Summaries","openapi":"GET /v1/entities/{entity_id}/margin_summaries","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/list-margin-call-summaries"},{"title":"List Margin Conversions","openapi":"GET /v1/portfolios/{portfolio_id}/margin_conversions","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/list-margin-conversions"},{"openapi":"get /v1/entities/{entity_id}/tf_obligations","playground":"simple","title":"List Trade Finance Obligations","href":"/api-reference/prime-api/rest-api/financing/list-trade-finance-obligations"},{"title":"Create New Locates","openapi":"POST /v1/portfolios/{portfolio_id}/locates","playground":"simple","href":"/api-reference/prime-api/rest-api/financing/create-new-locates"},{"openapi":"post /v1/entities/{entity_id}/funding_settings","playground":"simple","title":"Update Funding Settings","href":"/api-reference/prime-api/rest-api/financing/update-funding-settings"}]},{"group":"Futures","pages":[{"title":"Get Entity FCM Balance","openapi":"GET /v1/entities/{entity_id}/futures/balance_summary","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/get-entity-fcm-balance"},{"title":"Get Entity Positions","openapi":"GET /v1/entities/{entity_id}/futures/positions","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/get-entity-positions"},{"openapi":"get /v1/entities/{entity_id}/futures/equity","playground":"simple","title":"Get FCM Equity","href":"/api-reference/prime-api/rest-api/futures/get-fcm-equity"},{"title":"Get Margin Call Details","openapi":"GET /v1/entities/{entity_id}/futures/margin_call_details","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/get-fcm-margin-call-details"},{"title":"Get Risk Limits","openapi":"GET /v1/entities/{entity_id}/futures/risk_limits","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/get-fcm-risk-limits"},{"openapi":"get /v1/entities/{entity_id}/futures/settings","playground":"simple","title":"Get FCM Settings","href":"/api-reference/prime-api/rest-api/futures/get-fcm-settings"},{"openapi":"get /v1/portfolios/{portfolio_id}/derivatives/currency_summary","playground":"simple","title":"Get Portfolio Derivatives Currency Summary","href":"/api-reference/prime-api/rest-api/futures/get-portfolio-derivatives-currency-summary"},{"title":"List Entity Futures Sweeps","openapi":"GET /v1/entities/{entity_id}/futures/sweeps","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/list-entity-futures-sweeps"},{"openapi":"get /v1/portfolios/{portfolio_id}/derivatives/positions","playground":"simple","title":"List Portfolio Derivative Positions","href":"/api-reference/prime-api/rest-api/futures/list-portfolio-derivative-positions"},{"title":"Schedule Entity Futures Sweep","openapi":"POST /v1/entities/{entity_id}/futures/sweeps","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/schedule-entity-futures-sweep"},{"title":"Set Auto Sweep","openapi":"POST /v1/entities/{entity_id}/futures/auto_sweep","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/set-auto-sweep"},{"openapi":"post /v1/entities/{entity_id}/futures/settings","playground":"simple","title":"Set FCM Settings","href":"/api-reference/prime-api/rest-api/futures/set-fcm-settings"},{"title":"Cancel Entity Futures Sweep","openapi":"delete /v1/entities/{entity_id}/futures/sweeps","playground":"simple","href":"/api-reference/prime-api/rest-api/futures/cancel-entity-futures-sweep"}]},{"group":"Invoice","pages":[{"title":"List Invoices","openapi":"GET /v1/entities/{entity_id}/invoices","playground":"simple","href":"/api-reference/prime-api/rest-api/invoice/list-invoices"}]},{"group":"Onchain Address Book","pages":[{"title":"List Onchain Address Groups","openapi":"GET /v1/portfolios/{portfolio_id}/onchain_address_groups","playground":"simple","href":"/api-reference/prime-api/rest-api/onchain-address-book/list-onchain-address-groups"},{"title":"Create Onchain Address Book Entry","openapi":"POST /v1/portfolios/{portfolio_id}/onchain_address_group","playground":"simple","href":"/api-reference/prime-api/rest-api/onchain-address-book/create-onchain-address-book-entry"},{"title":"Update Onchain Address Book Entry","openapi":"PUT /v1/portfolios/{portfolio_id}/onchain_address_group","playground":"simple","href":"/api-reference/prime-api/rest-api/onchain-address-book/update-onchain-address-book-entry"},{"title":"Delete Onchain Address Group","openapi":"DELETE /v1/portfolios/{portfolio_id}/onchain_address_group/{address_group_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/onchain-address-book/delete-onchain-address-group"}]},{"group":"Orders","pages":[{"title":"Get Order by Order ID","openapi":"GET /v1/portfolios/{portfolio_id}/orders/{order_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/get-order-by-order-id"},{"title":"List Open Orders","openapi":"GET /v1/portfolios/{portfolio_id}/open_orders","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/list-open-orders"},{"title":"List Order Edit History","openapi":"GET /v1/portfolios/{portfolio_id}/orders/{order_id}/edit_history","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/list-order-edit-history"},{"title":"List Order Fills","openapi":"GET /v1/portfolios/{portfolio_id}/orders/{order_id}/fills","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/list-order-fills"},{"title":"List Portfolio Fills","openapi":"GET /v1/portfolios/{portfolio_id}/fills","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/list-portfolio-fills"},{"title":"List Portfolio Orders","openapi":"GET /v1/portfolios/{portfolio_id}/orders","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/list-portfolio-orders"},{"title":"Accept Quote","openapi":"POST /v1/portfolios/{portfolio_id}/accept_quote","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/accept-quote"},{"title":"Cancel Order","openapi":"POST /v1/portfolios/{portfolio_id}/orders/{order_id}/cancel","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/cancel-order"},{"title":"Create Order","openapi":"POST /v1/portfolios/{portfolio_id}/order","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/create-order"},{"title":"Create Quote Request","openapi":"POST /v1/portfolios/{portfolio_id}/rfq","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/create-quote-request"},{"title":"Get Order Preview","openapi":"POST /v1/portfolios/{portfolio_id}/order_preview","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/get-order-preview"},{"openapi":"put /v1/portfolios/{portfolio_id}/orders/{order_id}/edit","playground":"simple","title":"Edit Order","href":"/api-reference/prime-api/rest-api/orders/edit-order"}]},{"group":"Payment Methods","pages":[{"title":"Get Entity Payment Method","openapi":"GET /v1/entities/{entity_id}/payment-methods/{payment_method_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/payment-methods/get-entity-payment-method"},{"title":"List Entity Payment Methods","openapi":"GET /v1/entities/{entity_id}/payment-methods","playground":"simple","href":"/api-reference/prime-api/rest-api/payment-methods/list-entity-payment-methods"}]},{"group":"Portfolios","pages":[{"title":"Get Portfolio by Portfolio ID","openapi":"GET /v1/portfolios/{portfolio_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/portfolios/get-portfolio-by-portfolio-id"},{"title":"List Portfolios","openapi":"GET /v1/portfolios","playground":"simple","href":"/api-reference/prime-api/rest-api/portfolios/list-portfolios"}]},{"group":"Positions","pages":[{"title":"List Aggregate Entity Positions","openapi":"GET /v1/entities/{entity_id}/aggregate_positions","playground":"simple","href":"/api-reference/prime-api/rest-api/positions/list-aggregate-entity-positions"},{"title":"List Entity Positions","openapi":"GET /v1/entities/{entity_id}/positions","playground":"simple","href":"/api-reference/prime-api/rest-api/positions/list-entity-positions"}]},{"group":"Products","pages":[{"openapi":"get /v1/portfolios/{portfolio_id}/candles","playground":"simple","title":"Get Public Product Candles","href":"/api-reference/prime-api/rest-api/products/get-public-product-candles"},{"title":"List Portfolio Products","openapi":"GET /v1/portfolios/{portfolio_id}/products","playground":"simple","href":"/api-reference/prime-api/rest-api/products/list-portfolio-products"}]},{"group":"Staking","pages":[{"openapi":"get /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/status","playground":"simple","title":"Get Staking Status","href":"/api-reference/prime-api/rest-api/staking/get-staking-status"},{"openapi":"get /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/unstake/status","playground":"simple","title":"Get Unstaking Status","href":"/api-reference/prime-api/rest-api/staking/get-unstaking-status"},{"title":"Claim Wallet Staking Rewards","openapi":"post /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/claim_rewards","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/claim-wallet-staking-rewards-alpha"},{"title":"Query Transaction Validators","openapi":"post /v1/portfolios/{portfolio_id}/staking/transaction-validators/query","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/list-transaction-validators"},{"openapi":"post /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/unstake/preview","playground":"simple","title":"Preview Unstake","href":"/api-reference/prime-api/rest-api/staking/preview-unstake"},{"title":"Request to stake currency in a portfolio","openapi":"post /v1/portfolios/{portfolio_id}/staking/initiate","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/request-to-stake-currency-in-a-portfolio"},{"title":"Request to stake or delegate a wallet","openapi":"post /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/initiate","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/request-to-stake-or-delegate-a-wallet"},{"title":"Request to unstake a wallet","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/unstake","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/request-to-unstake-a-wallet"},{"title":"Request to unstake currency across a portfolio","openapi":"post /v1/portfolios/{portfolio_id}/staking/unstake","playground":"simple","href":"/api-reference/prime-api/rest-api/staking/request-to-unstake-currency-across-a-portfolio"}]},{"group":"Transactions","pages":[{"title":"Get Transaction by Transaction ID","openapi":"GET /v1/portfolios/{portfolio_id}/transactions/{transaction_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/get-transaction-by-transaction-id"},{"title":"List Portfolio Transactions","openapi":"GET /v1/portfolios/{portfolio_id}/transactions","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/list-portfolio-transactions"},{"openapi":"get /v1/portfolios/{portfolio_id}/advanced_transfers/{advanced_transfer_id}/transactions","playground":"simple","title":"List transactions associated with an Advanced Transfer","href":"/api-reference/prime-api/rest-api/transactions/list-transactions-associated-with-an-advanced-transfer"},{"title":"List Wallet Transactions","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/transactions","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/list-wallet-transactions"},{"title":"Create Conversion","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/conversion","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/create-conversion"},{"title":"Create Onchain Transaction","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/onchain_transaction","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/create-onchain-transaction"},{"title":"Create Transfer","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/transfers","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/create-transfer"},{"title":"Create Withdrawal","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/withdrawals","playground":"simple","href":"/api-reference/prime-api/rest-api/transactions/create-withdrawal"}]},{"group":"Travel Rule","pages":[{"openapi":"get /v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule","playground":"simple","title":"Get Transaction Travel Rule Data","href":"/api-reference/prime-api/rest-api/travel-rule/get-transaction-travel-rule-data"},{"openapi":"post /v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit","playground":"simple","title":"Submit Deposit Travel Rule Data","href":"/api-reference/prime-api/rest-api/travel-rule/submit-deposit-travel-rule-data"}]},{"group":"Users","pages":[{"title":"List Portfolio Users","openapi":"GET /v1/portfolios/{portfolio_id}/users","playground":"simple","href":"/api-reference/prime-api/rest-api/users/list-portfolio-users"},{"title":"List Users","openapi":"GET /v1/entities/{entity_id}/users","playground":"simple","href":"/api-reference/prime-api/rest-api/users/list-users"}]},{"group":"Wallets","pages":[{"title":"Get Wallet by Wallet ID","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/get-wallet-by-wallet-id"},{"title":"Get Wallet Deposit Instructions","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/deposit_instructions","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/get-wallet-deposit-instructions"},{"title":"List Portfolio Wallets","openapi":"GET /v1/portfolios/{portfolio_id}/wallets","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/list-portfolio-wallets"},{"title":"List Wallet Addresses","openapi":"GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/addresses","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/list-wallet-addresses"},{"title":"Create Wallet","openapi":"POST /v1/portfolios/{portfolio_id}/wallets","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/create-wallet"},{"title":"Create Wallet Deposit Address","openapi":"POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/addresses","playground":"simple","href":"/api-reference/prime-api/rest-api/wallets/create-wallet-deposit-address"}]}]},{"group":"Websocket Feed","pages":[{"title":"Prime WebSocket Overview","sidebarTitle":"Overview","href":"/prime/websocket-feed/overview"},{"title":"Prime WebSocket Channels","sidebarTitle":"Channels","href":"/prime/websocket-feed/channels"}]},{"group":"FIX 4.2 API","pages":[{"title":"Prime FIX API Connectivity","sidebarTitle":"Connectivity","href":"/prime/fix-api/connectivity"},{"title":"Prime FIX 4.2 Data Dictionary","sidebarTitle":"Dictionaries","href":"/prime/fix-api/fix-data-dictionaries"},{"group":"Messages","pages":[{"title":"Prime FIX Administrative Messages","sidebarTitle":"Administrative Messages","href":"/prime/fix-api/admin-messages"},{"title":"Prime FIX Order Entry Messages","sidebarTitle":"Order Entry Messages","href":"/prime/fix-api/order-entry-messages"}]}]},{"group":"FIX 5.0 API","pages":[{"title":"Prime FIX 5.0 API","sidebarTitle":"Overview","href":"/prime/fix-5-0-api/overview"},{"title":"Coinbase Prime FIX 4.2 → FIX 5.0 SP2 Order Entry Migration Guide","sidebarTitle":"FIX 4.2 to FIX 5.0 Migration","href":"/prime/fix-5-0-api/order-entry-migration-guide"},{"title":"Prime FIX 5.0 Data Dictionary","sidebarTitle":"Dictionaries","href":"/prime/fix-5-0-api/dictionaries"},{"title":"Prime FIX 5.0 Session Management","sidebarTitle":"Session management","href":"/prime/fix-5-0-api/session-management"},{"title":"Prime FIX 5.0 Market Data","sidebarTitle":"Market Data","tag":"Beta","href":"/prime/fix-5-0-api/market-data"},{"title":"Prime FIX 5.0 Order Entry","sidebarTitle":"Order Entry","href":"/prime/fix-5-0-api/order-entry"},{"title":"Prime FIX 5.0 RFQ","sidebarTitle":"RFQ","href":"/prime/fix-5-0-api/rfq"},{"title":"Prime FIX 5.0 Code Sets","sidebarTitle":"Code Sets","href":"/prime/fix-5-0-api/code-sets"}]}]},{"dropdown":"CDE: Futures API","icon":"https://mintlify-assets.b-cdn.net/derivativesProduct-2.svg","groups":[{"group":"REST API Overview","pages":[{"title":"Welcome to the Coinbase Derivatives: Futures REST API","sidebarTitle":"Overview","href":"/api-reference/derivatives-api/rest-api/introduction"},{"title":"Coinbase Derivatives: Futures REST API Authentication","sidebarTitle":"Authentication","href":"/api-reference/derivatives-api/rest-api/authentication"}]},{"group":"REST Endpoints","pages":[{"group":"Block Trades","pages":[{"title":"Get Block Trades","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade","href":"/api-reference/derivatives-api/rest-api/block-trades/get-block-trades"},{"title":"Get Filtered Block Trades","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/block-trade","href":"/api-reference/derivatives-api/rest-api/block-trades/get-filtered-block-trades"},{"title":"Get Bookable Block Trade Accounts","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade/booking/bookable-accounts","href":"/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-trade-accounts"},{"title":"Get Bookable Block Trade Entities","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade/booking/bookable-entities","href":"/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-trade-entities"},{"title":"Get Bookable Block Traders","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade/booking/bookable-traders","href":"/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-traders"},{"title":"Book a Block Trade","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/block-trade/new","href":"/api-reference/derivatives-api/rest-api/block-trades/book-a-block-trade"}]},{"group":"Block Trade Accounts","pages":[{"title":"Get All Block Trade Account Permissions","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-account-permissions","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-account-permissions"},{"title":"Get Block Trade Account Permission","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-account-permissions/{uuid}","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-account-permission"},{"title":"Get All Block Trade Accounts","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-accounts","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-accounts"},{"title":"Get Block Trade Account","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-accounts/{uuid}","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-account"},{"title":"Get All Block Trade Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-position-limits","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-position-limits"},{"title":"Get Block Trade Position Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-position-limits/{uuid}","href":"/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-position-limit"}]},{"group":"Block Trade Entities","pages":[{"title":"Get All Block Trade Entities","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-entities","href":"/api-reference/derivatives-api/rest-api/block-trade-entities/get-all-block-trade-entities"},{"title":"Get Block Trade Entity","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-trade-entities/{uuid}","href":"/api-reference/derivatives-api/rest-api/block-trade-entities/get-block-trade-entity"},{"title":"Get Block Trade Entities by Firm","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firm-block-trade-entities/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/block-trade-entities/get-block-trade-entities-by-firm"}]},{"group":"Block Traders","pages":[{"title":"Get All Block Traders","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-traders","href":"/api-reference/derivatives-api/rest-api/block-traders/get-all-block-traders"},{"title":"Get Block Trader","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/block-traders/{uuid}","href":"/api-reference/derivatives-api/rest-api/block-traders/get-block-trader"}]},{"group":"Firm Position Limits","pages":[{"title":"List All Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firm-position-limits","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/list-all-position-limits"},{"title":"Get Firm Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firm-position-limits/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/get-firm-position-limits"},{"title":"Update Firm Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/firm-position-limits/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/update-firm-position-limits"},{"title":"List All Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/firm-position-limits","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/list-all-position-limits-1"},{"title":"Get Firm Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/firm-position-limits/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/get-firm-position-limits-1"},{"title":"Update Firm Position Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-position-limits/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-position-limits/update-firm-position-limits-1"}]},{"group":"Firm Product Group Limits","pages":[{"title":"Create Zero Firm Product Group Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/firm-product-group-limit","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/create-zero-firm-product-group-limit"},{"title":"Remove Firm Product Group Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/firm-product-group-limit/remove","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/remove-firm-product-group-limit"},{"title":"Get Firm Product Group Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firm-product-group-limit/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/get-firm-product-group-limits"},{"title":"Create Zero Firm Product Group Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-product-group-limit","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/create-zero-firm-product-group-limit-1"},{"title":"Remove Firm Product Group Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-product-group-limit/remove","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/remove-firm-product-group-limit-1"},{"title":"Get Firm Product Group Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/firm-product-group-limit/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-product-group-limits/get-firm-product-group-limits-1"}]},{"group":"Firm Product Limits","pages":[{"title":"Create Zero Firm Product Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/firm-product-limit","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/create-zero-firm-product-limit"},{"title":"Remove Firm Product Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/firm-product-limit/remove","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/remove-firm-product-limit"},{"title":"Get Firm Product Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firm-product-limit/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/get-firm-product-limits"},{"title":"Set Firm Product Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-product-limit","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/set-firm-product-limit"},{"title":"Batch Set Firm Product Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-product-limit/batch","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/batch-set-firm-product-limit"},{"title":"Remove Firm Product Limit","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/v2/firm-product-limit/remove","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/remove-firm-product-limit-1"},{"title":"Get Firm Product Limits","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/firm-product-limit/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/firm-product-limits/get-firm-product-limits-1"}]},{"group":"Firms","pages":[{"title":"Get All Firms","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firms","href":"/api-reference/derivatives-api/rest-api/firms/get-all-firms"},{"title":"Get Firm","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/firms/{uuid}","href":"/api-reference/derivatives-api/rest-api/firms/get-firm"}]},{"group":"Funding Rate","pages":[{"title":"Get historical funding rates","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/funding-rate","href":"/api-reference/derivatives-api/rest-api/funding-rate/get-historical-funding-rates"}]},{"group":"Instruments","pages":[{"title":"Get Instrument Details","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/instruments","href":"/api-reference/derivatives-api/rest-api/instruments/get-instrument-details"},{"title":"Get Valid Series","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/valid-series","href":"/api-reference/derivatives-api/rest-api/instruments/get-valid-series"}]},{"group":"Risk","pages":[{"title":"Kill Switch","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/kill-switch","href":"/api-reference/derivatives-api/rest-api/risk/kill-switch"},{"title":"Unlock Trading","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json post /rest/unlock-trading","href":"/api-reference/derivatives-api/rest-api/risk/unlock-trading"}]},{"group":"Positions","pages":[{"title":"Get All Firm Positions","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/positions","href":"/api-reference/derivatives-api/rest-api/positions/get-all-firm-positions"},{"title":"Get Firm Position","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/positions/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/positions/get-firm-position"},{"title":"Get All Firm Positions","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/positions","href":"/api-reference/derivatives-api/rest-api/positions/get-all-firm-positions-1"},{"title":"Get Firm Position","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/v2/positions/{firm_uuid}","href":"/api-reference/derivatives-api/rest-api/positions/get-firm-position-1"}]},{"group":"Users","pages":[{"title":"Get All Users","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/users","href":"/api-reference/derivatives-api/rest-api/users/get-all-users"},{"title":"Get User","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-api/rest-api/cde-spec.json get /rest/users/{uuid}","href":"/api-reference/derivatives-api/rest-api/users/get-user"}]}]},{"group":"FIX","pages":[{"title":"Derivatives FIX Overview","sidebarTitle":"Overview","href":"/derivatives/fix/overview"},{"title":"Derivatives FIX Header/Trailer Messages","sidebarTitle":"Header/Trailer","href":"/derivatives/fix/header-trailer"},{"title":"Derivatives FIX Session Messages","sidebarTitle":"Session","href":"/derivatives/fix/session"},{"title":"Derivatives FIX Market Data Messages","sidebarTitle":"Market Data","href":"/derivatives/fix/market-data"},{"title":"Derivatives FIX Order Entry Messages","sidebarTitle":"Order Entry","href":"/derivatives/fix/order-entry"},{"title":"Derivatives FIX Drop Copy Messages","sidebarTitle":"Drop Copy","href":"/derivatives/fix/drop-copy"},{"title":"Derivatives FIX Security Definitions","sidebarTitle":"Security Definitions","href":"/derivatives/fix/security-definitions"},{"title":"Derivatives FIX Code Sets","sidebarTitle":"Code Sets","href":"/derivatives/fix/code-sets"}]},{"group":"SBE","pages":[{"title":"Derivatives SBE Overview","sidebarTitle":"Overview","href":"/derivatives/sbe/overview"},{"title":"Derivatives SBE Header Message","sidebarTitle":"Header","href":"/derivatives/sbe/header"},{"title":"Derivatives SBE Session Messages","sidebarTitle":"Session","href":"/derivatives/sbe/session"},{"title":"Derivatives SBE Order Entry Messages","sidebarTitle":"Order Entry","href":"/derivatives/sbe/order-entry"}]},{"group":"UDP","pages":[{"title":"Derivatives UDP Overview","href":"/derivatives/udp/overview"},{"sidebarTitle":"Message Structure","title":null,"href":"/derivatives/udp/message-structure"},{"title":"Derivatives UDP Realtime Incremental Updates","sidebarTitle":"Incrementals","href":"/derivatives/udp/incrementals"},{"title":"Derivatives UDP Periodic Snapshots","sidebarTitle":"Snapshots","href":"/derivatives/udp/snapshots"},{"title":"Derivatives UDP Retransmits","sidebarTitle":"Retransmits","href":"/derivatives/udp/retransmits"}]}]},{"dropdown":"CDE: Predictions API","icon":"https://mintlify-assets.b-cdn.net/derivativesProduct-2.svg","groups":[{"group":"REST API Overview","pages":[{"title":"Welcome to the Coinbase Derivatives: Predictions REST API","sidebarTitle":"Overview","href":"/api-reference/derivatives-predictions-api/rest-api/introduction"},{"title":"Coinbase Derivatives: Predictions REST API Authentication","sidebarTitle":"Authentication","href":"/api-reference/derivatives-predictions-api/rest-api/authentication"}]},{"group":"REST Endpoints","pages":[{"group":"Account","pages":[{"title":"Get FCM balance","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/balances","href":"/api-reference/derivatives-predictions-api/rest-api/account/get-fcm-balance"},{"title":"Get the caller's own FCM","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/fcms/{id}","href":"/api-reference/derivatives-predictions-api/rest-api/account/get-the-callers-own-fcm"},{"title":"Get fill history","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/fills","href":"/api-reference/derivatives-predictions-api/rest-api/account/get-fill-history"},{"title":"Get the caller's own trading firm","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/firms/{id}","href":"/api-reference/derivatives-predictions-api/rest-api/account/get-the-callers-own-trading-firm"}]},{"group":"MarketData","pages":[{"title":"Get the L2 order book snapshot","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/orderbook/{instrument_id}","href":"/api-reference/derivatives-predictions-api/rest-api/marketdata/get-the-l2-order-book-snapshot"},{"title":"Get the ticker snapshot","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/ticker/{instrument_id}","href":"/api-reference/derivatives-predictions-api/rest-api/marketdata/get-the-ticker-snapshot"},{"title":"Get recent trades","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/trades/{instrument_id}","href":"/api-reference/derivatives-predictions-api/rest-api/marketdata/get-recent-trades"}]},{"group":"Orders","pages":[{"title":"Get open orders","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/orders","href":"/api-reference/derivatives-predictions-api/rest-api/orders/get-open-orders"},{"title":"Place an order","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json post /api/orders","href":"/api-reference/derivatives-predictions-api/rest-api/orders/place-an-order"},{"title":"Cancel an order by client order id","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json delete /api/orders","href":"/api-reference/derivatives-predictions-api/rest-api/orders/cancel-an-order-by-client-order-id"},{"title":"Cancel an order by order id","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json delete /api/orders/{order_id}","href":"/api-reference/derivatives-predictions-api/rest-api/orders/cancel-an-order-by-order-id"}]},{"group":"Health","pages":[{"title":"Liveness probe","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/ping","href":"/api-reference/derivatives-predictions-api/rest-api/health/liveness-probe"}]},{"group":"Positions","pages":[{"title":"Get open positions","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/positions","href":"/api-reference/derivatives-predictions-api/rest-api/positions/get-open-positions"}]},{"group":"Trading Controls","pages":[{"title":"Kill trading for a scope within the caller's hierarchy","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json post /api/trading/kill-switch","href":"/api-reference/derivatives-predictions-api/rest-api/trading-controls/kill-trading-for-a-scope-within-the-callers-hierarchy"},{"title":"Unlock trading for a scope within the caller's hierarchy","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json post /api/trading/unlock","href":"/api-reference/derivatives-predictions-api/rest-api/trading-controls/unlock-trading-for-a-scope-within-the-callers-hierarchy"}]},{"group":"Reference","pages":[{"title":"List events","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/events","href":"/api-reference/derivatives-predictions-api/rest-api/reference/list-events"},{"title":"Get an event by id or ticker","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/events/{id_or_ticker}","href":"/api-reference/derivatives-predictions-api/rest-api/reference/get-an-event-by-id-or-ticker"},{"title":"List instruments","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/instruments","href":"/api-reference/derivatives-predictions-api/rest-api/reference/list-instruments"},{"title":"Get an instrument by id or ticker","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/instruments/{id_or_ticker}","href":"/api-reference/derivatives-predictions-api/rest-api/reference/get-an-instrument-by-id-or-ticker"},{"title":"List series","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/series","href":"/api-reference/derivatives-predictions-api/rest-api/reference/list-series"},{"title":"Get a series by id or ticker","deprecated":false,"version":null,"openapi":"/api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/v1/series/{id_or_ticker}","href":"/api-reference/derivatives-predictions-api/rest-api/reference/get-a-series-by-id-or-ticker"}]}]},{"group":"FIX","pages":[{"title":"Coinbase Derivatives: Predictions FIX Overview","sidebarTitle":"Overview","href":"/derivatives-predictions/fix/overview"},{"title":"Coinbase Derivatives: Predictions FIX Header/Trailer Messages","sidebarTitle":"Header/Trailer","href":"/derivatives-predictions/fix/header-trailer"},{"title":"Coinbase Derivatives: Predictions FIX Session Messages","sidebarTitle":"Session","href":"/derivatives-predictions/fix/session"},{"title":"Coinbase Derivatives: Predictions FIX Market Data Messages","sidebarTitle":"Market Data","href":"/derivatives-predictions/fix/market-data"},{"title":"Coinbase Derivatives: Predictions FIX Order Entry Messages","sidebarTitle":"Order Entry","href":"/derivatives-predictions/fix/order-entry"},{"title":"Coinbase Derivatives: Predictions FIX Drop Copy Messages","sidebarTitle":"Drop Copy","href":"/derivatives-predictions/fix/drop-copy"}]},{"group":"WebSocket","pages":[{"title":"Coinbase Derivatives: Predictions WebSocket Overview","sidebarTitle":"Overview","href":"/derivatives-predictions/websocket/overview"},{"title":"Coinbase Derivatives: Predictions WebSocket Authentication","sidebarTitle":"Authentication","href":"/derivatives-predictions/websocket/authentication"},{"title":"Coinbase Derivatives: Predictions WebSocket Commands","sidebarTitle":"Commands","href":"/derivatives-predictions/websocket/commands"},{"title":"Coinbase Derivatives: Predictions WebSocket Channels","sidebarTitle":"Channels","href":"/derivatives-predictions/websocket/channels"}]}]},{"dropdown":"CBC: Clearing API","icon":"https://mintlify-assets.b-cdn.net/derivativesProduct-2.svg","groups":[{"group":"REST API Overview","pages":[{"title":"Welcome to the Coinbase Clearing REST API","sidebarTitle":"Overview","href":"/api-reference/clearing-api/rest-api/introduction"},{"title":"Coinbase Clearing REST API Authentication","sidebarTitle":"Authentication","description":null,"href":"/api-reference/clearing-api/rest-api/authentication"}]},{"group":"REST Endpoints","pages":[{"group":"Trades","pages":[{"title":"Get derivative trades","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/trades/get-derivative-trades","href":"/api-reference/clearing-api/rest-api/trades/get-derivative-trades"},{"title":"Get event trades","description":"Returns a page of event (prediction market) trades. Uses the same request and response schema as Get derivative trades.","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/trades/get-event-trades","href":"/api-reference/clearing-api/rest-api/trades/get-event-trades"}]},{"group":"Prices","pages":[{"title":"Get instrument prices","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/price/get-page","href":"/api-reference/clearing-api/rest-api/prices/get-instrument-prices"}]},{"group":"Settlement Results","pages":[{"title":"Get settlement results","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/settlement-results/get-page","href":"/api-reference/clearing-api/rest-api/settlement-results/get-settlement-results"}]},{"group":"Positions","pages":[{"title":"Get event positions","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/event-positions/get-all-positions","href":"/api-reference/clearing-api/rest-api/positions/get-event-positions"}]},{"group":"Balances","pages":[{"title":"Get balances","deprecated":null,"version":null,"openapi":"/api-reference/clearing-api/rest-api/cbc-spec.json post /api/collateral/balance/get-page","href":"/api-reference/clearing-api/rest-api/balances/get-balances"}]}]}]},{"dropdown":"CDP API V1","icon":"https://mintlify-assets.b-cdn.net/layerNetworks-3.svg","groups":[{"group":"CDP API V1","pages":[{"title":"Welcome to CDP APIs","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Networks","href":"/api-reference/networks"}]},{"group":"REST API","pages":[{"group":"Staking","pages":[{"title":"Build a new staking operation","openapi":"POST /v1/stake/build","href":"/api-reference/rest-api/staking/build-a-new-staking-operation"},{"title":"Fetch historical staking balances","openapi":"GET /v1/networks/{network_id}/addresses/{address_id}/stake/balances","href":"/api-reference/rest-api/staking/fetch-historical-staking-balances"},{"title":"Fetch staking rewards","openapi":"POST /v1/stake/rewards/search","href":"/api-reference/rest-api/staking/fetch-staking-rewards"},{"title":"Get latest staking operation","openapi":"GET /v1/networks/{network_id}/addresses/{address_id}/staking_operations/{staking_operation_id}","href":"/api-reference/rest-api/staking/get-latest-staking-operation"},{"title":"Get staking context","openapi":"POST /v1/stake/context","href":"/api-reference/rest-api/staking/get-staking-context"},{"title":"Get validator by ID","openapi":"GET /v1/networks/{network_id}/assets/{asset_id}/validators/{validator_id}","href":"/api-reference/rest-api/staking/get-validator-by-id"},{"title":"List validators","openapi":"GET /v1/networks/{network_id}/assets/{asset_id}/validators","href":"/api-reference/rest-api/staking/list-validators"}]},{"group":"Onramp/Offramp","pages":[{"title":"Create buy quote","openapi":"POST /v1/buy/quote","href":"/api-reference/rest-api/onramp-offramp/create-buy-quote"},{"title":"Create sell quote","openapi":"POST /v1/sell/quote","href":"/api-reference/rest-api/onramp-offramp/create-sell-quote"},{"title":"Create session token","openapi":"POST /v1/token","href":"/api-reference/rest-api/onramp-offramp/create-session-token"},{"title":"Get all offramp transactions","openapi":"GET /v1/sell/transactions","href":"/api-reference/rest-api/onramp-offramp/get-all-offramp-transactions"},{"title":"Get all onramp transactions","openapi":"GET /v1/buy/transactions","href":"/api-reference/rest-api/onramp-offramp/get-all-onramp-transactions"},{"title":"Get buy config","openapi":"GET /v1/buy/config","href":"/api-reference/rest-api/onramp-offramp/get-buy-config"},{"title":"Get buy options","openapi":"GET /v1/buy/options","href":"/api-reference/rest-api/onramp-offramp/get-buy-options"},{"title":"Get offramp transactions by ID","openapi":"GET /v1/sell/user/{partnerUserRef}/transactions","href":"/api-reference/rest-api/onramp-offramp/get-offramp-transactions-by-id"},{"title":"Get onramp transactions by ID","openapi":"GET /v1/buy/user/{partnerUserRef}/transactions","href":"/api-reference/rest-api/onramp-offramp/get-onramp-transactions-by-id"},{"title":"Get sell config","openapi":"GET /v1/sell/config","href":"/api-reference/rest-api/onramp-offramp/get-sell-config"},{"title":"Get sell options","openapi":"GET /v1/sell/options","href":"/api-reference/rest-api/onramp-offramp/get-sell-options"}]}]},{"group":"JSON-RPC API","pages":[{"title":"Core JSON-RPC Methods","sidebarTitle":"Core","href":"/api-reference/json-rpc-api/core"},{"title":"Paymaster JSON-RPC Methods","sidebarTitle":"Paymaster","href":"/api-reference/json-rpc-api/paymaster"},{"title":"Address History JSON-RPC Methods","sidebarTitle":"Address History","href":"/api-reference/json-rpc-api/address-history"}]}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/settle-customer-stablecoins-as-usd"}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/get-started/changelog"}]}]},"basePath":"","title":"Get derivative trades - Coinbase Developer Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}