Lists all active discovered x402 resources.
This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata.
The response is paginated, and by default, returns 100 items per page.
{"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-cloud/FjMSMQIg--bQwlYn/logos/wordmark-light.svg?fit=max\u0026auto=format\u0026n=FjMSMQIg--bQwlYn\u0026q=85\u0026s=78661b6fd3ff79c8e85642f839addf7b","dark":"https://mintcdn.com/coinbase-cloud/FjMSMQIg--bQwlYn/logos/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=FjMSMQIg--bQwlYn\u0026q=85\u0026s=17f840e89bfa295e97c077233c387b08"},"favicon":"https://mintcdn.com/coinbase-cloud/tALq8dhStAfj8UeL/favicon.png?fit=max\u0026auto=format\u0026n=tALq8dhStAfj8UeL\u0026q=85\u0026s=d608f59dd7dc00335f483ed6edf75491","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"}},"contextual":{"options":["copy","view","mcp","cursor","vscode","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"coinbase-cloud","hasAudioNarration":false,"actualSubdomain":"coinbase-cloud","customDomains":["docs.cloud.coinbase.com"],"gitSource":{"type":"github","owner":"coinbase","repo":"cdp-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":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":"6ae92a020a94bfe43457974f:success","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"SDKs","count":827},{"language":"default","tag":"CRYPTO INFRASTRUCTURE","count":816},{"language":"default","tag":"CDP SDKs","count":812},{"language":"default","tag":"Frontend","count":792},{"language":"default","tag":"API Reference","count":711},{"language":"default","tag":"REST API","count":550},{"language":"default","tag":"Docs","count":484},{"language":"default","tag":"@coinbase/cdp-core","count":312},{"language":"default","tag":"Type Aliases","count":309},{"language":"default","tag":"@coinbase/cdp-react","count":303}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","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)}[data-dropdown-item=\"CDP Payments API\"]{display:none}[data-dropdown-item=\"Payment Acceptance\"]{display:none}.nav-dropdown-item[data-dropdown-item=\"CDP Payments API\"]>.nav-dropdown-item-text-container>.nav-dropdown-item-title::after{content:\"Alpha\"!important;background-color:#004cec1a;color:#0052ff;font-size:0.75rem;font-weight:600;padding:2px 8px;border-radius:12px;margin-left:8px}"},{"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}"},{"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/v2/rest-api/x402-facilitator/list-x402-resources","slug":"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources","pageMetadata":{"openapi":"get /v2/x402/discovery/resources","title":"List x402 resources","description":"Lists all active discovered x402 resources.\nThis endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata.\nThe response is paginated, and by default, returns 100 items per page.","href":"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources"},"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: \"Lists all active discovered x402 resources.\\nThis endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata.\\nThe response is paginated, and by default, returns 100 items per page.\"\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":{"openapi":"get /v2/x402/discovery/resources","title":"List x402 resources","description":"Lists all active discovered x402 resources.\nThis endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata.\nThe response is paginated, and by default, returns 100 items per page.","href":"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/coinbase-cloud/e7f7008f5db24529/ai-assistant-message.js","/_mintlify/custom/coinbase-cloud/a95e5b7dce1303be/dropdowns.js","/_mintlify/custom/coinbase-cloud/bef3f7e8e501ccfe/sprig.js","/_mintlify/custom/coinbase-cloud/06f253dee5fa900c/lint-staged.config.js","/_mintlify/custom/coinbase-cloud/6d906736c36798d6/add-scroll-gradient.js","/_mintlify/custom/coinbase-cloud/4ddd1361cd858209/payment-api-protection.js"],"openApiReferenceData":{"operation":{"x-audience":"public","summary":"List x402 resources","description":"Lists all active discovered x402 resources.\nThis endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata.\nThe response is paginated, and by default, returns 100 items per page.","operationId":"listX402DiscoveryResources","tags":["x402 Facilitator"],"security":["0cf46ded-e856-4f5b-8c23-cf43b8750b3e"],"parameters":["e0eef6d9-3f0a-47de-9344-3c0a15e8ace1","c5153dff-8613-4d54-bb04-5edf04779693","d4d26d78-920f-43b0-a25f-dd175893ac1d"],"responses":{"200":"f0c6603c-f73d-4a5d-93c2-489e6304a7c0","400":"f5e3e6fe-22ad-4562-b4b9-b1ae7500af71","500":"b7cc2b5a-579d-484c-887b-b58f52232d6e","502":"6df2094b-1283-4aa0-9c77-aed9faa31d11","503":"57e46d27-756f-436a-a806-97be4268a333"},"method":"get","type":"path","servers":["a849636c-5380-4e0a-952a-2b198966464a"],"path":"/v2/x402/discovery/resources","baseUrlOptions":["https://api.cdp.coinbase.com/platform"],"title":"List x402 resources","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e0eef6d9-3f0a-47de-9344-3c0a15e8ace1":{"name":"type","in":"query","description":"Filter by protocol type (e.g., \"http\", \"mcp\").\nCurrently, the only supported protocol type is \"http\".","required":false,"schema":{"type":"string","example":"http","isRequired":false,"description":"Filter by protocol type (e.g., \"http\", \"mcp\").\nCurrently, the only supported protocol type is \"http\".","uniqueKey":"","typeLabel":"string"}},"c5153dff-8613-4d54-bb04-5edf04779693":{"name":"limit","in":"query","description":"The number of discovered x402 resources to return per page.","required":false,"schema":{"type":"integer","default":100,"isRequired":false,"description":"The number of discovered x402 resources to return per page.","uniqueKey":"","typeLabel":"integer"},"example":50},"d4d26d78-920f-43b0-a25f-dd175893ac1d":{"name":"offset","in":"query","description":"The offset of the first discovered x402 resource to return.","required":false,"schema":{"type":"integer","default":0,"isRequired":false,"description":"The offset of the first discovered x402 resource to return.","uniqueKey":"","typeLabel":"integer"},"example":0}},"responses":{"f0c6603c-f73d-4a5d-93c2-489e6304a7c0":{"description":"Successfully retrieved discovery list.","content":{"application/json":{"schema":{"type":"object","description":"Response containing discovered x402 resources.","properties":{"x402Version":{"type":"integer","description":"The version of the x402 protocol.","enum":[1,2],"example":2,"isRequired":true,"uniqueKey":"x402Version","typeLabel":"enum\u003cinteger>"},"items":{"type":"array","description":"List of discovered x402 resources.","items":{"type":"object","description":"A single discovered x402 resource.","properties":{"resource":{"type":"string","description":"The URL of the resource.","example":"https://api.example.com/weather/forecast","isRequired":true,"uniqueKey":"\\items.items.[INDEX].resource","typeLabel":"string"},"type":{"type":"string","description":"Communication protocol (e.g., \"http\", \"mcp\").","enum":["http","mcp"],"example":"http","isRequired":true,"uniqueKey":"\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"x402Version":{"type":"integer","description":"The version of the x402 protocol.","enum":[1,2],"example":2,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].x402Version","typeLabel":"enum\u003cinteger>"},"description":{"type":"string","description":"A human-readable description of the resource.","example":"Real-time weather forecast data","uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp of the last update.","example":"2024-01-15T10:30:00Z","uniqueKey":"\\items.items.[INDEX].lastUpdated","typeLabel":"string\u003cdate-time>"},"accepts":{"type":"array","description":"Payment requirements accepted by the resource.","items":{"oneOf":[{"type":"object","title":"x402V2PaymentRequirements","description":"The x402 v2 payment requirements. Uses CAIP-2 network identifiers and supports `exact`, `upto`, and `batch-settlement` schemes. Carries only the payment fields (no resource metadata — that is in the enclosing `x402V2PaymentPayload.resource`).","required":["scheme","network","asset","amount","payTo","maxTimeoutSeconds"],"properties":{"scheme":{"type":"string","description":"The scheme of the payment protocol to use. Supported schemes are `exact`, `upto`, and `batch-settlement`.","enum":["exact","upto","batch-settlement"],"example":"exact","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.scheme","typeLabel":"enum\u003cstring>"},"network":{"type":"string","description":"The network of the blockchain to send payment on in CAIP-2 format.","enum":["eip155:8453","eip155:84532","eip155:137","eip155:42161","eip155:480","eip155:4801","solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1"],"example":"eip155:8453","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.network","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"The asset to pay with.\n\nFor EVM networks, the asset will be a 0x-prefixed, checksum EVM address.\n\nFor Solana-based networks, the asset will be a base58-encoded Solana address.","maxLength":128,"minLength":1,"example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"amount":{"type":"string","description":"The amount to pay for the resource in atomic units of the payment asset.","example":"1000000","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.amount","typeLabel":"string"},"payTo":{"type":"string","description":"The destination to pay value to.\n\nFor EVM networks, payTo will be a 0x-prefixed, checksum EVM address.\n\nFor Solana-based networks, payTo will be a base58-encoded Solana address.","maxLength":128,"minLength":1,"example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.payTo","typeLabel":"string"},"maxTimeoutSeconds":{"type":"integer","description":"The maximum time in seconds for the resource server to respond.","example":10,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.maxTimeoutSeconds","typeLabel":"integer"},"extra":{"type":"object","description":"The optional additional scheme-specific payment info.","additionalProperties":true,"example":{"name":"USDC","version":"2"},"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0.extra","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.0","typeLabel":"x402V2PaymentRequirements · object"},{"type":"object","title":"x402V1PaymentRequirements","description":"The x402 v1 payment requirements. Uses human-readable network names, and carries resource metadata (`resource`, `description`, `mimeType`) alongside the payment fields. The only supported scheme is `exact`.","required":["scheme","network","maxAmountRequired","resource","description","mimeType","payTo","asset","maxTimeoutSeconds"],"properties":{"scheme":{"type":"string","description":"The scheme of the payment protocol to use. Currently, the only supported scheme is `exact`.","enum":["exact"],"example":"exact","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.scheme","typeLabel":"enum\u003cstring>"},"network":{"type":"string","description":"The network of the blockchain to send payment on.","enum":["base","base-sepolia","solana","solana-devnet"],"example":"base","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.network","typeLabel":"enum\u003cstring>"},"maxAmountRequired":{"type":"string","description":"The maximum amount required to pay for the resource in atomic units of the payment asset.","example":"1000000","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.maxAmountRequired","typeLabel":"string"},"resource":{"type":"string","description":"The URL of the resource to pay for.","example":"https://api.example.com/premium/resource/123","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.resource","typeLabel":"string"},"description":{"type":"string","description":"A human-readable description of the resource.","maxLength":500,"minLength":0,"example":"Premium API access for data analysis","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.description","typeLabel":"string"},"mimeType":{"type":"string","description":"The MIME type of the resource response.","example":"application/json","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.mimeType","typeLabel":"string"},"payTo":{"type":"string","description":"The destination to pay value to.\n\nFor EVM networks, payTo will be a 0x-prefixed, checksum EVM address.\n\nFor Solana-based networks, payTo will be a base58-encoded Solana address.","maxLength":128,"minLength":1,"example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.payTo","typeLabel":"string"},"maxTimeoutSeconds":{"type":"integer","description":"The maximum time in seconds for the resource server to respond.","example":10,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.maxTimeoutSeconds","typeLabel":"integer"},"asset":{"type":"string","description":"The asset to pay with.\n\nFor EVM networks, the asset will be a 0x-prefixed, checksum EVM address.\n\nFor Solana-based networks, the asset will be a base58-encoded Solana address.","maxLength":128,"minLength":1,"example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","isRequired":true,"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.asset","typeLabel":"string"},"outputSchema":{"type":"object","description":"The optional JSON schema describing the resource output.","additionalProperties":true,"example":{"data":"string"},"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.outputSchema","typeLabel":"object"},"extra":{"type":"object","description":"The optional additional scheme-specific payment info.","additionalProperties":true,"example":{"gasLimit":"1000000"},"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1.extra","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX].oneOf.1","typeLabel":"x402V1PaymentRequirements · object"}],"uniqueKey":"\\items.items.[INDEX].accepts.items.[INDEX]","typeLabel":"x402V2PaymentRequirements · object | x402V1PaymentRequirements · object"},"example":[{"scheme":"exact","network":"eip155:8453","amount":"1000000","payTo":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","asset":"0x036CbD53842c5426634e7929541eC2318f3dCF7e","maxTimeoutSeconds":60}],"uniqueKey":"\\items.items.[INDEX].accepts","typeLabel":"(x402V2PaymentRequirements · object | x402V1PaymentRequirements · object)[]"},"extensions":{"type":"object","description":"Map of x402 protocol extensions supported by the resource, keyed by extension name.","additionalProperties":true,"example":{"bazaar":{"info":{"input":{"type":"http","method":"GET"}},"schema":{}}},"uniqueKey":"\\items.items.[INDEX].extensions","typeLabel":"object"},"quality":{"type":"object","description":"Quality metrics for a discovered x402 resource.","properties":{"l30DaysTotalCalls":{"type":"integer","description":"Total number of paid calls to a resource in the last 30 days.","example":42,"uniqueKey":"\\items.items.[INDEX].quality.l30DaysTotalCalls","typeLabel":"integer"},"l30DaysUniquePayers":{"type":"integer","description":"Number of unique payers to a resource in the last 30 days.","example":15,"uniqueKey":"\\items.items.[INDEX].quality.l30DaysUniquePayers","typeLabel":"integer"},"lastCalledAt":{"type":"string","format":"date-time","description":"Timestamp of the most recent paid call to a resource.","example":"2024-01-15T10:30:00Z","uniqueKey":"\\items.items.[INDEX].quality.lastCalledAt","typeLabel":"string\u003cdate-time>"}},"example":{"l30DaysTotalCalls":42,"l30DaysUniquePayers":15,"lastCalledAt":"2024-01-15T10:30:00Z"},"uniqueKey":"\\items.items.[INDEX].quality","typeLabel":"object"},"serviceName":{"type":"string","description":"Provider-supplied display name of the service this resource belongs to. This is a free-form\nlabel for grouping and presentation only — it is not a stable identifier, and two resources\nsharing the same `serviceName` are not guaranteed to belong to the same logical service.\n","example":"Weather API","uniqueKey":"\\items.items.[INDEX].serviceName","typeLabel":"string"},"tags":{"type":"array","description":"Provider-supplied, low-cardinality string labels associated with the resource for client-side\nfiltering and display. Values are free-form (no controlled vocabulary) and case-sensitive.\nOrder is not significant and duplicates are not expected.\n","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"example":["weather","data"],"uniqueKey":"\\items.items.[INDEX].tags","typeLabel":"string[]"},"iconUrl":{"type":"string","description":"URL of a square icon representing the service this resource belongs to. Distinct from a\nbrand logo: this is intended for compact, list-view rendering (favicon-style) and is\nnormalized to a square aspect ratio at ingestion. The image is moderated and re-hosted by\nCoinbase, so the URL is stable and safe to render directly in clients. Omitted when the\nprovider did not supply an icon, when the supplied icon failed moderation, or when image\nprocessing was unavailable at ingestion time.\n","format":"uri","maxLength":2048,"minLength":11,"pattern":"^https?://.*$","example":"https://res.cloudinary.com/bdb-prod/image/upload/...","uniqueKey":"\\items.items.[INDEX].iconUrl","typeLabel":"string\u003curi>"}},"required":["resource","type","x402Version"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"example":[{"resource":"https://api.example.com/weather/forecast","description":"Real-time weather forecast data.","type":"http","x402Version":2,"lastUpdated":"2024-01-15T10:30:00Z","accepts":[{"scheme":"exact","network":"eip155:8453","amount":"1000000","payTo":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","asset":"0x036CbD53842c5426634e7929541eC2318f3dCF7e","maxTimeoutSeconds":60}],"extensions":{"bazaar":{"info":{"input":{"type":"http","method":"GET"}},"schema":{}}},"quality":{"l30DaysTotalCalls":42,"l30DaysUniquePayers":15,"lastCalledAt":"2024-01-15T10:30:00Z"},"serviceName":"Weather API","tags":["weather","data"],"iconUrl":"https://res.cloudinary.com/bdb-prod/image/upload/..."}],"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"pagination":{"type":"object","description":"Pagination information for the response.","properties":{"limit":{"type":"integer","description":"The number of discovered x402 resources to return per page.","example":100,"uniqueKey":"pagination.limit","typeLabel":"integer"},"offset":{"type":"integer","description":"The offset of the first discovered x402 resource to return.","example":0,"uniqueKey":"pagination.offset","typeLabel":"integer"},"total":{"type":"integer","description":"The total number of discovered x402 resources.","example":1000,"uniqueKey":"pagination.total","typeLabel":"integer"}},"example":{"limit":100,"offset":0,"total":1000},"isRequired":true,"uniqueKey":"pagination","typeLabel":"object"}},"required":["items","x402Version","pagination"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"x402Version":2,"items":[{"resource":"https://api.example.com/weather/forecast","description":"Real-time weather forecast data.","type":"http","x402Version":2,"lastUpdated":"2024-01-15T10:30:00Z","accepts":[{"scheme":"exact","network":"eip155:8453","amount":"1000000","payTo":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","asset":"0x036CbD53842c5426634e7929541eC2318f3dCF7e","maxTimeoutSeconds":60}],"extensions":{"bazaar":{"info":{"input":{"type":"http","method":"GET"}},"schema":{}}},"quality":{"l30DaysTotalCalls":42,"l30DaysUniquePayers":15,"lastCalledAt":"2024-01-15T10:30:00Z"},"serviceName":"Weather API","tags":["weather","data"],"iconUrl":"https://res.cloudinary.com/bdb-prod/image/upload/..."}],"pagination":{"limit":100,"offset":0,"total":1000}}}},"exampleType":"generated"}},"exampleType":"generated"},"f5e3e6fe-22ad-4562-b4b9-b1ae7500af71":{"description":"Invalid request.","content":{"application/json":{"schema":{"description":"An error response including the code for the type of error and a human-readable message describing the error.","type":"object","properties":{"errorType":{"description":"The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.","type":"string","example":"invalid_request","enum":["already_exists","authorization_expired","bad_gateway","capture_expired","client_closed_request","customer_not_authorized","endpoint_unavailable","faucet_limit_exceeded","forbidden","idempotency_error","internal_server_error","invalid_request","invalid_sql_query","invalid_signature","malformed_transaction","not_found","payment_method_required","payment_required","settlement_failed","rate_limit_exceeded","request_canceled","service_unavailable","timed_out","unauthorized","unsupported_tos_language","policy_violation","policy_in_use","account_limit_exceeded","network_not_tradable","guest_permission_denied","guest_region_forbidden","guest_transaction_limit","guest_transaction_count","phone_number_verification_expired","document_verification_failed","recipient_allowlist_violation","recipient_allowlist_pending","refund_expired","travel_rules_recipient_violation","source_account_invalid","target_account_invalid","source_account_not_found","target_account_not_found","source_asset_not_supported","target_asset_not_supported","target_email_invalid","target_onchain_address_invalid","transfer_amount_invalid","transfer_asset_not_supported","transfer_quote_expired","insufficient_balance","metadata_too_many_entries","metadata_key_too_long","metadata_value_too_long","travel_rules_field_missing","asset_mismatch","mfa_already_enrolled","mfa_invalid_code","mfa_flow_expired","mfa_required","mfa_not_enrolled","order_quote_expired","order_already_filled","order_already_canceled","account_not_ready","insufficient_liquidity","insufficient_allowance","transaction_simulation_failed","delegation_not_found","delegation_expired","delegation_revoked","delegation_not_authorized","delegation_not_enabled","network_mismatch","already_enabled"],"x-error-instructions":{"already_exists":"This error occurs when trying to create a resource that already exists.\n\n**Steps to resolve:**\n1. Check if the resource exists before creation\n2. Use GET endpoints to verify resource state\n3. Use unique identifiers/names for resources","authorization_expired":"Returned when an authorization attempt is made after the payment session's authorization deadline has passed. Create a new payment session with a later authorization deadline.","bad_gateway":"This error occurs when the CDP API is unable to connect to the backend service.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","capture_expired":"Returned when a capture attempt is made after the payment session's capture deadline has passed. The payment session can no longer be captured.","client_closed_request":"This error occurs when the client closes the connection before the server can send a response.\n\n**Common causes:**\n- The client timed out waiting for the server response\n- The client application was terminated during a pending request\n- Network interruption caused the client connection to drop\n\n**Steps to resolve:**\n1. Increase client-side timeout settings if applicable\n2. Implement retry logic with exponential backoff for long-running queries\n3. Consider optimizing the request to reduce server processing time","endpoint_unavailable":"This error occurs when a specific endpoint has been temporarily disabled by an operator (e.g. a kill switch). The CDP API as a whole is still healthy; only this endpoint is unavailable. Distinct from `service_unavailable`, which indicates the API itself is down.\n\nRe-enabling is a manual operator action, so the endpoint may remain unavailable for an extended period.\n\n**Steps to resolve:**\n1. Check the [CDP status page](https://cdpstatus.coinbase.com/) for an active incident.\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details","faucet_limit_exceeded":"This error occurs when you've exceeded the faucet request limits.\n\n**Steps to resolve:**\n1. Wait for the time window to reset\n2. Use funds more efficiently in your testing\n\nFor more information on faucet limits, please visit the [EVM Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-evm-test-networks) or the [Solana Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-solana-devnet).","customer_not_authorized":"This error occurs when the customer is not currently authorized for one\nor more capabilities required to perform the requested action. This can\nhappen at any point in the customer's lifecycle and may or may not be\nresolvable by the developer.\n\nThe response includes an `unauthorizedCapabilities` field listing the\ncapability code(s) that were not authorized on this request.\n\n**Steps to resolve:**\n1. Fetch the customer with `GET /v2/customers/{customerId}` and inspect\n the `requirements` field. If `requirements.due` is non-empty, submit\n the listed fields via `POST /v2/customers/{customerId}` and retry.\n2. If `requirements.due` is empty, no further action is available — the\n customer is not currently eligible for this action.","forbidden":"This error occurs when you don't have permission to access the resource.\n\n**Steps to resolve:**\n1. Verify your permissions to access the resource\n2. Ensure that you are the owner of the requested resource","idempotency_error":"This error occurs when an idempotency key is reused with different parameters.\n\n**Steps to resolve:**\n1. Generate a new UUID v4 for each unique request\n2. Only reuse idempotency keys for exact request duplicates\n3. Track used keys within your application\n\n**Example idempotency key implementation:**\n```typescript lines wrap\nimport { v4 as uuidv4 } from 'uuid';\n\nfunction createIdempotencyKey() {\n return uuidv4();\n}\n```","internal_server_error":"This indicates an unexpected error that occurred on the CDP servers.\n\n**Important**: If you encounter this error, please note that your operation's status should be treated as unknown by your application, as it could have been a success within the CDP back-end.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - Your correlation ID\n - Timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","invalid_request":"This error occurs when the request is malformed or contains invalid data, including issues with the request body, query parameters, path parameters, or headers.\n\n**Steps to resolve:**\n1. Check all required fields and parameters are present\n2. Ensure request body (if applicable) follows the correct schema\n3. Verify all parameter formats match the API specification:\n - Query parameters\n - Path parameters\n - Request headers\n4. Validate any addresses, IDs, or other formatted strings meet requirements\n\n**Common validation issues:**\n- Missing required parameters\n- Invalid parameter types or formats\n- Malformed JSON in request body\n- Invalid enum values\n\n#### Transfer-specific validation errors\n\nThe following transfer validation scenarios return `errorType: \"invalid_request\"`. Use the `errorMessage` field to identify the specific case.\n\n| Scenario | Example `errorMessage` |\n|----------|----------------------|\n| Source account ID is malformed | `\"source is invalid.\"` |\n| Target account ID is malformed | `\"target is invalid.\"` |\n| Source account does not exist | `\"source not found.\"` |\n| Target account does not exist | `\"target not found.\"` |\n| Asset not supported at source | `\"source is not supported.\"` |\n| Asset not supported at target | `\"target is not supported.\"` |\n| Target email address is malformed | `\"target has an invalid email format.\"` |\n| Target onchain address is invalid for network | `\"The recipient address is invalid for the selected network.\"` |\n| Asset not supported for this transfer route | `\"Transfer asset pair is not supported.\"` |\n| Insufficient balance | `\"Insufficient funds to complete this transfer.\"` |\n| Asset mismatch between request fields | `\"Currency mismatch in request.\"` |\n| Metadata has too many keys | `\"Metadata has too many keys. Up to 10 key/value pairs are permitted.\"` |\n| Metadata key exceeds length limit | `\"Metadata key is too long. Each key must be less than or equal to 40 characters.\"` |\n| Metadata value exceeds length limit | `\"Metadata value is too long. Each value must be less than or equal to 500 characters.\"` |\n| Travel rule fields missing | `\"Travel rule information is incomplete. Missing fields: ...\"` |\n| Recipient address not in account allowlist | `\"Your coinbase account allowlist does not include this address. Please update your allowlist at https://www.coinbase.com/settings/allowlist\"` |","invalid_sql_query":"This error occurs when the SQL query is invalid or not allowed.\n\n**Common causes:**\n- Using non-SELECT SQL statements (INSERT, UPDATE, DELETE, etc.)\n- Invalid table or column names\n- Syntax errors in SQL query\n- Query exceeds character limit\n- Too many JOIN operations","invalid_signature":"This error occurs when the signature provided for the given user operation is invalid.\n\n**Steps to resolve:**\n1. Verify the signature was generated by the correct owner account\n2. Ensure the signature corresponds to the exact user operation hash\n3. Check that the signature format matches the expected format\n4. Confirm you're using the correct network for the Smart Account\n\n**Common causes:**\n- Using wrong owner account to sign\n- Signing modified/incorrect user operation data\n- Malformed signature encoding\n- Network mismatch between signature and broadcast","malformed_transaction":"This error occurs when the transaction data provided is not properly formatted or is invalid.\n\n**Steps to resolve:**\n1. Verify transaction encoding:\n - **EVM networks**: Check RLP encoding is correct\n - **Solana**: Validate base64 encoding\n2. Ensure all required transaction fields are present\n3. Validate transaction parameters are within acceptable ranges\n4. Check that the transaction type is supported on the target network (see our [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) page for more details)\n\n**Common causes:**\n- Invalid hex encoding for EVM transactions\n- Missing required transaction fields\n- Incorrect parameter formats\n- Unsupported transaction types\n- Network-specific transaction format mismatches","not_found":"This error occurs when the resource specified in your request doesn't exist or you don't have access to it.\n\n**Steps to resolve:**\n1. Verify the resource ID/address/account exists\n2. Check your permissions to access the resource\n3. Ensure you're using the correct network/environment\n4. Confirm the resource hasn't been deleted\n\n**Common causes:**\n- Mistyped addresses\n- Accessing resources from the wrong CDP project\n- Resource was deleted or hasn't been created yet","payment_method_required":"This error occurs when a payment method is required to complete the requested operation but none is configured or available.\n\n**Steps to resolve:**\n1. Add a valid payment method to your account using the [CDP Portal](https://portal.cdp.coinbase.com)\n2. Ensure your payment method is valid and not expired\n\n**Common causes:**\n- No payment method configured on the account\n- Payment method is expired","payment_required":"This error occurs when an x402 payment is required to access the requested resource.\n\n**Steps to resolve:**\n1. Include a valid x402 payment header in your request\n2. Ensure the payment meets the resource's pricing requirements","settlement_failed":"This error occurs when an x402 payment was verified but settlement on-chain failed.\n\n**Steps to resolve:**\n1. Retry the request with a new payment\n2. Ensure the payment asset has sufficient balance for settlement","rate_limit_exceeded":"This error occurs when you've exceeded the API rate limits.\n\n**Steps to resolve:**\n1. Implement exponential backoff\n2. Cache responses where possible\n3. Wait for rate limit window to reset\n\n**Best practices:**\n```typescript lines wrap\nasync function withRetry(fn: () => Promise\u003cany>) {\n let delay = 1000;\n while (true) {\n try {\n return await fn();\n } catch (e) {\n if (e.errorType === \"rate_limit_exceeded\") {\n await sleep(delay);\n delay *= 2;\n continue;\n }\n throw e;\n }\n }\n}\n```","request_canceled":"This error occurs when the client cancels an in-progress request before it completes.\n\n**Steps to resolve:**\n1. Check client-side timeout configurations\n2. Review request cancellation logic in your code\n3. Consider increasing timeout thresholds for long-running operations\n4. Implement request tracking to identify premature cancellations\n\n**Best practices:**\n```typescript lines wrap\nasync function withTimeout\u003cT>(promise: Promise\u003cT>, timeoutMs: number): Promise\u003cT> {\n const timeout = new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(\"Operation timed out\"));\n }, timeoutMs);\n });\n\n try {\n return await Promise.race([promise, timeout]);\n } catch (error) {\n // Handle timeout or cancellation\n throw error;\n }\n}\n```","service_unavailable":"This error occurs when the CDP API is temporarily unable to handle requests due to maintenance or high load.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","timed_out":"This error occurs when a request exceeds the maximum allowed processing time.\n\n**Steps to resolve:**\n1. Break down large requests into smaller chunks (if applicable)\n2. Implement retry logic with exponential backoff\n3. Use streaming endpoints for large data sets\n\n**Example retry implementation:**\n```typescript lines wrap\nasync function withRetryAndTimeout\u003cT>(\n operation: () => Promise\u003cT>,\n maxRetries = 3,\n timeout = 30000,\n): Promise\u003cT> {\n let attempts = 0;\n while (attempts \u003c maxRetries) {\n try {\n return await Promise.race([\n operation(),\n new Promise((_, reject) =>\n setTimeout(() => reject(new Error(\"Timeout\")), timeout)\n ),\n ]);\n } catch (error) {\n attempts++;\n if (attempts === maxRetries) throw error;\n // Exponential backoff\n await new Promise(resolve =>\n setTimeout(resolve, Math.pow(2, attempts) * 1000)\n );\n }\n }\n throw new Error(\"Max retries exceeded\");\n}\n```","unauthorized":"This error occurs when authentication fails.\n\n**Steps to resolve:**\n1. Verify your CDP API credentials:\n - Check that your API key is valid\n - Check that your Wallet Secret is properly configured\n2. Validate JWT token:\n - Not expired\n - Properly signed\n - Contains required claims\n3. Check request headers:\n - Authorization header present\n - X-Wallet-Auth header included when required\n\n**Security note:** Never share your Wallet Secret or API keys.","unsupported_tos_language":"A submitted Terms of Service acceptance used a `language` that is not published for the referenced `versionId`.\n\n**Steps to resolve:**\n1. Read `Customer.requirements.tos.tosVersions[]` and find the entry whose `versionId` matches your acceptance.\n2. Choose a `language` from that entry's `languages` list (BCP 47 tags).\n3. Retry with `tosAcceptances[].language` set to a supported tag.","policy_in_use":"This error occurs when trying to delete a Policy that is currently in use by at least one project or account.\n\n**Steps to resolve:**\n1. Update project or accounts to remove references to the Policy in question.\n2. Retry your delete request.","network_not_tradable":"This error occurs when the selected asset cannot be purchased on the selected network in the user's location.\n\n**Steps to resolve:**\n1. Verify the asset is tradable on the selected network\n2. Check the user's location to ensure it is allowed to purchase the asset on the selected network\n\n**Common causes:**\n- Users in NY are not allowed to purchase USDC on any network other than Ethereum","guest_permission_denied":"This error occurs when the user is not allowed to complete onramp transactions as a guest.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_region_forbidden":"This error occurs when guest onramp transactions are not allowed in the user's region.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_transaction_limit":"This error occurs when the user has reached the weekly guest onramp transaction limit.\n\n**Steps to resolve:**\n1. Inform the user they have reached their weekly limit and will have to wait until next week.","guest_transaction_count":"This error occurs when the user has reached the lifetime guest onramp transaction count limit.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","phone_number_verification_expired":"This error occurs when the user's phone number verification has expired. Use of guest Onramp requires the user's\nphone number to be verified every 60 days.\n\n**Steps to resolve:**\n1. Re-verify the user's phone number via OTP.\n2. Retry the request with the phoneNumberVerifiedAt field set to new verification timestamp.","document_verification_failed":"This error occurs when the user has not verified their identity for their coinbase.com account.\n**Steps to resolve:**\n1. Verify your coinbase account identity with valid documents at https://www.coinbase.com/settings/account-levels.","recipient_allowlist_violation":"This error occurs when the user is not allowed to receive funds at this address, according to their coinbase account allowlist.\n**Steps to resolve:**\n1. Either disable the allowlist or add the wallet address at https://www.coinbase.com/settings/allowlist\n2. Wait approximately 2 days for updates to take effect.","recipient_allowlist_pending":"This error occurs when the user is not allowed to receive funds at this address, because changes to their coinbase account allowlist are pending.\n**Steps to resolve:**\n1. Wait approximately 2 days for updates to take effect.","refund_expired":"Returned when a refund attempt is made after the payment session's refund deadline has passed. The payment session can no longer be refunded.","travel_rules_recipient_violation":"This error occurs when the user is not allowed to receive funds at this address, because it violates travel rules.\n**Steps to resolve:**\n1. Ensure your desired transfer is not blocked by local travel regulations.","mfa_already_enrolled":"This error occurs when attempting to enroll in an MFA method that the user has already enrolled in.\n\n**Steps to resolve:**\n1. Check if the user is already enrolled in the MFA method before initiating enrollment\n2. To update or reset MFA, remove the existing enrollment first (if supported)\n3. Use a different MFA method if multiple options are available","mfa_invalid_code":"This error occurs when the MFA code provided is incorrect or has already been used.\n\n**Steps to resolve:**\n1. Verify the user entered the correct code from their authenticator app\n2. Ensure the code is current (TOTP codes expire after 30 seconds)\n3. Check that the device time is synchronized correctly\n4. Ask the user to generate a new code and try again\n\n**Common causes:**\n- Typing errors in the 6-digit code\n- Using an expired TOTP code\n- Device clock drift on user's authenticator app\n- Attempting to reuse a previously submitted code","mfa_flow_expired":"This error occurs when the MFA enrollment or verification session has expired.\n\n**Steps to resolve:**\n1. Restart the MFA enrollment or verification flow\n2. Complete the flow within the allowed time window (typically 5 minutes)\n3. Ensure the user doesn't leave the flow idle for extended periods\n\n**Note:** MFA sessions expire automatically for security purposes.","mfa_required":"This error occurs when attempting to perform a sensitive operation that requires MFA verification, but the user has not completed MFA verification.\n\n**Steps to resolve:**\n1. Initiate the MFA verification flow using the `/mfa/verify/{mfaMethod}/init` endpoint\n2. Prompt the user to enter their MFA code\n3. Submit the verification using the `/mfa/verify/{mfaMethod}/submit` endpoint\n4. Use the returned access token with MFA claim for the sensitive operation\n5. Retry the original request with the new MFA-verified token\n\n**Operations requiring MFA:**\n- Transactions Sign/Send\n- Key export\n- Account management actions (when configured)","mfa_not_enrolled":"This error occurs when attempting to verify MFA for a user who has not enrolled in any MFA method.\n\n**Steps to resolve:**\n1. Check if the user has enrolled in MFA before attempting verification\n2. Guide the user through MFA enrollment first using the `/mfa/enroll/{mfaMethod}/init` endpoint\n3. Complete enrollment before requiring MFA verification","source_account_invalid":"This error occurs when the source account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account ID belongs to your CDP entity\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","target_account_invalid":"This error occurs when the target account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account exists and can receive funds\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","source_account_not_found":"This error occurs when the source account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","target_account_not_found":"This error occurs when the target account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","source_asset_not_supported":"This error occurs when the asset specified in the transfer source is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the source account type\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n\n**Common causes:**\n- Unsupported asset for the transfer route\n- Incorrect asset symbol","target_asset_not_supported":"This error occurs when the asset specified in the transfer target is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the target\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n3. Ensure the target can receive this asset type\n\n**Common causes:**\n- Asset not supported by the target\n- Unsupported conversion between source and target assets","target_email_invalid":"This error occurs when the email address specified as the transfer target is invalid.\n\n**Steps to resolve:**\n1. Verify the email address format is valid (e.g., `user@example.com`)\n2. Check for typos in the email address\n3. Ensure the email domain is valid\n\n**Common causes:**\n- Invalid email format\n- Missing @ symbol or domain\n- Typo in the email address","target_onchain_address_invalid":"This error occurs when the onchain address specified as the transfer target is invalid for the specified network.\n\n**Steps to resolve:**\n1. Ensure the network is supported for the transfer type\n2. Verify the address format matches the target network\n3. Ensure you haven't mixed up addresses from different networks\n\n**Common causes:**\n- Network not supported for the transfer type\n- Address format doesn't match network\n- Address from a different blockchain network","transfer_amount_invalid":"This error occurs when the transfer amount is invalid.\n\n**Steps to resolve:**\n1. Ensure the amount is a positive number and greater than $1 USD equivalent amount\n2. Verify the amount format is a valid decimal string (e.g., `\"100.50\"`)\n3. Check the number of decimal places for the asset\n\n**Common causes:**\n- Zero or negative amount\n- Too many decimal places for the asset\n- Amount below minimum threshold ($1 USD equivalent amount)","transfer_asset_not_supported":"This error occurs when the asset specified for the transfer is not supported.\n\n**Steps to resolve:**\n1. Check the list of supported assets for transfers\n2. Verify the asset symbol is correctly specified\n3. Ensure the asset is supported for the transfer route (source → target)\n\n**Common causes:**\n- Asset not supported for transfers\n- Incorrect asset symbol","transfer_quote_expired":"This error occurs when the transfer quote has expired. Quotes are valid for a limited time.\n\n**Steps to resolve:**\n1. Create a new transfer to obtain a fresh quote\n2. Execute the transfer promptly after creation\n\n**Common causes:**\n- Too much time elapsed between creating and executing the transfer","insufficient_balance":"This error occurs when the source account does not have enough funds to complete the transfer including fees.\n\n**Steps to resolve:**\n1. Check the source account balance\n2. Ensure the balance covers both the transfer amount and any fees\n3. Consider using `amountType: \"source\"` to transfer the maximum available amount minus fees\n4. Add funds to the source account if needed\n\n**Common causes:**\n- Transfer amount exceeds available balance\n- Not accounting for transfer fees\n- Pending transactions reducing available balance","metadata_too_many_entries":"This error occurs when the transfer metadata contains more entries than allowed.\n\n**Steps to resolve:**\n1. Reduce the number of metadata entries (maximum 10 allowed)\n2. Consolidate related data into fewer keys\n3. Store additional data externally and reference it with a single metadata entry\n\n**Limits:**\n- Maximum entries: 10","metadata_key_too_long":"This error occurs when a metadata key exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata key to 40 characters or less\n2. Use abbreviations or shorter naming conventions\n3. Consider using a key-value structure where the value contains the longer identifier\n\n**Limits:**\n- Maximum key length: 40 characters","metadata_value_too_long":"This error occurs when a metadata value exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata value to 500 characters or less\n2. Store longer data externally and reference it with a shorter identifier\n3. Consider compressing or encoding the data if appropriate\n\n**Limits:**\n- Maximum value length: 500 characters","travel_rules_field_missing":"This error occurs when required travel rule fields are missing from the transfer request.\n\n**Steps to resolve:**\n1. Include the `travelRule` object in your transfer request\n2. Supply the required missing fields prompted by the error message\n3. Review the travel rule requirements for your jurisdiction\n\nNote: Required fields may vary by region.","asset_mismatch":"This error occurs when the assets specified in the transfer are incompatible or don't match expected values.\n\n**Steps to resolve:**\n1. Ensure the `asset` field matches either the source or target asset\n2. Verify that the source and target assets are compatible for conversion (if different)\n3. Check that the asset symbols are correctly specified\n\n**Common causes:**\n- Transfer asset doesn't match source or target\n- Attempting an unsupported asset conversion\n- Typo in asset symbols","order_quote_expired":"This error occurs when attempting to execute an order whose quote has expired.\n\n**Steps to resolve:**\n1. Create a new order with `execute: false` to get an updated quote.\n2. Execute the new order before the quote expires (check the `expiresAt` field).\n3. Alternatively, create a new order with `execute: true` to skip the quote step and execute immediately.","order_already_filled":"This error occurs when attempting to cancel or modify an order that has already been filled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. A filled order cannot be canceled or re-executed.","order_already_canceled":"This error occurs when attempting to cancel or execute an order that has already been canceled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. Create a new order if you still want to trade.","account_not_ready":"This error occurs when an operation is attempted on an account that is still being provisioned.\n\n**Steps to resolve:**\n1. Wait a few moments and retry the request\n2. If the error persists, the account may still be completing setup — retry with exponential backoff","insufficient_liquidity":"This error occurs when no swap route is available for the requested token pair or amount.\n\n**Steps to resolve:**\n1. Try a smaller `fromAmount` — large orders may exceed available liquidity\n2. Try a different token pair\n3. Retry after a short delay; liquidity conditions change with market activity","insufficient_allowance":"This error occurs when the taker has not approved the Permit2 contract to spend the `fromToken`\non their behalf. ERC-20 swaps require a Permit2 allowance. Native ETH swaps do not.\n\n**Steps to resolve:**\n1. Submit an ERC-20 `approve` transaction on the `fromToken` contract, granting the Permit2\n contract (`0x000000000022D473030F116dDEE9F6B43aC78BA3`) an allowance of at least `fromAmount`\n2. Wait for the approval transaction to be confirmed on-chain\n3. Retry the swap\n\n**Example:**\n```typescript lines wrap\n// Approve Permit2 to spend fromToken\nawait walletClient.writeContract({\n address: fromToken,\n abi: erc20Abi,\n functionName: \"approve\",\n args: [\"0x000000000022D473030F116dDEE9F6B43aC78BA3\", fromAmount],\n});\n```","transaction_simulation_failed":"This error occurs when the pre-broadcast simulation of the swap transaction predicted a revert.\nNo transaction was submitted and no gas was spent.\n\n**Common causes:**\n- The on-chain price moved past the `slippageBps` tolerance between the price estimate and execution\n- Taker balance changed between the price estimate and execution\n\n**Steps to resolve:**\n1. Retry immediately — prices change quickly and a new quote may succeed\n2. Increase `slippageBps` if retries continue to fail (e.g. from 100 to 200)\n3. For large swaps, consider splitting into smaller amounts to reduce price impact","delegation_not_found":"This error occurs when a delegated signing operation is attempted but no active\ndelegation grant exists for the end user (or account).\n\n**Steps to resolve:**\n1. Create a delegation grant using `createDelegationForEndUser` (user-scoped)\n or `createDelegationForEndUserAccount` (account-scoped) before calling\n the signing or sending operation\n2. If you previously created a grant, it may have expired or been revoked —\n in those cases you would receive a `delegation_expired` or\n `delegation_revoked` error instead\n3. For account-scoped grants, verify the address in the request matches the\n granted address (EVM addresses are compared case-insensitively;\n Solana addresses must match exactly)","delegation_expired":"This error occurs when the delegation grant used for signing has expired.\nDelegation grants have a limited lifetime set at creation.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Retry the signing operation with the new grant active\n3. Consider creating grants with a longer TTL if expiry is frequent","delegation_revoked":"This error occurs when the delegation grant has been explicitly revoked.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Confirm with the end user before recreating, since revocation is\n typically intentional","delegation_not_authorized":"This error occurs when a delegation grant exists but does not authorize the\nrequested operation.\n\n**Steps to resolve:**\n1. For account-scoped grants, verify the signing address matches the address\n the grant was created for\n2. Check that the operation is permitted for delegated signing on your project\n3. Create a grant with the correct scope if needed","delegation_not_enabled":"This error occurs when delegated signing is attempted on a project that has\nnot enabled the feature.\n\n**Steps to resolve:**\n1. Enable delegated signing in your project configuration via the CDP Portal\n2. Contact support if you believe delegated signing should already be enabled\n for your project","network_mismatch":"This error occurs when the requested operation specifies a network on which the\ntarget resource is not deployed or not available.\n\n**Steps to resolve:**\n1. Use the network the resource was originally created or deployed on\n2. Check the resource metadata to confirm the correct network\n\n**Common causes:**\n- Specifying `base` for a resource that only exists on `base-sepolia` (or vice versa)\n- Cross-network operation attempted on a resource scoped to a single network","already_enabled":"This error occurs when the requested operation cannot be performed because\nthe capability is already in the desired state.\n\n**Steps to resolve:**\n1. Check the current state of the resource before attempting the operation\n2. No action is needed if the resource is already in the desired state\n\n**Common causes:**\n- Calling an enable endpoint on a resource that already has the feature enabled"},"isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"The error message.","type":"string","example":"Unable to create EVM account","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"},"correlationId":{"description":"A unique identifier for the request that generated the error. This can be used to help debug issues with the API.","type":"string","example":"41deb8d59a9dc9a7-IAD","uniqueKey":"correlationId","typeLabel":"string"},"errorLink":{"type":"string","description":"A link to the corresponding error documentation.","format":"uri","maxLength":2048,"minLength":11,"pattern":"^https?://.*$","example":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request","uniqueKey":"errorLink","typeLabel":"string\u003curi>"},"unauthorizedCapabilities":{"description":"The capability code(s) that were not authorized for the customer on\nthis request. Present only when `errorType` is\n`customer_not_authorized`; absent for every other error type.\n\nUse this list to render onboarding UX for the listed capabilities, or\nfetch `GET /v2/customers/{customerId}` and inspect each entry's\n`status` / `requirements` to discover what (if anything) can be\nsubmitted to resolve the block.\n","type":"array","items":{"type":"string","description":"The name of a capability. Capabilities represent granular functional permissions\nthat determine what actions a customer can perform. Each capability must be\nexplicitly requested before use.\n","enum":["custodyCrypto","custodyFiat","custodyStablecoin","tradeCrypto","tradeStablecoin","transferCrypto","transferFiat","transferStablecoin"],"example":"custodyCrypto","uniqueKey":"unauthorizedCapabilities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"unauthorizedCapabilities","typeLabel":"enum\u003cstring>[]"}},"required":["errorType","errorMessage"],"example":{"errorType":"invalid_request","errorMessage":"Invalid request.","correlationId":"41deb8d59a9dc9a7-IAD","errorLink":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request"},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_request":{"title":"invalid_request","value":{"errorType":"invalid_request","errorMessage":"Invalid request. Please check the request parameters."}}},"exampleType":"examples"}},"exampleType":"examples"},"b7cc2b5a-579d-484c-887b-b58f52232d6e":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"An error response including the code for the type of error and a human-readable message describing the error.","type":"object","properties":{"errorType":{"description":"The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.","type":"string","example":"invalid_request","enum":["already_exists","authorization_expired","bad_gateway","capture_expired","client_closed_request","customer_not_authorized","endpoint_unavailable","faucet_limit_exceeded","forbidden","idempotency_error","internal_server_error","invalid_request","invalid_sql_query","invalid_signature","malformed_transaction","not_found","payment_method_required","payment_required","settlement_failed","rate_limit_exceeded","request_canceled","service_unavailable","timed_out","unauthorized","unsupported_tos_language","policy_violation","policy_in_use","account_limit_exceeded","network_not_tradable","guest_permission_denied","guest_region_forbidden","guest_transaction_limit","guest_transaction_count","phone_number_verification_expired","document_verification_failed","recipient_allowlist_violation","recipient_allowlist_pending","refund_expired","travel_rules_recipient_violation","source_account_invalid","target_account_invalid","source_account_not_found","target_account_not_found","source_asset_not_supported","target_asset_not_supported","target_email_invalid","target_onchain_address_invalid","transfer_amount_invalid","transfer_asset_not_supported","transfer_quote_expired","insufficient_balance","metadata_too_many_entries","metadata_key_too_long","metadata_value_too_long","travel_rules_field_missing","asset_mismatch","mfa_already_enrolled","mfa_invalid_code","mfa_flow_expired","mfa_required","mfa_not_enrolled","order_quote_expired","order_already_filled","order_already_canceled","account_not_ready","insufficient_liquidity","insufficient_allowance","transaction_simulation_failed","delegation_not_found","delegation_expired","delegation_revoked","delegation_not_authorized","delegation_not_enabled","network_mismatch","already_enabled"],"x-error-instructions":{"already_exists":"This error occurs when trying to create a resource that already exists.\n\n**Steps to resolve:**\n1. Check if the resource exists before creation\n2. Use GET endpoints to verify resource state\n3. Use unique identifiers/names for resources","authorization_expired":"Returned when an authorization attempt is made after the payment session's authorization deadline has passed. Create a new payment session with a later authorization deadline.","bad_gateway":"This error occurs when the CDP API is unable to connect to the backend service.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","capture_expired":"Returned when a capture attempt is made after the payment session's capture deadline has passed. The payment session can no longer be captured.","client_closed_request":"This error occurs when the client closes the connection before the server can send a response.\n\n**Common causes:**\n- The client timed out waiting for the server response\n- The client application was terminated during a pending request\n- Network interruption caused the client connection to drop\n\n**Steps to resolve:**\n1. Increase client-side timeout settings if applicable\n2. Implement retry logic with exponential backoff for long-running queries\n3. Consider optimizing the request to reduce server processing time","endpoint_unavailable":"This error occurs when a specific endpoint has been temporarily disabled by an operator (e.g. a kill switch). The CDP API as a whole is still healthy; only this endpoint is unavailable. Distinct from `service_unavailable`, which indicates the API itself is down.\n\nRe-enabling is a manual operator action, so the endpoint may remain unavailable for an extended period.\n\n**Steps to resolve:**\n1. Check the [CDP status page](https://cdpstatus.coinbase.com/) for an active incident.\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details","faucet_limit_exceeded":"This error occurs when you've exceeded the faucet request limits.\n\n**Steps to resolve:**\n1. Wait for the time window to reset\n2. Use funds more efficiently in your testing\n\nFor more information on faucet limits, please visit the [EVM Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-evm-test-networks) or the [Solana Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-solana-devnet).","customer_not_authorized":"This error occurs when the customer is not currently authorized for one\nor more capabilities required to perform the requested action. This can\nhappen at any point in the customer's lifecycle and may or may not be\nresolvable by the developer.\n\nThe response includes an `unauthorizedCapabilities` field listing the\ncapability code(s) that were not authorized on this request.\n\n**Steps to resolve:**\n1. Fetch the customer with `GET /v2/customers/{customerId}` and inspect\n the `requirements` field. If `requirements.due` is non-empty, submit\n the listed fields via `POST /v2/customers/{customerId}` and retry.\n2. If `requirements.due` is empty, no further action is available — the\n customer is not currently eligible for this action.","forbidden":"This error occurs when you don't have permission to access the resource.\n\n**Steps to resolve:**\n1. Verify your permissions to access the resource\n2. Ensure that you are the owner of the requested resource","idempotency_error":"This error occurs when an idempotency key is reused with different parameters.\n\n**Steps to resolve:**\n1. Generate a new UUID v4 for each unique request\n2. Only reuse idempotency keys for exact request duplicates\n3. Track used keys within your application\n\n**Example idempotency key implementation:**\n```typescript lines wrap\nimport { v4 as uuidv4 } from 'uuid';\n\nfunction createIdempotencyKey() {\n return uuidv4();\n}\n```","internal_server_error":"This indicates an unexpected error that occurred on the CDP servers.\n\n**Important**: If you encounter this error, please note that your operation's status should be treated as unknown by your application, as it could have been a success within the CDP back-end.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - Your correlation ID\n - Timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","invalid_request":"This error occurs when the request is malformed or contains invalid data, including issues with the request body, query parameters, path parameters, or headers.\n\n**Steps to resolve:**\n1. Check all required fields and parameters are present\n2. Ensure request body (if applicable) follows the correct schema\n3. Verify all parameter formats match the API specification:\n - Query parameters\n - Path parameters\n - Request headers\n4. Validate any addresses, IDs, or other formatted strings meet requirements\n\n**Common validation issues:**\n- Missing required parameters\n- Invalid parameter types or formats\n- Malformed JSON in request body\n- Invalid enum values\n\n#### Transfer-specific validation errors\n\nThe following transfer validation scenarios return `errorType: \"invalid_request\"`. Use the `errorMessage` field to identify the specific case.\n\n| Scenario | Example `errorMessage` |\n|----------|----------------------|\n| Source account ID is malformed | `\"source is invalid.\"` |\n| Target account ID is malformed | `\"target is invalid.\"` |\n| Source account does not exist | `\"source not found.\"` |\n| Target account does not exist | `\"target not found.\"` |\n| Asset not supported at source | `\"source is not supported.\"` |\n| Asset not supported at target | `\"target is not supported.\"` |\n| Target email address is malformed | `\"target has an invalid email format.\"` |\n| Target onchain address is invalid for network | `\"The recipient address is invalid for the selected network.\"` |\n| Asset not supported for this transfer route | `\"Transfer asset pair is not supported.\"` |\n| Insufficient balance | `\"Insufficient funds to complete this transfer.\"` |\n| Asset mismatch between request fields | `\"Currency mismatch in request.\"` |\n| Metadata has too many keys | `\"Metadata has too many keys. Up to 10 key/value pairs are permitted.\"` |\n| Metadata key exceeds length limit | `\"Metadata key is too long. Each key must be less than or equal to 40 characters.\"` |\n| Metadata value exceeds length limit | `\"Metadata value is too long. Each value must be less than or equal to 500 characters.\"` |\n| Travel rule fields missing | `\"Travel rule information is incomplete. Missing fields: ...\"` |\n| Recipient address not in account allowlist | `\"Your coinbase account allowlist does not include this address. Please update your allowlist at https://www.coinbase.com/settings/allowlist\"` |","invalid_sql_query":"This error occurs when the SQL query is invalid or not allowed.\n\n**Common causes:**\n- Using non-SELECT SQL statements (INSERT, UPDATE, DELETE, etc.)\n- Invalid table or column names\n- Syntax errors in SQL query\n- Query exceeds character limit\n- Too many JOIN operations","invalid_signature":"This error occurs when the signature provided for the given user operation is invalid.\n\n**Steps to resolve:**\n1. Verify the signature was generated by the correct owner account\n2. Ensure the signature corresponds to the exact user operation hash\n3. Check that the signature format matches the expected format\n4. Confirm you're using the correct network for the Smart Account\n\n**Common causes:**\n- Using wrong owner account to sign\n- Signing modified/incorrect user operation data\n- Malformed signature encoding\n- Network mismatch between signature and broadcast","malformed_transaction":"This error occurs when the transaction data provided is not properly formatted or is invalid.\n\n**Steps to resolve:**\n1. Verify transaction encoding:\n - **EVM networks**: Check RLP encoding is correct\n - **Solana**: Validate base64 encoding\n2. Ensure all required transaction fields are present\n3. Validate transaction parameters are within acceptable ranges\n4. Check that the transaction type is supported on the target network (see our [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) page for more details)\n\n**Common causes:**\n- Invalid hex encoding for EVM transactions\n- Missing required transaction fields\n- Incorrect parameter formats\n- Unsupported transaction types\n- Network-specific transaction format mismatches","not_found":"This error occurs when the resource specified in your request doesn't exist or you don't have access to it.\n\n**Steps to resolve:**\n1. Verify the resource ID/address/account exists\n2. Check your permissions to access the resource\n3. Ensure you're using the correct network/environment\n4. Confirm the resource hasn't been deleted\n\n**Common causes:**\n- Mistyped addresses\n- Accessing resources from the wrong CDP project\n- Resource was deleted or hasn't been created yet","payment_method_required":"This error occurs when a payment method is required to complete the requested operation but none is configured or available.\n\n**Steps to resolve:**\n1. Add a valid payment method to your account using the [CDP Portal](https://portal.cdp.coinbase.com)\n2. Ensure your payment method is valid and not expired\n\n**Common causes:**\n- No payment method configured on the account\n- Payment method is expired","payment_required":"This error occurs when an x402 payment is required to access the requested resource.\n\n**Steps to resolve:**\n1. Include a valid x402 payment header in your request\n2. Ensure the payment meets the resource's pricing requirements","settlement_failed":"This error occurs when an x402 payment was verified but settlement on-chain failed.\n\n**Steps to resolve:**\n1. Retry the request with a new payment\n2. Ensure the payment asset has sufficient balance for settlement","rate_limit_exceeded":"This error occurs when you've exceeded the API rate limits.\n\n**Steps to resolve:**\n1. Implement exponential backoff\n2. Cache responses where possible\n3. Wait for rate limit window to reset\n\n**Best practices:**\n```typescript lines wrap\nasync function withRetry(fn: () => Promise\u003cany>) {\n let delay = 1000;\n while (true) {\n try {\n return await fn();\n } catch (e) {\n if (e.errorType === \"rate_limit_exceeded\") {\n await sleep(delay);\n delay *= 2;\n continue;\n }\n throw e;\n }\n }\n}\n```","request_canceled":"This error occurs when the client cancels an in-progress request before it completes.\n\n**Steps to resolve:**\n1. Check client-side timeout configurations\n2. Review request cancellation logic in your code\n3. Consider increasing timeout thresholds for long-running operations\n4. Implement request tracking to identify premature cancellations\n\n**Best practices:**\n```typescript lines wrap\nasync function withTimeout\u003cT>(promise: Promise\u003cT>, timeoutMs: number): Promise\u003cT> {\n const timeout = new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(\"Operation timed out\"));\n }, timeoutMs);\n });\n\n try {\n return await Promise.race([promise, timeout]);\n } catch (error) {\n // Handle timeout or cancellation\n throw error;\n }\n}\n```","service_unavailable":"This error occurs when the CDP API is temporarily unable to handle requests due to maintenance or high load.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","timed_out":"This error occurs when a request exceeds the maximum allowed processing time.\n\n**Steps to resolve:**\n1. Break down large requests into smaller chunks (if applicable)\n2. Implement retry logic with exponential backoff\n3. Use streaming endpoints for large data sets\n\n**Example retry implementation:**\n```typescript lines wrap\nasync function withRetryAndTimeout\u003cT>(\n operation: () => Promise\u003cT>,\n maxRetries = 3,\n timeout = 30000,\n): Promise\u003cT> {\n let attempts = 0;\n while (attempts \u003c maxRetries) {\n try {\n return await Promise.race([\n operation(),\n new Promise((_, reject) =>\n setTimeout(() => reject(new Error(\"Timeout\")), timeout)\n ),\n ]);\n } catch (error) {\n attempts++;\n if (attempts === maxRetries) throw error;\n // Exponential backoff\n await new Promise(resolve =>\n setTimeout(resolve, Math.pow(2, attempts) * 1000)\n );\n }\n }\n throw new Error(\"Max retries exceeded\");\n}\n```","unauthorized":"This error occurs when authentication fails.\n\n**Steps to resolve:**\n1. Verify your CDP API credentials:\n - Check that your API key is valid\n - Check that your Wallet Secret is properly configured\n2. Validate JWT token:\n - Not expired\n - Properly signed\n - Contains required claims\n3. Check request headers:\n - Authorization header present\n - X-Wallet-Auth header included when required\n\n**Security note:** Never share your Wallet Secret or API keys.","unsupported_tos_language":"A submitted Terms of Service acceptance used a `language` that is not published for the referenced `versionId`.\n\n**Steps to resolve:**\n1. Read `Customer.requirements.tos.tosVersions[]` and find the entry whose `versionId` matches your acceptance.\n2. Choose a `language` from that entry's `languages` list (BCP 47 tags).\n3. Retry with `tosAcceptances[].language` set to a supported tag.","policy_in_use":"This error occurs when trying to delete a Policy that is currently in use by at least one project or account.\n\n**Steps to resolve:**\n1. Update project or accounts to remove references to the Policy in question.\n2. Retry your delete request.","network_not_tradable":"This error occurs when the selected asset cannot be purchased on the selected network in the user's location.\n\n**Steps to resolve:**\n1. Verify the asset is tradable on the selected network\n2. Check the user's location to ensure it is allowed to purchase the asset on the selected network\n\n**Common causes:**\n- Users in NY are not allowed to purchase USDC on any network other than Ethereum","guest_permission_denied":"This error occurs when the user is not allowed to complete onramp transactions as a guest.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_region_forbidden":"This error occurs when guest onramp transactions are not allowed in the user's region.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_transaction_limit":"This error occurs when the user has reached the weekly guest onramp transaction limit.\n\n**Steps to resolve:**\n1. Inform the user they have reached their weekly limit and will have to wait until next week.","guest_transaction_count":"This error occurs when the user has reached the lifetime guest onramp transaction count limit.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","phone_number_verification_expired":"This error occurs when the user's phone number verification has expired. Use of guest Onramp requires the user's\nphone number to be verified every 60 days.\n\n**Steps to resolve:**\n1. Re-verify the user's phone number via OTP.\n2. Retry the request with the phoneNumberVerifiedAt field set to new verification timestamp.","document_verification_failed":"This error occurs when the user has not verified their identity for their coinbase.com account.\n**Steps to resolve:**\n1. Verify your coinbase account identity with valid documents at https://www.coinbase.com/settings/account-levels.","recipient_allowlist_violation":"This error occurs when the user is not allowed to receive funds at this address, according to their coinbase account allowlist.\n**Steps to resolve:**\n1. Either disable the allowlist or add the wallet address at https://www.coinbase.com/settings/allowlist\n2. Wait approximately 2 days for updates to take effect.","recipient_allowlist_pending":"This error occurs when the user is not allowed to receive funds at this address, because changes to their coinbase account allowlist are pending.\n**Steps to resolve:**\n1. Wait approximately 2 days for updates to take effect.","refund_expired":"Returned when a refund attempt is made after the payment session's refund deadline has passed. The payment session can no longer be refunded.","travel_rules_recipient_violation":"This error occurs when the user is not allowed to receive funds at this address, because it violates travel rules.\n**Steps to resolve:**\n1. Ensure your desired transfer is not blocked by local travel regulations.","mfa_already_enrolled":"This error occurs when attempting to enroll in an MFA method that the user has already enrolled in.\n\n**Steps to resolve:**\n1. Check if the user is already enrolled in the MFA method before initiating enrollment\n2. To update or reset MFA, remove the existing enrollment first (if supported)\n3. Use a different MFA method if multiple options are available","mfa_invalid_code":"This error occurs when the MFA code provided is incorrect or has already been used.\n\n**Steps to resolve:**\n1. Verify the user entered the correct code from their authenticator app\n2. Ensure the code is current (TOTP codes expire after 30 seconds)\n3. Check that the device time is synchronized correctly\n4. Ask the user to generate a new code and try again\n\n**Common causes:**\n- Typing errors in the 6-digit code\n- Using an expired TOTP code\n- Device clock drift on user's authenticator app\n- Attempting to reuse a previously submitted code","mfa_flow_expired":"This error occurs when the MFA enrollment or verification session has expired.\n\n**Steps to resolve:**\n1. Restart the MFA enrollment or verification flow\n2. Complete the flow within the allowed time window (typically 5 minutes)\n3. Ensure the user doesn't leave the flow idle for extended periods\n\n**Note:** MFA sessions expire automatically for security purposes.","mfa_required":"This error occurs when attempting to perform a sensitive operation that requires MFA verification, but the user has not completed MFA verification.\n\n**Steps to resolve:**\n1. Initiate the MFA verification flow using the `/mfa/verify/{mfaMethod}/init` endpoint\n2. Prompt the user to enter their MFA code\n3. Submit the verification using the `/mfa/verify/{mfaMethod}/submit` endpoint\n4. Use the returned access token with MFA claim for the sensitive operation\n5. Retry the original request with the new MFA-verified token\n\n**Operations requiring MFA:**\n- Transactions Sign/Send\n- Key export\n- Account management actions (when configured)","mfa_not_enrolled":"This error occurs when attempting to verify MFA for a user who has not enrolled in any MFA method.\n\n**Steps to resolve:**\n1. Check if the user has enrolled in MFA before attempting verification\n2. Guide the user through MFA enrollment first using the `/mfa/enroll/{mfaMethod}/init` endpoint\n3. Complete enrollment before requiring MFA verification","source_account_invalid":"This error occurs when the source account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account ID belongs to your CDP entity\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","target_account_invalid":"This error occurs when the target account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account exists and can receive funds\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","source_account_not_found":"This error occurs when the source account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","target_account_not_found":"This error occurs when the target account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","source_asset_not_supported":"This error occurs when the asset specified in the transfer source is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the source account type\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n\n**Common causes:**\n- Unsupported asset for the transfer route\n- Incorrect asset symbol","target_asset_not_supported":"This error occurs when the asset specified in the transfer target is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the target\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n3. Ensure the target can receive this asset type\n\n**Common causes:**\n- Asset not supported by the target\n- Unsupported conversion between source and target assets","target_email_invalid":"This error occurs when the email address specified as the transfer target is invalid.\n\n**Steps to resolve:**\n1. Verify the email address format is valid (e.g., `user@example.com`)\n2. Check for typos in the email address\n3. Ensure the email domain is valid\n\n**Common causes:**\n- Invalid email format\n- Missing @ symbol or domain\n- Typo in the email address","target_onchain_address_invalid":"This error occurs when the onchain address specified as the transfer target is invalid for the specified network.\n\n**Steps to resolve:**\n1. Ensure the network is supported for the transfer type\n2. Verify the address format matches the target network\n3. Ensure you haven't mixed up addresses from different networks\n\n**Common causes:**\n- Network not supported for the transfer type\n- Address format doesn't match network\n- Address from a different blockchain network","transfer_amount_invalid":"This error occurs when the transfer amount is invalid.\n\n**Steps to resolve:**\n1. Ensure the amount is a positive number and greater than $1 USD equivalent amount\n2. Verify the amount format is a valid decimal string (e.g., `\"100.50\"`)\n3. Check the number of decimal places for the asset\n\n**Common causes:**\n- Zero or negative amount\n- Too many decimal places for the asset\n- Amount below minimum threshold ($1 USD equivalent amount)","transfer_asset_not_supported":"This error occurs when the asset specified for the transfer is not supported.\n\n**Steps to resolve:**\n1. Check the list of supported assets for transfers\n2. Verify the asset symbol is correctly specified\n3. Ensure the asset is supported for the transfer route (source → target)\n\n**Common causes:**\n- Asset not supported for transfers\n- Incorrect asset symbol","transfer_quote_expired":"This error occurs when the transfer quote has expired. Quotes are valid for a limited time.\n\n**Steps to resolve:**\n1. Create a new transfer to obtain a fresh quote\n2. Execute the transfer promptly after creation\n\n**Common causes:**\n- Too much time elapsed between creating and executing the transfer","insufficient_balance":"This error occurs when the source account does not have enough funds to complete the transfer including fees.\n\n**Steps to resolve:**\n1. Check the source account balance\n2. Ensure the balance covers both the transfer amount and any fees\n3. Consider using `amountType: \"source\"` to transfer the maximum available amount minus fees\n4. Add funds to the source account if needed\n\n**Common causes:**\n- Transfer amount exceeds available balance\n- Not accounting for transfer fees\n- Pending transactions reducing available balance","metadata_too_many_entries":"This error occurs when the transfer metadata contains more entries than allowed.\n\n**Steps to resolve:**\n1. Reduce the number of metadata entries (maximum 10 allowed)\n2. Consolidate related data into fewer keys\n3. Store additional data externally and reference it with a single metadata entry\n\n**Limits:**\n- Maximum entries: 10","metadata_key_too_long":"This error occurs when a metadata key exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata key to 40 characters or less\n2. Use abbreviations or shorter naming conventions\n3. Consider using a key-value structure where the value contains the longer identifier\n\n**Limits:**\n- Maximum key length: 40 characters","metadata_value_too_long":"This error occurs when a metadata value exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata value to 500 characters or less\n2. Store longer data externally and reference it with a shorter identifier\n3. Consider compressing or encoding the data if appropriate\n\n**Limits:**\n- Maximum value length: 500 characters","travel_rules_field_missing":"This error occurs when required travel rule fields are missing from the transfer request.\n\n**Steps to resolve:**\n1. Include the `travelRule` object in your transfer request\n2. Supply the required missing fields prompted by the error message\n3. Review the travel rule requirements for your jurisdiction\n\nNote: Required fields may vary by region.","asset_mismatch":"This error occurs when the assets specified in the transfer are incompatible or don't match expected values.\n\n**Steps to resolve:**\n1. Ensure the `asset` field matches either the source or target asset\n2. Verify that the source and target assets are compatible for conversion (if different)\n3. Check that the asset symbols are correctly specified\n\n**Common causes:**\n- Transfer asset doesn't match source or target\n- Attempting an unsupported asset conversion\n- Typo in asset symbols","order_quote_expired":"This error occurs when attempting to execute an order whose quote has expired.\n\n**Steps to resolve:**\n1. Create a new order with `execute: false` to get an updated quote.\n2. Execute the new order before the quote expires (check the `expiresAt` field).\n3. Alternatively, create a new order with `execute: true` to skip the quote step and execute immediately.","order_already_filled":"This error occurs when attempting to cancel or modify an order that has already been filled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. A filled order cannot be canceled or re-executed.","order_already_canceled":"This error occurs when attempting to cancel or execute an order that has already been canceled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. Create a new order if you still want to trade.","account_not_ready":"This error occurs when an operation is attempted on an account that is still being provisioned.\n\n**Steps to resolve:**\n1. Wait a few moments and retry the request\n2. If the error persists, the account may still be completing setup — retry with exponential backoff","insufficient_liquidity":"This error occurs when no swap route is available for the requested token pair or amount.\n\n**Steps to resolve:**\n1. Try a smaller `fromAmount` — large orders may exceed available liquidity\n2. Try a different token pair\n3. Retry after a short delay; liquidity conditions change with market activity","insufficient_allowance":"This error occurs when the taker has not approved the Permit2 contract to spend the `fromToken`\non their behalf. ERC-20 swaps require a Permit2 allowance. Native ETH swaps do not.\n\n**Steps to resolve:**\n1. Submit an ERC-20 `approve` transaction on the `fromToken` contract, granting the Permit2\n contract (`0x000000000022D473030F116dDEE9F6B43aC78BA3`) an allowance of at least `fromAmount`\n2. Wait for the approval transaction to be confirmed on-chain\n3. Retry the swap\n\n**Example:**\n```typescript lines wrap\n// Approve Permit2 to spend fromToken\nawait walletClient.writeContract({\n address: fromToken,\n abi: erc20Abi,\n functionName: \"approve\",\n args: [\"0x000000000022D473030F116dDEE9F6B43aC78BA3\", fromAmount],\n});\n```","transaction_simulation_failed":"This error occurs when the pre-broadcast simulation of the swap transaction predicted a revert.\nNo transaction was submitted and no gas was spent.\n\n**Common causes:**\n- The on-chain price moved past the `slippageBps` tolerance between the price estimate and execution\n- Taker balance changed between the price estimate and execution\n\n**Steps to resolve:**\n1. Retry immediately — prices change quickly and a new quote may succeed\n2. Increase `slippageBps` if retries continue to fail (e.g. from 100 to 200)\n3. For large swaps, consider splitting into smaller amounts to reduce price impact","delegation_not_found":"This error occurs when a delegated signing operation is attempted but no active\ndelegation grant exists for the end user (or account).\n\n**Steps to resolve:**\n1. Create a delegation grant using `createDelegationForEndUser` (user-scoped)\n or `createDelegationForEndUserAccount` (account-scoped) before calling\n the signing or sending operation\n2. If you previously created a grant, it may have expired or been revoked —\n in those cases you would receive a `delegation_expired` or\n `delegation_revoked` error instead\n3. For account-scoped grants, verify the address in the request matches the\n granted address (EVM addresses are compared case-insensitively;\n Solana addresses must match exactly)","delegation_expired":"This error occurs when the delegation grant used for signing has expired.\nDelegation grants have a limited lifetime set at creation.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Retry the signing operation with the new grant active\n3. Consider creating grants with a longer TTL if expiry is frequent","delegation_revoked":"This error occurs when the delegation grant has been explicitly revoked.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Confirm with the end user before recreating, since revocation is\n typically intentional","delegation_not_authorized":"This error occurs when a delegation grant exists but does not authorize the\nrequested operation.\n\n**Steps to resolve:**\n1. For account-scoped grants, verify the signing address matches the address\n the grant was created for\n2. Check that the operation is permitted for delegated signing on your project\n3. Create a grant with the correct scope if needed","delegation_not_enabled":"This error occurs when delegated signing is attempted on a project that has\nnot enabled the feature.\n\n**Steps to resolve:**\n1. Enable delegated signing in your project configuration via the CDP Portal\n2. Contact support if you believe delegated signing should already be enabled\n for your project","network_mismatch":"This error occurs when the requested operation specifies a network on which the\ntarget resource is not deployed or not available.\n\n**Steps to resolve:**\n1. Use the network the resource was originally created or deployed on\n2. Check the resource metadata to confirm the correct network\n\n**Common causes:**\n- Specifying `base` for a resource that only exists on `base-sepolia` (or vice versa)\n- Cross-network operation attempted on a resource scoped to a single network","already_enabled":"This error occurs when the requested operation cannot be performed because\nthe capability is already in the desired state.\n\n**Steps to resolve:**\n1. Check the current state of the resource before attempting the operation\n2. No action is needed if the resource is already in the desired state\n\n**Common causes:**\n- Calling an enable endpoint on a resource that already has the feature enabled"},"isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"The error message.","type":"string","example":"Unable to create EVM account","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"},"correlationId":{"description":"A unique identifier for the request that generated the error. This can be used to help debug issues with the API.","type":"string","example":"41deb8d59a9dc9a7-IAD","uniqueKey":"correlationId","typeLabel":"string"},"errorLink":{"type":"string","description":"A link to the corresponding error documentation.","format":"uri","maxLength":2048,"minLength":11,"pattern":"^https?://.*$","example":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request","uniqueKey":"errorLink","typeLabel":"string\u003curi>"},"unauthorizedCapabilities":{"description":"The capability code(s) that were not authorized for the customer on\nthis request. Present only when `errorType` is\n`customer_not_authorized`; absent for every other error type.\n\nUse this list to render onboarding UX for the listed capabilities, or\nfetch `GET /v2/customers/{customerId}` and inspect each entry's\n`status` / `requirements` to discover what (if anything) can be\nsubmitted to resolve the block.\n","type":"array","items":{"type":"string","description":"The name of a capability. Capabilities represent granular functional permissions\nthat determine what actions a customer can perform. Each capability must be\nexplicitly requested before use.\n","enum":["custodyCrypto","custodyFiat","custodyStablecoin","tradeCrypto","tradeStablecoin","transferCrypto","transferFiat","transferStablecoin"],"example":"custodyCrypto","uniqueKey":"unauthorizedCapabilities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"unauthorizedCapabilities","typeLabel":"enum\u003cstring>[]"}},"required":["errorType","errorMessage"],"example":{"errorType":"invalid_request","errorMessage":"Invalid request.","correlationId":"41deb8d59a9dc9a7-IAD","errorLink":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request"},"uniqueKey":"","typeLabel":"object"},"examples":{"internal_server_error":{"title":"internal_server_error","value":{"errorType":"internal_server_error","errorMessage":"An internal server error occurred. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"6df2094b-1283-4aa0-9c77-aed9faa31d11":{"description":"Bad gateway.","content":{"application/json":{"schema":{"description":"An error response including the code for the type of error and a human-readable message describing the error.","type":"object","properties":{"errorType":{"description":"The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.","type":"string","example":"invalid_request","enum":["already_exists","authorization_expired","bad_gateway","capture_expired","client_closed_request","customer_not_authorized","endpoint_unavailable","faucet_limit_exceeded","forbidden","idempotency_error","internal_server_error","invalid_request","invalid_sql_query","invalid_signature","malformed_transaction","not_found","payment_method_required","payment_required","settlement_failed","rate_limit_exceeded","request_canceled","service_unavailable","timed_out","unauthorized","unsupported_tos_language","policy_violation","policy_in_use","account_limit_exceeded","network_not_tradable","guest_permission_denied","guest_region_forbidden","guest_transaction_limit","guest_transaction_count","phone_number_verification_expired","document_verification_failed","recipient_allowlist_violation","recipient_allowlist_pending","refund_expired","travel_rules_recipient_violation","source_account_invalid","target_account_invalid","source_account_not_found","target_account_not_found","source_asset_not_supported","target_asset_not_supported","target_email_invalid","target_onchain_address_invalid","transfer_amount_invalid","transfer_asset_not_supported","transfer_quote_expired","insufficient_balance","metadata_too_many_entries","metadata_key_too_long","metadata_value_too_long","travel_rules_field_missing","asset_mismatch","mfa_already_enrolled","mfa_invalid_code","mfa_flow_expired","mfa_required","mfa_not_enrolled","order_quote_expired","order_already_filled","order_already_canceled","account_not_ready","insufficient_liquidity","insufficient_allowance","transaction_simulation_failed","delegation_not_found","delegation_expired","delegation_revoked","delegation_not_authorized","delegation_not_enabled","network_mismatch","already_enabled"],"x-error-instructions":{"already_exists":"This error occurs when trying to create a resource that already exists.\n\n**Steps to resolve:**\n1. Check if the resource exists before creation\n2. Use GET endpoints to verify resource state\n3. Use unique identifiers/names for resources","authorization_expired":"Returned when an authorization attempt is made after the payment session's authorization deadline has passed. Create a new payment session with a later authorization deadline.","bad_gateway":"This error occurs when the CDP API is unable to connect to the backend service.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","capture_expired":"Returned when a capture attempt is made after the payment session's capture deadline has passed. The payment session can no longer be captured.","client_closed_request":"This error occurs when the client closes the connection before the server can send a response.\n\n**Common causes:**\n- The client timed out waiting for the server response\n- The client application was terminated during a pending request\n- Network interruption caused the client connection to drop\n\n**Steps to resolve:**\n1. Increase client-side timeout settings if applicable\n2. Implement retry logic with exponential backoff for long-running queries\n3. Consider optimizing the request to reduce server processing time","endpoint_unavailable":"This error occurs when a specific endpoint has been temporarily disabled by an operator (e.g. a kill switch). The CDP API as a whole is still healthy; only this endpoint is unavailable. Distinct from `service_unavailable`, which indicates the API itself is down.\n\nRe-enabling is a manual operator action, so the endpoint may remain unavailable for an extended period.\n\n**Steps to resolve:**\n1. Check the [CDP status page](https://cdpstatus.coinbase.com/) for an active incident.\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details","faucet_limit_exceeded":"This error occurs when you've exceeded the faucet request limits.\n\n**Steps to resolve:**\n1. Wait for the time window to reset\n2. Use funds more efficiently in your testing\n\nFor more information on faucet limits, please visit the [EVM Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-evm-test-networks) or the [Solana Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-solana-devnet).","customer_not_authorized":"This error occurs when the customer is not currently authorized for one\nor more capabilities required to perform the requested action. This can\nhappen at any point in the customer's lifecycle and may or may not be\nresolvable by the developer.\n\nThe response includes an `unauthorizedCapabilities` field listing the\ncapability code(s) that were not authorized on this request.\n\n**Steps to resolve:**\n1. Fetch the customer with `GET /v2/customers/{customerId}` and inspect\n the `requirements` field. If `requirements.due` is non-empty, submit\n the listed fields via `POST /v2/customers/{customerId}` and retry.\n2. If `requirements.due` is empty, no further action is available — the\n customer is not currently eligible for this action.","forbidden":"This error occurs when you don't have permission to access the resource.\n\n**Steps to resolve:**\n1. Verify your permissions to access the resource\n2. Ensure that you are the owner of the requested resource","idempotency_error":"This error occurs when an idempotency key is reused with different parameters.\n\n**Steps to resolve:**\n1. Generate a new UUID v4 for each unique request\n2. Only reuse idempotency keys for exact request duplicates\n3. Track used keys within your application\n\n**Example idempotency key implementation:**\n```typescript lines wrap\nimport { v4 as uuidv4 } from 'uuid';\n\nfunction createIdempotencyKey() {\n return uuidv4();\n}\n```","internal_server_error":"This indicates an unexpected error that occurred on the CDP servers.\n\n**Important**: If you encounter this error, please note that your operation's status should be treated as unknown by your application, as it could have been a success within the CDP back-end.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - Your correlation ID\n - Timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","invalid_request":"This error occurs when the request is malformed or contains invalid data, including issues with the request body, query parameters, path parameters, or headers.\n\n**Steps to resolve:**\n1. Check all required fields and parameters are present\n2. Ensure request body (if applicable) follows the correct schema\n3. Verify all parameter formats match the API specification:\n - Query parameters\n - Path parameters\n - Request headers\n4. Validate any addresses, IDs, or other formatted strings meet requirements\n\n**Common validation issues:**\n- Missing required parameters\n- Invalid parameter types or formats\n- Malformed JSON in request body\n- Invalid enum values\n\n#### Transfer-specific validation errors\n\nThe following transfer validation scenarios return `errorType: \"invalid_request\"`. Use the `errorMessage` field to identify the specific case.\n\n| Scenario | Example `errorMessage` |\n|----------|----------------------|\n| Source account ID is malformed | `\"source is invalid.\"` |\n| Target account ID is malformed | `\"target is invalid.\"` |\n| Source account does not exist | `\"source not found.\"` |\n| Target account does not exist | `\"target not found.\"` |\n| Asset not supported at source | `\"source is not supported.\"` |\n| Asset not supported at target | `\"target is not supported.\"` |\n| Target email address is malformed | `\"target has an invalid email format.\"` |\n| Target onchain address is invalid for network | `\"The recipient address is invalid for the selected network.\"` |\n| Asset not supported for this transfer route | `\"Transfer asset pair is not supported.\"` |\n| Insufficient balance | `\"Insufficient funds to complete this transfer.\"` |\n| Asset mismatch between request fields | `\"Currency mismatch in request.\"` |\n| Metadata has too many keys | `\"Metadata has too many keys. Up to 10 key/value pairs are permitted.\"` |\n| Metadata key exceeds length limit | `\"Metadata key is too long. Each key must be less than or equal to 40 characters.\"` |\n| Metadata value exceeds length limit | `\"Metadata value is too long. Each value must be less than or equal to 500 characters.\"` |\n| Travel rule fields missing | `\"Travel rule information is incomplete. Missing fields: ...\"` |\n| Recipient address not in account allowlist | `\"Your coinbase account allowlist does not include this address. Please update your allowlist at https://www.coinbase.com/settings/allowlist\"` |","invalid_sql_query":"This error occurs when the SQL query is invalid or not allowed.\n\n**Common causes:**\n- Using non-SELECT SQL statements (INSERT, UPDATE, DELETE, etc.)\n- Invalid table or column names\n- Syntax errors in SQL query\n- Query exceeds character limit\n- Too many JOIN operations","invalid_signature":"This error occurs when the signature provided for the given user operation is invalid.\n\n**Steps to resolve:**\n1. Verify the signature was generated by the correct owner account\n2. Ensure the signature corresponds to the exact user operation hash\n3. Check that the signature format matches the expected format\n4. Confirm you're using the correct network for the Smart Account\n\n**Common causes:**\n- Using wrong owner account to sign\n- Signing modified/incorrect user operation data\n- Malformed signature encoding\n- Network mismatch between signature and broadcast","malformed_transaction":"This error occurs when the transaction data provided is not properly formatted or is invalid.\n\n**Steps to resolve:**\n1. Verify transaction encoding:\n - **EVM networks**: Check RLP encoding is correct\n - **Solana**: Validate base64 encoding\n2. Ensure all required transaction fields are present\n3. Validate transaction parameters are within acceptable ranges\n4. Check that the transaction type is supported on the target network (see our [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) page for more details)\n\n**Common causes:**\n- Invalid hex encoding for EVM transactions\n- Missing required transaction fields\n- Incorrect parameter formats\n- Unsupported transaction types\n- Network-specific transaction format mismatches","not_found":"This error occurs when the resource specified in your request doesn't exist or you don't have access to it.\n\n**Steps to resolve:**\n1. Verify the resource ID/address/account exists\n2. Check your permissions to access the resource\n3. Ensure you're using the correct network/environment\n4. Confirm the resource hasn't been deleted\n\n**Common causes:**\n- Mistyped addresses\n- Accessing resources from the wrong CDP project\n- Resource was deleted or hasn't been created yet","payment_method_required":"This error occurs when a payment method is required to complete the requested operation but none is configured or available.\n\n**Steps to resolve:**\n1. Add a valid payment method to your account using the [CDP Portal](https://portal.cdp.coinbase.com)\n2. Ensure your payment method is valid and not expired\n\n**Common causes:**\n- No payment method configured on the account\n- Payment method is expired","payment_required":"This error occurs when an x402 payment is required to access the requested resource.\n\n**Steps to resolve:**\n1. Include a valid x402 payment header in your request\n2. Ensure the payment meets the resource's pricing requirements","settlement_failed":"This error occurs when an x402 payment was verified but settlement on-chain failed.\n\n**Steps to resolve:**\n1. Retry the request with a new payment\n2. Ensure the payment asset has sufficient balance for settlement","rate_limit_exceeded":"This error occurs when you've exceeded the API rate limits.\n\n**Steps to resolve:**\n1. Implement exponential backoff\n2. Cache responses where possible\n3. Wait for rate limit window to reset\n\n**Best practices:**\n```typescript lines wrap\nasync function withRetry(fn: () => Promise\u003cany>) {\n let delay = 1000;\n while (true) {\n try {\n return await fn();\n } catch (e) {\n if (e.errorType === \"rate_limit_exceeded\") {\n await sleep(delay);\n delay *= 2;\n continue;\n }\n throw e;\n }\n }\n}\n```","request_canceled":"This error occurs when the client cancels an in-progress request before it completes.\n\n**Steps to resolve:**\n1. Check client-side timeout configurations\n2. Review request cancellation logic in your code\n3. Consider increasing timeout thresholds for long-running operations\n4. Implement request tracking to identify premature cancellations\n\n**Best practices:**\n```typescript lines wrap\nasync function withTimeout\u003cT>(promise: Promise\u003cT>, timeoutMs: number): Promise\u003cT> {\n const timeout = new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(\"Operation timed out\"));\n }, timeoutMs);\n });\n\n try {\n return await Promise.race([promise, timeout]);\n } catch (error) {\n // Handle timeout or cancellation\n throw error;\n }\n}\n```","service_unavailable":"This error occurs when the CDP API is temporarily unable to handle requests due to maintenance or high load.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","timed_out":"This error occurs when a request exceeds the maximum allowed processing time.\n\n**Steps to resolve:**\n1. Break down large requests into smaller chunks (if applicable)\n2. Implement retry logic with exponential backoff\n3. Use streaming endpoints for large data sets\n\n**Example retry implementation:**\n```typescript lines wrap\nasync function withRetryAndTimeout\u003cT>(\n operation: () => Promise\u003cT>,\n maxRetries = 3,\n timeout = 30000,\n): Promise\u003cT> {\n let attempts = 0;\n while (attempts \u003c maxRetries) {\n try {\n return await Promise.race([\n operation(),\n new Promise((_, reject) =>\n setTimeout(() => reject(new Error(\"Timeout\")), timeout)\n ),\n ]);\n } catch (error) {\n attempts++;\n if (attempts === maxRetries) throw error;\n // Exponential backoff\n await new Promise(resolve =>\n setTimeout(resolve, Math.pow(2, attempts) * 1000)\n );\n }\n }\n throw new Error(\"Max retries exceeded\");\n}\n```","unauthorized":"This error occurs when authentication fails.\n\n**Steps to resolve:**\n1. Verify your CDP API credentials:\n - Check that your API key is valid\n - Check that your Wallet Secret is properly configured\n2. Validate JWT token:\n - Not expired\n - Properly signed\n - Contains required claims\n3. Check request headers:\n - Authorization header present\n - X-Wallet-Auth header included when required\n\n**Security note:** Never share your Wallet Secret or API keys.","unsupported_tos_language":"A submitted Terms of Service acceptance used a `language` that is not published for the referenced `versionId`.\n\n**Steps to resolve:**\n1. Read `Customer.requirements.tos.tosVersions[]` and find the entry whose `versionId` matches your acceptance.\n2. Choose a `language` from that entry's `languages` list (BCP 47 tags).\n3. Retry with `tosAcceptances[].language` set to a supported tag.","policy_in_use":"This error occurs when trying to delete a Policy that is currently in use by at least one project or account.\n\n**Steps to resolve:**\n1. Update project or accounts to remove references to the Policy in question.\n2. Retry your delete request.","network_not_tradable":"This error occurs when the selected asset cannot be purchased on the selected network in the user's location.\n\n**Steps to resolve:**\n1. Verify the asset is tradable on the selected network\n2. Check the user's location to ensure it is allowed to purchase the asset on the selected network\n\n**Common causes:**\n- Users in NY are not allowed to purchase USDC on any network other than Ethereum","guest_permission_denied":"This error occurs when the user is not allowed to complete onramp transactions as a guest.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_region_forbidden":"This error occurs when guest onramp transactions are not allowed in the user's region.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_transaction_limit":"This error occurs when the user has reached the weekly guest onramp transaction limit.\n\n**Steps to resolve:**\n1. Inform the user they have reached their weekly limit and will have to wait until next week.","guest_transaction_count":"This error occurs when the user has reached the lifetime guest onramp transaction count limit.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","phone_number_verification_expired":"This error occurs when the user's phone number verification has expired. Use of guest Onramp requires the user's\nphone number to be verified every 60 days.\n\n**Steps to resolve:**\n1. Re-verify the user's phone number via OTP.\n2. Retry the request with the phoneNumberVerifiedAt field set to new verification timestamp.","document_verification_failed":"This error occurs when the user has not verified their identity for their coinbase.com account.\n**Steps to resolve:**\n1. Verify your coinbase account identity with valid documents at https://www.coinbase.com/settings/account-levels.","recipient_allowlist_violation":"This error occurs when the user is not allowed to receive funds at this address, according to their coinbase account allowlist.\n**Steps to resolve:**\n1. Either disable the allowlist or add the wallet address at https://www.coinbase.com/settings/allowlist\n2. Wait approximately 2 days for updates to take effect.","recipient_allowlist_pending":"This error occurs when the user is not allowed to receive funds at this address, because changes to their coinbase account allowlist are pending.\n**Steps to resolve:**\n1. Wait approximately 2 days for updates to take effect.","refund_expired":"Returned when a refund attempt is made after the payment session's refund deadline has passed. The payment session can no longer be refunded.","travel_rules_recipient_violation":"This error occurs when the user is not allowed to receive funds at this address, because it violates travel rules.\n**Steps to resolve:**\n1. Ensure your desired transfer is not blocked by local travel regulations.","mfa_already_enrolled":"This error occurs when attempting to enroll in an MFA method that the user has already enrolled in.\n\n**Steps to resolve:**\n1. Check if the user is already enrolled in the MFA method before initiating enrollment\n2. To update or reset MFA, remove the existing enrollment first (if supported)\n3. Use a different MFA method if multiple options are available","mfa_invalid_code":"This error occurs when the MFA code provided is incorrect or has already been used.\n\n**Steps to resolve:**\n1. Verify the user entered the correct code from their authenticator app\n2. Ensure the code is current (TOTP codes expire after 30 seconds)\n3. Check that the device time is synchronized correctly\n4. Ask the user to generate a new code and try again\n\n**Common causes:**\n- Typing errors in the 6-digit code\n- Using an expired TOTP code\n- Device clock drift on user's authenticator app\n- Attempting to reuse a previously submitted code","mfa_flow_expired":"This error occurs when the MFA enrollment or verification session has expired.\n\n**Steps to resolve:**\n1. Restart the MFA enrollment or verification flow\n2. Complete the flow within the allowed time window (typically 5 minutes)\n3. Ensure the user doesn't leave the flow idle for extended periods\n\n**Note:** MFA sessions expire automatically for security purposes.","mfa_required":"This error occurs when attempting to perform a sensitive operation that requires MFA verification, but the user has not completed MFA verification.\n\n**Steps to resolve:**\n1. Initiate the MFA verification flow using the `/mfa/verify/{mfaMethod}/init` endpoint\n2. Prompt the user to enter their MFA code\n3. Submit the verification using the `/mfa/verify/{mfaMethod}/submit` endpoint\n4. Use the returned access token with MFA claim for the sensitive operation\n5. Retry the original request with the new MFA-verified token\n\n**Operations requiring MFA:**\n- Transactions Sign/Send\n- Key export\n- Account management actions (when configured)","mfa_not_enrolled":"This error occurs when attempting to verify MFA for a user who has not enrolled in any MFA method.\n\n**Steps to resolve:**\n1. Check if the user has enrolled in MFA before attempting verification\n2. Guide the user through MFA enrollment first using the `/mfa/enroll/{mfaMethod}/init` endpoint\n3. Complete enrollment before requiring MFA verification","source_account_invalid":"This error occurs when the source account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account ID belongs to your CDP entity\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","target_account_invalid":"This error occurs when the target account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account exists and can receive funds\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","source_account_not_found":"This error occurs when the source account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","target_account_not_found":"This error occurs when the target account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","source_asset_not_supported":"This error occurs when the asset specified in the transfer source is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the source account type\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n\n**Common causes:**\n- Unsupported asset for the transfer route\n- Incorrect asset symbol","target_asset_not_supported":"This error occurs when the asset specified in the transfer target is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the target\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n3. Ensure the target can receive this asset type\n\n**Common causes:**\n- Asset not supported by the target\n- Unsupported conversion between source and target assets","target_email_invalid":"This error occurs when the email address specified as the transfer target is invalid.\n\n**Steps to resolve:**\n1. Verify the email address format is valid (e.g., `user@example.com`)\n2. Check for typos in the email address\n3. Ensure the email domain is valid\n\n**Common causes:**\n- Invalid email format\n- Missing @ symbol or domain\n- Typo in the email address","target_onchain_address_invalid":"This error occurs when the onchain address specified as the transfer target is invalid for the specified network.\n\n**Steps to resolve:**\n1. Ensure the network is supported for the transfer type\n2. Verify the address format matches the target network\n3. Ensure you haven't mixed up addresses from different networks\n\n**Common causes:**\n- Network not supported for the transfer type\n- Address format doesn't match network\n- Address from a different blockchain network","transfer_amount_invalid":"This error occurs when the transfer amount is invalid.\n\n**Steps to resolve:**\n1. Ensure the amount is a positive number and greater than $1 USD equivalent amount\n2. Verify the amount format is a valid decimal string (e.g., `\"100.50\"`)\n3. Check the number of decimal places for the asset\n\n**Common causes:**\n- Zero or negative amount\n- Too many decimal places for the asset\n- Amount below minimum threshold ($1 USD equivalent amount)","transfer_asset_not_supported":"This error occurs when the asset specified for the transfer is not supported.\n\n**Steps to resolve:**\n1. Check the list of supported assets for transfers\n2. Verify the asset symbol is correctly specified\n3. Ensure the asset is supported for the transfer route (source → target)\n\n**Common causes:**\n- Asset not supported for transfers\n- Incorrect asset symbol","transfer_quote_expired":"This error occurs when the transfer quote has expired. Quotes are valid for a limited time.\n\n**Steps to resolve:**\n1. Create a new transfer to obtain a fresh quote\n2. Execute the transfer promptly after creation\n\n**Common causes:**\n- Too much time elapsed between creating and executing the transfer","insufficient_balance":"This error occurs when the source account does not have enough funds to complete the transfer including fees.\n\n**Steps to resolve:**\n1. Check the source account balance\n2. Ensure the balance covers both the transfer amount and any fees\n3. Consider using `amountType: \"source\"` to transfer the maximum available amount minus fees\n4. Add funds to the source account if needed\n\n**Common causes:**\n- Transfer amount exceeds available balance\n- Not accounting for transfer fees\n- Pending transactions reducing available balance","metadata_too_many_entries":"This error occurs when the transfer metadata contains more entries than allowed.\n\n**Steps to resolve:**\n1. Reduce the number of metadata entries (maximum 10 allowed)\n2. Consolidate related data into fewer keys\n3. Store additional data externally and reference it with a single metadata entry\n\n**Limits:**\n- Maximum entries: 10","metadata_key_too_long":"This error occurs when a metadata key exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata key to 40 characters or less\n2. Use abbreviations or shorter naming conventions\n3. Consider using a key-value structure where the value contains the longer identifier\n\n**Limits:**\n- Maximum key length: 40 characters","metadata_value_too_long":"This error occurs when a metadata value exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata value to 500 characters or less\n2. Store longer data externally and reference it with a shorter identifier\n3. Consider compressing or encoding the data if appropriate\n\n**Limits:**\n- Maximum value length: 500 characters","travel_rules_field_missing":"This error occurs when required travel rule fields are missing from the transfer request.\n\n**Steps to resolve:**\n1. Include the `travelRule` object in your transfer request\n2. Supply the required missing fields prompted by the error message\n3. Review the travel rule requirements for your jurisdiction\n\nNote: Required fields may vary by region.","asset_mismatch":"This error occurs when the assets specified in the transfer are incompatible or don't match expected values.\n\n**Steps to resolve:**\n1. Ensure the `asset` field matches either the source or target asset\n2. Verify that the source and target assets are compatible for conversion (if different)\n3. Check that the asset symbols are correctly specified\n\n**Common causes:**\n- Transfer asset doesn't match source or target\n- Attempting an unsupported asset conversion\n- Typo in asset symbols","order_quote_expired":"This error occurs when attempting to execute an order whose quote has expired.\n\n**Steps to resolve:**\n1. Create a new order with `execute: false` to get an updated quote.\n2. Execute the new order before the quote expires (check the `expiresAt` field).\n3. Alternatively, create a new order with `execute: true` to skip the quote step and execute immediately.","order_already_filled":"This error occurs when attempting to cancel or modify an order that has already been filled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. A filled order cannot be canceled or re-executed.","order_already_canceled":"This error occurs when attempting to cancel or execute an order that has already been canceled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. Create a new order if you still want to trade.","account_not_ready":"This error occurs when an operation is attempted on an account that is still being provisioned.\n\n**Steps to resolve:**\n1. Wait a few moments and retry the request\n2. If the error persists, the account may still be completing setup — retry with exponential backoff","insufficient_liquidity":"This error occurs when no swap route is available for the requested token pair or amount.\n\n**Steps to resolve:**\n1. Try a smaller `fromAmount` — large orders may exceed available liquidity\n2. Try a different token pair\n3. Retry after a short delay; liquidity conditions change with market activity","insufficient_allowance":"This error occurs when the taker has not approved the Permit2 contract to spend the `fromToken`\non their behalf. ERC-20 swaps require a Permit2 allowance. Native ETH swaps do not.\n\n**Steps to resolve:**\n1. Submit an ERC-20 `approve` transaction on the `fromToken` contract, granting the Permit2\n contract (`0x000000000022D473030F116dDEE9F6B43aC78BA3`) an allowance of at least `fromAmount`\n2. Wait for the approval transaction to be confirmed on-chain\n3. Retry the swap\n\n**Example:**\n```typescript lines wrap\n// Approve Permit2 to spend fromToken\nawait walletClient.writeContract({\n address: fromToken,\n abi: erc20Abi,\n functionName: \"approve\",\n args: [\"0x000000000022D473030F116dDEE9F6B43aC78BA3\", fromAmount],\n});\n```","transaction_simulation_failed":"This error occurs when the pre-broadcast simulation of the swap transaction predicted a revert.\nNo transaction was submitted and no gas was spent.\n\n**Common causes:**\n- The on-chain price moved past the `slippageBps` tolerance between the price estimate and execution\n- Taker balance changed between the price estimate and execution\n\n**Steps to resolve:**\n1. Retry immediately — prices change quickly and a new quote may succeed\n2. Increase `slippageBps` if retries continue to fail (e.g. from 100 to 200)\n3. For large swaps, consider splitting into smaller amounts to reduce price impact","delegation_not_found":"This error occurs when a delegated signing operation is attempted but no active\ndelegation grant exists for the end user (or account).\n\n**Steps to resolve:**\n1. Create a delegation grant using `createDelegationForEndUser` (user-scoped)\n or `createDelegationForEndUserAccount` (account-scoped) before calling\n the signing or sending operation\n2. If you previously created a grant, it may have expired or been revoked —\n in those cases you would receive a `delegation_expired` or\n `delegation_revoked` error instead\n3. For account-scoped grants, verify the address in the request matches the\n granted address (EVM addresses are compared case-insensitively;\n Solana addresses must match exactly)","delegation_expired":"This error occurs when the delegation grant used for signing has expired.\nDelegation grants have a limited lifetime set at creation.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Retry the signing operation with the new grant active\n3. Consider creating grants with a longer TTL if expiry is frequent","delegation_revoked":"This error occurs when the delegation grant has been explicitly revoked.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Confirm with the end user before recreating, since revocation is\n typically intentional","delegation_not_authorized":"This error occurs when a delegation grant exists but does not authorize the\nrequested operation.\n\n**Steps to resolve:**\n1. For account-scoped grants, verify the signing address matches the address\n the grant was created for\n2. Check that the operation is permitted for delegated signing on your project\n3. Create a grant with the correct scope if needed","delegation_not_enabled":"This error occurs when delegated signing is attempted on a project that has\nnot enabled the feature.\n\n**Steps to resolve:**\n1. Enable delegated signing in your project configuration via the CDP Portal\n2. Contact support if you believe delegated signing should already be enabled\n for your project","network_mismatch":"This error occurs when the requested operation specifies a network on which the\ntarget resource is not deployed or not available.\n\n**Steps to resolve:**\n1. Use the network the resource was originally created or deployed on\n2. Check the resource metadata to confirm the correct network\n\n**Common causes:**\n- Specifying `base` for a resource that only exists on `base-sepolia` (or vice versa)\n- Cross-network operation attempted on a resource scoped to a single network","already_enabled":"This error occurs when the requested operation cannot be performed because\nthe capability is already in the desired state.\n\n**Steps to resolve:**\n1. Check the current state of the resource before attempting the operation\n2. No action is needed if the resource is already in the desired state\n\n**Common causes:**\n- Calling an enable endpoint on a resource that already has the feature enabled"},"isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"The error message.","type":"string","example":"Unable to create EVM account","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"},"correlationId":{"description":"A unique identifier for the request that generated the error. This can be used to help debug issues with the API.","type":"string","example":"41deb8d59a9dc9a7-IAD","uniqueKey":"correlationId","typeLabel":"string"},"errorLink":{"type":"string","description":"A link to the corresponding error documentation.","format":"uri","maxLength":2048,"minLength":11,"pattern":"^https?://.*$","example":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request","uniqueKey":"errorLink","typeLabel":"string\u003curi>"},"unauthorizedCapabilities":{"description":"The capability code(s) that were not authorized for the customer on\nthis request. Present only when `errorType` is\n`customer_not_authorized`; absent for every other error type.\n\nUse this list to render onboarding UX for the listed capabilities, or\nfetch `GET /v2/customers/{customerId}` and inspect each entry's\n`status` / `requirements` to discover what (if anything) can be\nsubmitted to resolve the block.\n","type":"array","items":{"type":"string","description":"The name of a capability. Capabilities represent granular functional permissions\nthat determine what actions a customer can perform. Each capability must be\nexplicitly requested before use.\n","enum":["custodyCrypto","custodyFiat","custodyStablecoin","tradeCrypto","tradeStablecoin","transferCrypto","transferFiat","transferStablecoin"],"example":"custodyCrypto","uniqueKey":"unauthorizedCapabilities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"unauthorizedCapabilities","typeLabel":"enum\u003cstring>[]"}},"required":["errorType","errorMessage"],"example":{"errorType":"invalid_request","errorMessage":"Invalid request.","correlationId":"41deb8d59a9dc9a7-IAD","errorLink":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request"},"uniqueKey":"","typeLabel":"object"},"examples":{"bad_gateway":{"title":"bad_gateway","value":{"errorType":"bad_gateway","errorMessage":"Bad gateway. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"57e46d27-756f-436a-a806-97be4268a333":{"description":"Service unavailable.","content":{"application/json":{"schema":{"description":"An error response including the code for the type of error and a human-readable message describing the error.","type":"object","properties":{"errorType":{"description":"The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.","type":"string","example":"invalid_request","enum":["already_exists","authorization_expired","bad_gateway","capture_expired","client_closed_request","customer_not_authorized","endpoint_unavailable","faucet_limit_exceeded","forbidden","idempotency_error","internal_server_error","invalid_request","invalid_sql_query","invalid_signature","malformed_transaction","not_found","payment_method_required","payment_required","settlement_failed","rate_limit_exceeded","request_canceled","service_unavailable","timed_out","unauthorized","unsupported_tos_language","policy_violation","policy_in_use","account_limit_exceeded","network_not_tradable","guest_permission_denied","guest_region_forbidden","guest_transaction_limit","guest_transaction_count","phone_number_verification_expired","document_verification_failed","recipient_allowlist_violation","recipient_allowlist_pending","refund_expired","travel_rules_recipient_violation","source_account_invalid","target_account_invalid","source_account_not_found","target_account_not_found","source_asset_not_supported","target_asset_not_supported","target_email_invalid","target_onchain_address_invalid","transfer_amount_invalid","transfer_asset_not_supported","transfer_quote_expired","insufficient_balance","metadata_too_many_entries","metadata_key_too_long","metadata_value_too_long","travel_rules_field_missing","asset_mismatch","mfa_already_enrolled","mfa_invalid_code","mfa_flow_expired","mfa_required","mfa_not_enrolled","order_quote_expired","order_already_filled","order_already_canceled","account_not_ready","insufficient_liquidity","insufficient_allowance","transaction_simulation_failed","delegation_not_found","delegation_expired","delegation_revoked","delegation_not_authorized","delegation_not_enabled","network_mismatch","already_enabled"],"x-error-instructions":{"already_exists":"This error occurs when trying to create a resource that already exists.\n\n**Steps to resolve:**\n1. Check if the resource exists before creation\n2. Use GET endpoints to verify resource state\n3. Use unique identifiers/names for resources","authorization_expired":"Returned when an authorization attempt is made after the payment session's authorization deadline has passed. Create a new payment session with a later authorization deadline.","bad_gateway":"This error occurs when the CDP API is unable to connect to the backend service.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","capture_expired":"Returned when a capture attempt is made after the payment session's capture deadline has passed. The payment session can no longer be captured.","client_closed_request":"This error occurs when the client closes the connection before the server can send a response.\n\n**Common causes:**\n- The client timed out waiting for the server response\n- The client application was terminated during a pending request\n- Network interruption caused the client connection to drop\n\n**Steps to resolve:**\n1. Increase client-side timeout settings if applicable\n2. Implement retry logic with exponential backoff for long-running queries\n3. Consider optimizing the request to reduce server processing time","endpoint_unavailable":"This error occurs when a specific endpoint has been temporarily disabled by an operator (e.g. a kill switch). The CDP API as a whole is still healthy; only this endpoint is unavailable. Distinct from `service_unavailable`, which indicates the API itself is down.\n\nRe-enabling is a manual operator action, so the endpoint may remain unavailable for an extended period.\n\n**Steps to resolve:**\n1. Check the [CDP status page](https://cdpstatus.coinbase.com/) for an active incident.\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details","faucet_limit_exceeded":"This error occurs when you've exceeded the faucet request limits.\n\n**Steps to resolve:**\n1. Wait for the time window to reset\n2. Use funds more efficiently in your testing\n\nFor more information on faucet limits, please visit the [EVM Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-evm-test-networks) or the [Solana Faucet endpoint](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/faucets/request-funds-on-solana-devnet).","customer_not_authorized":"This error occurs when the customer is not currently authorized for one\nor more capabilities required to perform the requested action. This can\nhappen at any point in the customer's lifecycle and may or may not be\nresolvable by the developer.\n\nThe response includes an `unauthorizedCapabilities` field listing the\ncapability code(s) that were not authorized on this request.\n\n**Steps to resolve:**\n1. Fetch the customer with `GET /v2/customers/{customerId}` and inspect\n the `requirements` field. If `requirements.due` is non-empty, submit\n the listed fields via `POST /v2/customers/{customerId}` and retry.\n2. If `requirements.due` is empty, no further action is available — the\n customer is not currently eligible for this action.","forbidden":"This error occurs when you don't have permission to access the resource.\n\n**Steps to resolve:**\n1. Verify your permissions to access the resource\n2. Ensure that you are the owner of the requested resource","idempotency_error":"This error occurs when an idempotency key is reused with different parameters.\n\n**Steps to resolve:**\n1. Generate a new UUID v4 for each unique request\n2. Only reuse idempotency keys for exact request duplicates\n3. Track used keys within your application\n\n**Example idempotency key implementation:**\n```typescript lines wrap\nimport { v4 as uuidv4 } from 'uuid';\n\nfunction createIdempotencyKey() {\n return uuidv4();\n}\n```","internal_server_error":"This indicates an unexpected error that occurred on the CDP servers.\n\n**Important**: If you encounter this error, please note that your operation's status should be treated as unknown by your application, as it could have been a success within the CDP back-end.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - Your correlation ID\n - Timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","invalid_request":"This error occurs when the request is malformed or contains invalid data, including issues with the request body, query parameters, path parameters, or headers.\n\n**Steps to resolve:**\n1. Check all required fields and parameters are present\n2. Ensure request body (if applicable) follows the correct schema\n3. Verify all parameter formats match the API specification:\n - Query parameters\n - Path parameters\n - Request headers\n4. Validate any addresses, IDs, or other formatted strings meet requirements\n\n**Common validation issues:**\n- Missing required parameters\n- Invalid parameter types or formats\n- Malformed JSON in request body\n- Invalid enum values\n\n#### Transfer-specific validation errors\n\nThe following transfer validation scenarios return `errorType: \"invalid_request\"`. Use the `errorMessage` field to identify the specific case.\n\n| Scenario | Example `errorMessage` |\n|----------|----------------------|\n| Source account ID is malformed | `\"source is invalid.\"` |\n| Target account ID is malformed | `\"target is invalid.\"` |\n| Source account does not exist | `\"source not found.\"` |\n| Target account does not exist | `\"target not found.\"` |\n| Asset not supported at source | `\"source is not supported.\"` |\n| Asset not supported at target | `\"target is not supported.\"` |\n| Target email address is malformed | `\"target has an invalid email format.\"` |\n| Target onchain address is invalid for network | `\"The recipient address is invalid for the selected network.\"` |\n| Asset not supported for this transfer route | `\"Transfer asset pair is not supported.\"` |\n| Insufficient balance | `\"Insufficient funds to complete this transfer.\"` |\n| Asset mismatch between request fields | `\"Currency mismatch in request.\"` |\n| Metadata has too many keys | `\"Metadata has too many keys. Up to 10 key/value pairs are permitted.\"` |\n| Metadata key exceeds length limit | `\"Metadata key is too long. Each key must be less than or equal to 40 characters.\"` |\n| Metadata value exceeds length limit | `\"Metadata value is too long. Each value must be less than or equal to 500 characters.\"` |\n| Travel rule fields missing | `\"Travel rule information is incomplete. Missing fields: ...\"` |\n| Recipient address not in account allowlist | `\"Your coinbase account allowlist does not include this address. Please update your allowlist at https://www.coinbase.com/settings/allowlist\"` |","invalid_sql_query":"This error occurs when the SQL query is invalid or not allowed.\n\n**Common causes:**\n- Using non-SELECT SQL statements (INSERT, UPDATE, DELETE, etc.)\n- Invalid table or column names\n- Syntax errors in SQL query\n- Query exceeds character limit\n- Too many JOIN operations","invalid_signature":"This error occurs when the signature provided for the given user operation is invalid.\n\n**Steps to resolve:**\n1. Verify the signature was generated by the correct owner account\n2. Ensure the signature corresponds to the exact user operation hash\n3. Check that the signature format matches the expected format\n4. Confirm you're using the correct network for the Smart Account\n\n**Common causes:**\n- Using wrong owner account to sign\n- Signing modified/incorrect user operation data\n- Malformed signature encoding\n- Network mismatch between signature and broadcast","malformed_transaction":"This error occurs when the transaction data provided is not properly formatted or is invalid.\n\n**Steps to resolve:**\n1. Verify transaction encoding:\n - **EVM networks**: Check RLP encoding is correct\n - **Solana**: Validate base64 encoding\n2. Ensure all required transaction fields are present\n3. Validate transaction parameters are within acceptable ranges\n4. Check that the transaction type is supported on the target network (see our [Supported Networks](https://docs.cdp.coinbase.com/get-started/supported-networks) page for more details)\n\n**Common causes:**\n- Invalid hex encoding for EVM transactions\n- Missing required transaction fields\n- Incorrect parameter formats\n- Unsupported transaction types\n- Network-specific transaction format mismatches","not_found":"This error occurs when the resource specified in your request doesn't exist or you don't have access to it.\n\n**Steps to resolve:**\n1. Verify the resource ID/address/account exists\n2. Check your permissions to access the resource\n3. Ensure you're using the correct network/environment\n4. Confirm the resource hasn't been deleted\n\n**Common causes:**\n- Mistyped addresses\n- Accessing resources from the wrong CDP project\n- Resource was deleted or hasn't been created yet","payment_method_required":"This error occurs when a payment method is required to complete the requested operation but none is configured or available.\n\n**Steps to resolve:**\n1. Add a valid payment method to your account using the [CDP Portal](https://portal.cdp.coinbase.com)\n2. Ensure your payment method is valid and not expired\n\n**Common causes:**\n- No payment method configured on the account\n- Payment method is expired","payment_required":"This error occurs when an x402 payment is required to access the requested resource.\n\n**Steps to resolve:**\n1. Include a valid x402 payment header in your request\n2. Ensure the payment meets the resource's pricing requirements","settlement_failed":"This error occurs when an x402 payment was verified but settlement on-chain failed.\n\n**Steps to resolve:**\n1. Retry the request with a new payment\n2. Ensure the payment asset has sufficient balance for settlement","rate_limit_exceeded":"This error occurs when you've exceeded the API rate limits.\n\n**Steps to resolve:**\n1. Implement exponential backoff\n2. Cache responses where possible\n3. Wait for rate limit window to reset\n\n**Best practices:**\n```typescript lines wrap\nasync function withRetry(fn: () => Promise\u003cany>) {\n let delay = 1000;\n while (true) {\n try {\n return await fn();\n } catch (e) {\n if (e.errorType === \"rate_limit_exceeded\") {\n await sleep(delay);\n delay *= 2;\n continue;\n }\n throw e;\n }\n }\n}\n```","request_canceled":"This error occurs when the client cancels an in-progress request before it completes.\n\n**Steps to resolve:**\n1. Check client-side timeout configurations\n2. Review request cancellation logic in your code\n3. Consider increasing timeout thresholds for long-running operations\n4. Implement request tracking to identify premature cancellations\n\n**Best practices:**\n```typescript lines wrap\nasync function withTimeout\u003cT>(promise: Promise\u003cT>, timeoutMs: number): Promise\u003cT> {\n const timeout = new Promise((_, reject) => {\n setTimeout(() => {\n reject(new Error(\"Operation timed out\"));\n }, timeoutMs);\n });\n\n try {\n return await Promise.race([promise, timeout]);\n } catch (error) {\n // Handle timeout or cancellation\n throw error;\n }\n}\n```","service_unavailable":"This error occurs when the CDP API is temporarily unable to handle requests due to maintenance or high load.\n\n**Steps to resolve:**\n1. Retry your request after a short delay\n2. If persistent, contact CDP support with:\n - The timestamp of the error\n - Request details\n3. Consider implementing retry logic with an exponential backoff\n\n**Note:** These errors are automatically logged and monitored by CDP.","timed_out":"This error occurs when a request exceeds the maximum allowed processing time.\n\n**Steps to resolve:**\n1. Break down large requests into smaller chunks (if applicable)\n2. Implement retry logic with exponential backoff\n3. Use streaming endpoints for large data sets\n\n**Example retry implementation:**\n```typescript lines wrap\nasync function withRetryAndTimeout\u003cT>(\n operation: () => Promise\u003cT>,\n maxRetries = 3,\n timeout = 30000,\n): Promise\u003cT> {\n let attempts = 0;\n while (attempts \u003c maxRetries) {\n try {\n return await Promise.race([\n operation(),\n new Promise((_, reject) =>\n setTimeout(() => reject(new Error(\"Timeout\")), timeout)\n ),\n ]);\n } catch (error) {\n attempts++;\n if (attempts === maxRetries) throw error;\n // Exponential backoff\n await new Promise(resolve =>\n setTimeout(resolve, Math.pow(2, attempts) * 1000)\n );\n }\n }\n throw new Error(\"Max retries exceeded\");\n}\n```","unauthorized":"This error occurs when authentication fails.\n\n**Steps to resolve:**\n1. Verify your CDP API credentials:\n - Check that your API key is valid\n - Check that your Wallet Secret is properly configured\n2. Validate JWT token:\n - Not expired\n - Properly signed\n - Contains required claims\n3. Check request headers:\n - Authorization header present\n - X-Wallet-Auth header included when required\n\n**Security note:** Never share your Wallet Secret or API keys.","unsupported_tos_language":"A submitted Terms of Service acceptance used a `language` that is not published for the referenced `versionId`.\n\n**Steps to resolve:**\n1. Read `Customer.requirements.tos.tosVersions[]` and find the entry whose `versionId` matches your acceptance.\n2. Choose a `language` from that entry's `languages` list (BCP 47 tags).\n3. Retry with `tosAcceptances[].language` set to a supported tag.","policy_in_use":"This error occurs when trying to delete a Policy that is currently in use by at least one project or account.\n\n**Steps to resolve:**\n1. Update project or accounts to remove references to the Policy in question.\n2. Retry your delete request.","network_not_tradable":"This error occurs when the selected asset cannot be purchased on the selected network in the user's location.\n\n**Steps to resolve:**\n1. Verify the asset is tradable on the selected network\n2. Check the user's location to ensure it is allowed to purchase the asset on the selected network\n\n**Common causes:**\n- Users in NY are not allowed to purchase USDC on any network other than Ethereum","guest_permission_denied":"This error occurs when the user is not allowed to complete onramp transactions as a guest.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_region_forbidden":"This error occurs when guest onramp transactions are not allowed in the user's region.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","guest_transaction_limit":"This error occurs when the user has reached the weekly guest onramp transaction limit.\n\n**Steps to resolve:**\n1. Inform the user they have reached their weekly limit and will have to wait until next week.","guest_transaction_count":"This error occurs when the user has reached the lifetime guest onramp transaction count limit.\n\n**Steps to resolve:**\n1. Redirect the user to create a Coinbase account to buy and send crypto.","phone_number_verification_expired":"This error occurs when the user's phone number verification has expired. Use of guest Onramp requires the user's\nphone number to be verified every 60 days.\n\n**Steps to resolve:**\n1. Re-verify the user's phone number via OTP.\n2. Retry the request with the phoneNumberVerifiedAt field set to new verification timestamp.","document_verification_failed":"This error occurs when the user has not verified their identity for their coinbase.com account.\n**Steps to resolve:**\n1. Verify your coinbase account identity with valid documents at https://www.coinbase.com/settings/account-levels.","recipient_allowlist_violation":"This error occurs when the user is not allowed to receive funds at this address, according to their coinbase account allowlist.\n**Steps to resolve:**\n1. Either disable the allowlist or add the wallet address at https://www.coinbase.com/settings/allowlist\n2. Wait approximately 2 days for updates to take effect.","recipient_allowlist_pending":"This error occurs when the user is not allowed to receive funds at this address, because changes to their coinbase account allowlist are pending.\n**Steps to resolve:**\n1. Wait approximately 2 days for updates to take effect.","refund_expired":"Returned when a refund attempt is made after the payment session's refund deadline has passed. The payment session can no longer be refunded.","travel_rules_recipient_violation":"This error occurs when the user is not allowed to receive funds at this address, because it violates travel rules.\n**Steps to resolve:**\n1. Ensure your desired transfer is not blocked by local travel regulations.","mfa_already_enrolled":"This error occurs when attempting to enroll in an MFA method that the user has already enrolled in.\n\n**Steps to resolve:**\n1. Check if the user is already enrolled in the MFA method before initiating enrollment\n2. To update or reset MFA, remove the existing enrollment first (if supported)\n3. Use a different MFA method if multiple options are available","mfa_invalid_code":"This error occurs when the MFA code provided is incorrect or has already been used.\n\n**Steps to resolve:**\n1. Verify the user entered the correct code from their authenticator app\n2. Ensure the code is current (TOTP codes expire after 30 seconds)\n3. Check that the device time is synchronized correctly\n4. Ask the user to generate a new code and try again\n\n**Common causes:**\n- Typing errors in the 6-digit code\n- Using an expired TOTP code\n- Device clock drift on user's authenticator app\n- Attempting to reuse a previously submitted code","mfa_flow_expired":"This error occurs when the MFA enrollment or verification session has expired.\n\n**Steps to resolve:**\n1. Restart the MFA enrollment or verification flow\n2. Complete the flow within the allowed time window (typically 5 minutes)\n3. Ensure the user doesn't leave the flow idle for extended periods\n\n**Note:** MFA sessions expire automatically for security purposes.","mfa_required":"This error occurs when attempting to perform a sensitive operation that requires MFA verification, but the user has not completed MFA verification.\n\n**Steps to resolve:**\n1. Initiate the MFA verification flow using the `/mfa/verify/{mfaMethod}/init` endpoint\n2. Prompt the user to enter their MFA code\n3. Submit the verification using the `/mfa/verify/{mfaMethod}/submit` endpoint\n4. Use the returned access token with MFA claim for the sensitive operation\n5. Retry the original request with the new MFA-verified token\n\n**Operations requiring MFA:**\n- Transactions Sign/Send\n- Key export\n- Account management actions (when configured)","mfa_not_enrolled":"This error occurs when attempting to verify MFA for a user who has not enrolled in any MFA method.\n\n**Steps to resolve:**\n1. Check if the user has enrolled in MFA before attempting verification\n2. Guide the user through MFA enrollment first using the `/mfa/enroll/{mfaMethod}/init` endpoint\n3. Complete enrollment before requiring MFA verification","source_account_invalid":"This error occurs when the source account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account ID belongs to your CDP entity\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","target_account_invalid":"This error occurs when the target account specified in the transfer request is invalid or malformed.\n\n**Steps to resolve:**\n1. Verify the account ID format is correct (e.g., `account_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)\n2. Ensure the account exists and can receive funds\n3. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`\n\n**Common causes:**\n- Malformed account ID\n- Typo in the account ID","source_account_not_found":"This error occurs when the source account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","target_account_not_found":"This error occurs when the target account specified in the transfer does not exist.\n\n**Steps to resolve:**\n1. Verify the account ID exists by calling `GET /v2/accounts/{accountId}` or `GET /v2/accounts`","source_asset_not_supported":"This error occurs when the asset specified in the transfer source is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the source account type\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n\n**Common causes:**\n- Unsupported asset for the transfer route\n- Incorrect asset symbol","target_asset_not_supported":"This error occurs when the asset specified in the transfer target is not supported for this transfer type.\n\n**Steps to resolve:**\n1. Check the list of supported assets for the target\n2. Verify the asset symbol is correctly specified (e.g., `usdc`, `usdt`)\n3. Ensure the target can receive this asset type\n\n**Common causes:**\n- Asset not supported by the target\n- Unsupported conversion between source and target assets","target_email_invalid":"This error occurs when the email address specified as the transfer target is invalid.\n\n**Steps to resolve:**\n1. Verify the email address format is valid (e.g., `user@example.com`)\n2. Check for typos in the email address\n3. Ensure the email domain is valid\n\n**Common causes:**\n- Invalid email format\n- Missing @ symbol or domain\n- Typo in the email address","target_onchain_address_invalid":"This error occurs when the onchain address specified as the transfer target is invalid for the specified network.\n\n**Steps to resolve:**\n1. Ensure the network is supported for the transfer type\n2. Verify the address format matches the target network\n3. Ensure you haven't mixed up addresses from different networks\n\n**Common causes:**\n- Network not supported for the transfer type\n- Address format doesn't match network\n- Address from a different blockchain network","transfer_amount_invalid":"This error occurs when the transfer amount is invalid.\n\n**Steps to resolve:**\n1. Ensure the amount is a positive number and greater than $1 USD equivalent amount\n2. Verify the amount format is a valid decimal string (e.g., `\"100.50\"`)\n3. Check the number of decimal places for the asset\n\n**Common causes:**\n- Zero or negative amount\n- Too many decimal places for the asset\n- Amount below minimum threshold ($1 USD equivalent amount)","transfer_asset_not_supported":"This error occurs when the asset specified for the transfer is not supported.\n\n**Steps to resolve:**\n1. Check the list of supported assets for transfers\n2. Verify the asset symbol is correctly specified\n3. Ensure the asset is supported for the transfer route (source → target)\n\n**Common causes:**\n- Asset not supported for transfers\n- Incorrect asset symbol","transfer_quote_expired":"This error occurs when the transfer quote has expired. Quotes are valid for a limited time.\n\n**Steps to resolve:**\n1. Create a new transfer to obtain a fresh quote\n2. Execute the transfer promptly after creation\n\n**Common causes:**\n- Too much time elapsed between creating and executing the transfer","insufficient_balance":"This error occurs when the source account does not have enough funds to complete the transfer including fees.\n\n**Steps to resolve:**\n1. Check the source account balance\n2. Ensure the balance covers both the transfer amount and any fees\n3. Consider using `amountType: \"source\"` to transfer the maximum available amount minus fees\n4. Add funds to the source account if needed\n\n**Common causes:**\n- Transfer amount exceeds available balance\n- Not accounting for transfer fees\n- Pending transactions reducing available balance","metadata_too_many_entries":"This error occurs when the transfer metadata contains more entries than allowed.\n\n**Steps to resolve:**\n1. Reduce the number of metadata entries (maximum 10 allowed)\n2. Consolidate related data into fewer keys\n3. Store additional data externally and reference it with a single metadata entry\n\n**Limits:**\n- Maximum entries: 10","metadata_key_too_long":"This error occurs when a metadata key exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata key to 40 characters or less\n2. Use abbreviations or shorter naming conventions\n3. Consider using a key-value structure where the value contains the longer identifier\n\n**Limits:**\n- Maximum key length: 40 characters","metadata_value_too_long":"This error occurs when a metadata value exceeds the maximum allowed length.\n\n**Steps to resolve:**\n1. Shorten the metadata value to 500 characters or less\n2. Store longer data externally and reference it with a shorter identifier\n3. Consider compressing or encoding the data if appropriate\n\n**Limits:**\n- Maximum value length: 500 characters","travel_rules_field_missing":"This error occurs when required travel rule fields are missing from the transfer request.\n\n**Steps to resolve:**\n1. Include the `travelRule` object in your transfer request\n2. Supply the required missing fields prompted by the error message\n3. Review the travel rule requirements for your jurisdiction\n\nNote: Required fields may vary by region.","asset_mismatch":"This error occurs when the assets specified in the transfer are incompatible or don't match expected values.\n\n**Steps to resolve:**\n1. Ensure the `asset` field matches either the source or target asset\n2. Verify that the source and target assets are compatible for conversion (if different)\n3. Check that the asset symbols are correctly specified\n\n**Common causes:**\n- Transfer asset doesn't match source or target\n- Attempting an unsupported asset conversion\n- Typo in asset symbols","order_quote_expired":"This error occurs when attempting to execute an order whose quote has expired.\n\n**Steps to resolve:**\n1. Create a new order with `execute: false` to get an updated quote.\n2. Execute the new order before the quote expires (check the `expiresAt` field).\n3. Alternatively, create a new order with `execute: true` to skip the quote step and execute immediately.","order_already_filled":"This error occurs when attempting to cancel or modify an order that has already been filled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. A filled order cannot be canceled or re-executed.","order_already_canceled":"This error occurs when attempting to cancel or execute an order that has already been canceled.\n\n**Steps to resolve:**\n1. Check the current status of the order using `GET /v2/orders/{orderId}`.\n2. Create a new order if you still want to trade.","account_not_ready":"This error occurs when an operation is attempted on an account that is still being provisioned.\n\n**Steps to resolve:**\n1. Wait a few moments and retry the request\n2. If the error persists, the account may still be completing setup — retry with exponential backoff","insufficient_liquidity":"This error occurs when no swap route is available for the requested token pair or amount.\n\n**Steps to resolve:**\n1. Try a smaller `fromAmount` — large orders may exceed available liquidity\n2. Try a different token pair\n3. Retry after a short delay; liquidity conditions change with market activity","insufficient_allowance":"This error occurs when the taker has not approved the Permit2 contract to spend the `fromToken`\non their behalf. ERC-20 swaps require a Permit2 allowance. Native ETH swaps do not.\n\n**Steps to resolve:**\n1. Submit an ERC-20 `approve` transaction on the `fromToken` contract, granting the Permit2\n contract (`0x000000000022D473030F116dDEE9F6B43aC78BA3`) an allowance of at least `fromAmount`\n2. Wait for the approval transaction to be confirmed on-chain\n3. Retry the swap\n\n**Example:**\n```typescript lines wrap\n// Approve Permit2 to spend fromToken\nawait walletClient.writeContract({\n address: fromToken,\n abi: erc20Abi,\n functionName: \"approve\",\n args: [\"0x000000000022D473030F116dDEE9F6B43aC78BA3\", fromAmount],\n});\n```","transaction_simulation_failed":"This error occurs when the pre-broadcast simulation of the swap transaction predicted a revert.\nNo transaction was submitted and no gas was spent.\n\n**Common causes:**\n- The on-chain price moved past the `slippageBps` tolerance between the price estimate and execution\n- Taker balance changed between the price estimate and execution\n\n**Steps to resolve:**\n1. Retry immediately — prices change quickly and a new quote may succeed\n2. Increase `slippageBps` if retries continue to fail (e.g. from 100 to 200)\n3. For large swaps, consider splitting into smaller amounts to reduce price impact","delegation_not_found":"This error occurs when a delegated signing operation is attempted but no active\ndelegation grant exists for the end user (or account).\n\n**Steps to resolve:**\n1. Create a delegation grant using `createDelegationForEndUser` (user-scoped)\n or `createDelegationForEndUserAccount` (account-scoped) before calling\n the signing or sending operation\n2. If you previously created a grant, it may have expired or been revoked —\n in those cases you would receive a `delegation_expired` or\n `delegation_revoked` error instead\n3. For account-scoped grants, verify the address in the request matches the\n granted address (EVM addresses are compared case-insensitively;\n Solana addresses must match exactly)","delegation_expired":"This error occurs when the delegation grant used for signing has expired.\nDelegation grants have a limited lifetime set at creation.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Retry the signing operation with the new grant active\n3. Consider creating grants with a longer TTL if expiry is frequent","delegation_revoked":"This error occurs when the delegation grant has been explicitly revoked.\n\n**Steps to resolve:**\n1. Create a new delegation grant using `createDelegationForEndUser` or\n `createDelegationForEndUserAccount`\n2. Confirm with the end user before recreating, since revocation is\n typically intentional","delegation_not_authorized":"This error occurs when a delegation grant exists but does not authorize the\nrequested operation.\n\n**Steps to resolve:**\n1. For account-scoped grants, verify the signing address matches the address\n the grant was created for\n2. Check that the operation is permitted for delegated signing on your project\n3. Create a grant with the correct scope if needed","delegation_not_enabled":"This error occurs when delegated signing is attempted on a project that has\nnot enabled the feature.\n\n**Steps to resolve:**\n1. Enable delegated signing in your project configuration via the CDP Portal\n2. Contact support if you believe delegated signing should already be enabled\n for your project","network_mismatch":"This error occurs when the requested operation specifies a network on which the\ntarget resource is not deployed or not available.\n\n**Steps to resolve:**\n1. Use the network the resource was originally created or deployed on\n2. Check the resource metadata to confirm the correct network\n\n**Common causes:**\n- Specifying `base` for a resource that only exists on `base-sepolia` (or vice versa)\n- Cross-network operation attempted on a resource scoped to a single network","already_enabled":"This error occurs when the requested operation cannot be performed because\nthe capability is already in the desired state.\n\n**Steps to resolve:**\n1. Check the current state of the resource before attempting the operation\n2. No action is needed if the resource is already in the desired state\n\n**Common causes:**\n- Calling an enable endpoint on a resource that already has the feature enabled"},"isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"The error message.","type":"string","example":"Unable to create EVM account","isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string"},"correlationId":{"description":"A unique identifier for the request that generated the error. This can be used to help debug issues with the API.","type":"string","example":"41deb8d59a9dc9a7-IAD","uniqueKey":"correlationId","typeLabel":"string"},"errorLink":{"type":"string","description":"A link to the corresponding error documentation.","format":"uri","maxLength":2048,"minLength":11,"pattern":"^https?://.*$","example":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request","uniqueKey":"errorLink","typeLabel":"string\u003curi>"},"unauthorizedCapabilities":{"description":"The capability code(s) that were not authorized for the customer on\nthis request. Present only when `errorType` is\n`customer_not_authorized`; absent for every other error type.\n\nUse this list to render onboarding UX for the listed capabilities, or\nfetch `GET /v2/customers/{customerId}` and inspect each entry's\n`status` / `requirements` to discover what (if anything) can be\nsubmitted to resolve the block.\n","type":"array","items":{"type":"string","description":"The name of a capability. Capabilities represent granular functional permissions\nthat determine what actions a customer can perform. Each capability must be\nexplicitly requested before use.\n","enum":["custodyCrypto","custodyFiat","custodyStablecoin","tradeCrypto","tradeStablecoin","transferCrypto","transferFiat","transferStablecoin"],"example":"custodyCrypto","uniqueKey":"unauthorizedCapabilities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"unauthorizedCapabilities","typeLabel":"enum\u003cstring>[]"}},"required":["errorType","errorMessage"],"example":{"errorType":"invalid_request","errorMessage":"Invalid request.","correlationId":"41deb8d59a9dc9a7-IAD","errorLink":"https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request"},"uniqueKey":"","typeLabel":"object"},"examples":{"service_unavailable":{"title":"service_unavailable","value":{"errorType":"service_unavailable","errorMessage":"Service unavailable. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0cf46ded-e856-4f5b-8c23-cf43b8750b3e":{"unauthenticated":{"x-audience":"public","type":"http","scheme":"none","description":"This security scheme is used for APIs that do not require authentication, such as End User Auth flows used to initiate authentication or public, read-only endpoints.","scopes":[]}}},"servers":{"a849636c-5380-4e0a-952a-2b198966464a":{"url":"https://api.cdp.coinbase.com/platform","description":"The production server of the CDP APIs."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"x-audience":"public","type":"http","scheme":"none","description":"This security scheme is used for APIs that do not require authentication, such as End User Auth flows used to initiate authentication or public, read-only endpoints.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"This security scheme is used for APIs that do not require authentication, such as End User Auth flows used to initiate authentication or public, read-only endpoints.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"unauthenticated","name":"Authorization"}],"title":"unauthenticated"}]},"originalFileLocation":"api-reference/v2/cdp-api-v2.yaml"},"subdomain":"coinbase-cloud","siteName":"Coinbase Developer Documentation","title":"List x402 resources - Coinbase Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-14T15:02:34.473Z","originalFileLocation":"api-reference/v2/rest-api/x402-facilitator/list-x402-resources.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=\"Lists all active discovered x402 resources. This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata. The response is paginated, and by default, returns 100 items per page.\">\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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/coinbase-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_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-cloud/QIxkIqQGmtBiz2Kd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List x402 resources - Coinbase Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists all active discovered x402 resources. This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata. The response is paginated, and by default, returns 100 items per page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Coinbase Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://coinbase-cloud.mintlify.site/_mintlify/api/og/v2?division=x402+Facilitator\u0026amp;title=List+x402+resources\u0026amp;description=Lists+all+active+discovered+x402+resources.%0AThis+endpoint+returns+resources+that+have+been+discovered+and+cached+by+the+x402+facilitator%2C+including+their+paymen\u0026amp;theme=b18300d82c528d7a817aebbd\u0026amp;signature=34e42d1ae7f18d8e86bb9272a6febdb19d43c4f30d64423d637ee0db884f976e\">\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=\"List x402 resources - Coinbase Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists all active discovered x402 resources. This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata. The response is paginated, and by default, returns 100 items per page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://coinbase-cloud.mintlify.site/_mintlify/api/og/v2?division=x402+Facilitator\u0026amp;title=List+x402+resources\u0026amp;description=Lists+all+active+discovered+x402+resources.%0AThis+endpoint+returns+resources+that+have+been+discovered+and+cached+by+the+x402+facilitator%2C+including+their+paymen\u0026amp;theme=b18300d82c528d7a817aebbd\u0026amp;signature=34e42d1ae7f18d8e86bb9272a6febdb19d43c4f30d64423d637ee0db884f976e\">\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-cloud/QIxkIqQGmtBiz2Kd/_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.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cloud.coinbase.com/#organization\",\"name\":\"Coinbase Developer Documentation\",\"url\":\"https://docs.cloud.coinbase.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/coinbase-cloud/FjMSMQIg--bQwlYn/logos/wordmark-light.svg?fit=max\u0026auto=format\u0026n=FjMSMQIg--bQwlYn\u0026q=85\u0026s=78661b6fd3ff79c8e85642f839addf7b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cloud.coinbase.com#website\",\"name\":\"Coinbase Developer Documentation\",\"url\":\"https://docs.cloud.coinbase.com\",\"publisher\":{\"@id\":\"https://docs.cloud.coinbase.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources#webpage\",\"url\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources\",\"name\":\"List x402 resources\",\"description\":\"Lists all active discovered x402 resources. This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata. The response is paginated, and by default, returns 100 items per page.\",\"dateModified\":\"2026-05-14T15:02:34.473Z\",\"isPartOf\":{\"@id\":\"https://docs.cloud.coinbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/accounts/accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/deposit-destinations/deposit-destinations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"x402 Facilitator\",\"item\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/x402-facilitator\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"List x402 resources\",\"item\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources#apireference\",\"headline\":\"List x402 resources\",\"name\":\"List x402 resources\",\"description\":\"Lists all active discovered x402 resources. This endpoint returns resources that have been discovered and cached by the x402 facilitator, including their payment requirements and metadata. The response is paginated, and by default, returns 100 items per page.\",\"url\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cloud.coinbase.com/api-reference/v2/rest-api/x402-facilitator/list-x402-resources#webpage\"},\"dateModified\":\"2026-05-14T15:02:34.473Z\",\"publisher\":{\"@id\":\"https://docs.cloud.coinbase.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cloud.coinbase.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/v2/rest-api/x402-facilitator/list-x402-resources.md","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":"Business Onboarding","href":"/api-reference/v2/business-onboarding"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/v2/authentication"},{"title":"Idempotency","href":"/api-reference/v2/idempotency"},{"title":"Rate Limits","href":"/api-reference/v2/rate-limits"},{"title":"Errors","href":"/api-reference/v2/errors"}]},{"group":"REST API","pages":[{"group":"Wallets","pages":[{"group":"Custodial","pages":[{"group":"Accounts","tag":"Beta","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/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":"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/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":"delete /v2/embedded-wallet-api/end-users/{userId}/address/{address}/delegation","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":"delete /v2/embedded-wallet-api/end-users/{userId}/delegation","title":"Revoke delegation for end user","href":"/api-reference/v2/rest-api/end-user-accounts/revoke-delegation-for-end-user"}]}]},{"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":"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":"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":"Payments","pages":[{"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":"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":"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/limits/upgrade","title":"Request limit upgrade","href":"/api-reference/v2/rest-api/onramp/request-limit-upgrade"},{"group":"Webhooks","pages":[{"title":"Webhook offramp transaction created","href":"/api-reference/v2/webhook-offramp-transaction-created"},{"title":"Webhook offramp transaction failed","href":"/api-reference/v2/webhook-offramp-transaction-failed"},{"title":"Webhook offramp transaction success","href":"/api-reference/v2/webhook-offramp-transaction-success"},{"title":"Webhook offramp transaction updated","href":"/api-reference/v2/webhook-offramp-transaction-updated"},{"title":"Webhook onramp transaction created","href":"/api-reference/v2/webhook-onramp-transaction-created"},{"title":"Webhook onramp transaction failed","href":"/api-reference/v2/webhook-onramp-transaction-failed"},{"title":"Webhook onramp transaction success","href":"/api-reference/v2/webhook-onramp-transaction-success"},{"title":"Webhook onramp transaction updated","href":"/api-reference/v2/webhook-onramp-transaction-updated"}]}]},{"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/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","description":"Gets x402 merchant discovery information for a given merchant payment address.\nThis endpoint returns all active x402 resources associated with the specified `payTo` address, allowing clients to discover what payment-gated resources a merchant exposes and their corresponding payment requirements.\nIf no active resources are found for the `payTo` address, the endpoint returns an empty `resources` list.\nThe response is paginated, and by default, returns 20 items per page.","href":"/api-reference/v2/rest-api/x402-facilitator/list-merchant-discovery-info"},{"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","description":"Searches for active x402 resources using a text query and optional filters.\nSupports both text-based and vector-based search depending on availability. Results are sorted by relevance and quality score.\nLegacy network names (e.g., `base`, `base-sepolia`, `solana`) are automatically normalized to their CAIP-2 equivalents.\nThe response is limited to 20 items per request. If more results exist, `partialResults` will be `true`.","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/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":[{"title":"Webhook onchain activity detected","href":"/api-reference/v2/webhook-onchain-activity-detected"},{"title":"Webhook wallet activity detected","href":"/api-reference/v2/webhook-wallet-activity-detected"},{"title":"Webhook wallet activity multi","href":"/api-reference/v2/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":"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}/events","title":"List webhook subscription events","href":"/api-reference/v2/rest-api/webhooks/list-webhook-subscription-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":"CDP Payments API","icon":"https://mintlify.b-cdn.net/coinbase/pay.svg","groups":[{"group":"CDP PAYMENTS API","pages":[{"title":"CDP Payments API","sidebarTitle":"Overview","href":"/api-reference/payment-apis/overview"},{"title":"API Conventions","sidebarTitle":"Conventions","href":"/api-reference/payment-apis/conventions"},{"title":"Create a recurring report in Portal","sidebarTitle":"Reports","href":"/api-reference/payment-apis/reports"},{"group":"Troubleshooting","pages":[{"title":"Troubleshooting \u0026 Help","sidebarTitle":"Common Issues","href":"/api-reference/payment-apis/troubleshooting"},{"title":"Errors","href":"/api-reference/payment-apis/errors"}]},{"group":"Resource guides","pages":[{"title":"Accounts","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/accounts/accounts"},{"title":"Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/payment-apis/rest-api/deposit-destinations-under-development/overview"},{"title":"Payment Methods","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/payment-methods/payment-methods"},{"group":"Transfers","pages":[{"title":"Transfers","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/transfers/transfers"},{"title":"Metadata","sidebarTitle":"Metadata","href":"/api-reference/payment-apis/rest-api/transfers/metadata"},{"title":"Transfer Validation","sidebarTitle":"Validation","href":"/api-reference/payment-apis/rest-api/transfers/validation"},{"title":"Example payloads","sidebarTitle":"Example payloads","href":"/api-reference/payment-apis/rest-api/transfers/example-payloads"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/api-reference/payment-apis/webhooks"},{"title":"Verification","sidebarTitle":"Verification","href":"/api-reference/payment-apis/webhooks/verification"},{"title":"Subscriptions","sidebarTitle":"Subscriptions","href":"/api-reference/payment-apis/webhooks/subscriptions"},{"title":"Example payloads","sidebarTitle":"Example payloads","href":"/api-reference/payment-apis/webhooks/example-payloads"}]},{"group":"Payment Acceptance","pages":[{"title":"Checkout","sidebarTitle":"Checkout","href":"/api-reference/payment-acceptance/payments/embedded-checkout"}]}]},{"title":"OpenAPI Spec","sidebarTitle":"OpenAPI Spec","url":"https://docs.cdp.coinbase.com/api-reference/payment-apis/payment-apis-spec.yaml","href":"/api-reference/payment-apis/openapi-spec"}]},{"group":"SANDBOX","pages":[{"title":"Sandbox Overview","sidebarTitle":"Overview","href":"/api-reference/payment-apis/sandbox/overview"},{"title":"Sandbox Quickstart","sidebarTitle":"Quickstart","href":"/api-reference/payment-apis/sandbox/quickstart"},{"title":"Testing with Postman","sidebarTitle":"Postman","href":"/api-reference/payment-apis/sandbox/postman"},{"group":"Resource guides","pages":[{"title":"Sandbox: Accounts","sidebarTitle":"Accounts","href":"/api-reference/payment-apis/sandbox/guides/accounts"},{"title":"Sandbox: Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/payment-apis/sandbox/guides/deposit-destinations"},{"title":"Sandbox: Payment Methods","sidebarTitle":"Payment Methods","href":"/api-reference/payment-apis/sandbox/guides/payment-methods"},{"title":"Sandbox: Transfers","sidebarTitle":"Transfers","href":"/api-reference/payment-apis/sandbox/guides/transfers"}]}]},{"group":"REST API","pages":[{"group":"Accounts","pages":[{"title":"Accounts","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/accounts/accounts"},{"openapi":"get /v2/accounts/{accountId}","title":"Get account","href":"/api-reference/payment-apis/rest-api/accounts/get-account"},{"openapi":"get /v2/accounts/{accountId}/balances/{asset}","title":"Get balance for account","href":"/api-reference/payment-apis/rest-api/accounts/get-balance-for-account"},{"openapi":"get /v2/accounts","title":"List accounts","href":"/api-reference/payment-apis/rest-api/accounts/list-accounts"},{"openapi":"get /v2/accounts/{accountId}/balances","title":"List balances for account","href":"/api-reference/payment-apis/rest-api/accounts/list-balances-for-account"},{"openapi":"post /v2/accounts","title":"Create account","href":"/api-reference/payment-apis/rest-api/accounts/create-account"}]},{"group":"Deposit Destinations","pages":[{"title":"Deposit Destinations","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/deposit-destinations/deposit-destinations"},{"openapi":"get /v2/deposit-destinations/{depositDestinationId}","title":"Get deposit destination","href":"/api-reference/payment-apis/rest-api/deposit-destinations/get-deposit-destination"},{"openapi":"get /v2/deposit-destinations","title":"List deposit destinations","href":"/api-reference/payment-apis/rest-api/deposit-destinations/list-deposit-destinations"},{"openapi":"post /v2/deposit-destinations","title":"Create deposit destination","href":"/api-reference/payment-apis/rest-api/deposit-destinations/create-deposit-destination"}]},{"group":"Payment Acceptance","pages":[{"title":"Payment Acceptance","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/payment-acceptance-under-development"},{"openapi":"get /v2/disbursements/{disbursementId}","title":"Get a disbursement","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-disbursement"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}","title":"Get a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-payment-session"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations/{authorizationId}","title":"Get a payment session authorization","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-payment-session-authorization"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/captures/{captureId}","title":"Get a payment session capture","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-payment-session-capture"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/refunds/{refundId}","title":"Get a payment session refund","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-payment-session-refund"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/voids/{voidId}","title":"Get a payment session void","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-a-payment-session-void"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations/wallet/options","title":"Get wallet authorization options","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/get-wallet-authorization-options"},{"openapi":"get /v2/coinbase-accounts/balances","title":"List Coinbase account balances","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-coinbase-account-balances"},{"openapi":"get /v2/disbursements","title":"List disbursements","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-disbursements"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/authorizations","title":"List payment session authorizations","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-payment-session-authorizations"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/captures","title":"List payment session captures","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-payment-session-captures"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/refunds","title":"List payment session refunds","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-payment-session-refunds"},{"openapi":"get /v2/payment-sessions/{paymentSessionId}/voids","title":"List payment session voids","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-payment-session-voids"},{"openapi":"get /v2/payment-sessions","title":"List payment sessions","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/list-payment-sessions"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/coinbase","title":"Authorize a payment session with a Coinbase account","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/authorize-a-payment-session-with-a-coinbase-account"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/authorizations/wallet","title":"Authorize a payment session with a wallet","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/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/payment-apis/rest-api/payment-acceptance-under-development/authorize-a-payment-session-with-x402"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/cancel","title":"Cancel a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/cancel-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/captures","title":"Capture a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/capture-a-payment-session"},{"openapi":"post /v2/disbursements","title":"Create a disbursement","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/create-a-disbursement"},{"openapi":"post /v2/payment-sessions","title":"Create a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/create-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/refunds","title":"Refund a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/refund-a-payment-session"},{"openapi":"post /v2/payment-sessions/{paymentSessionId}/voids","title":"Void a payment session","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/void-a-payment-session"},{"openapi":"webhook disbursementChanged","title":"Disbursement changed","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/disbursement-changed"},{"openapi":"webhook paymentSessionChanged","title":"Payment session changed","href":"/api-reference/payment-apis/rest-api/payment-acceptance-under-development/payment-session-changed"}]},{"group":"Payment Methods","pages":[{"title":"Payment Methods","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/payment-methods/payment-methods"},{"openapi":"get /v2/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/payment-apis/rest-api/payment-methods/get-payment-method"},{"openapi":"get /v2/payment-methods","title":"List payment methods","href":"/api-reference/payment-apis/rest-api/payment-methods/list-payment-methods"}]},{"group":"Transfers","pages":[{"title":"Transfers","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/transfers/transfers"},{"openapi":"get /v2/transfers/{transferId}","title":"Get transfer","href":"/api-reference/payment-apis/rest-api/transfers/get-transfer"},{"openapi":"get /v2/transfers","title":"List transfers","href":"/api-reference/payment-apis/rest-api/transfers/list-transfers"},{"openapi":"post /v2/transfers","title":"Create transfer","href":"/api-reference/payment-apis/rest-api/transfers/create-transfer"},{"openapi":"post /v2/transfers/{transferId}/execute","title":"Execute transfer","href":"/api-reference/payment-apis/rest-api/transfers/execute-transfer"},{"openapi":"post /v2/transfers/{transferId}/travel-rule","title":"Submit deposit travel rule information","href":"/api-reference/payment-apis/rest-api/transfers/submit-deposit-travel-rule-information"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/api-reference/payment-apis/rest-api/webhooks/webhooks"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Get webhook subscription","href":"/api-reference/payment-apis/rest-api/webhooks/get-webhook-subscription"},{"openapi":"get /v2/data/webhooks/subscriptions/{subscriptionId}/events","title":"List webhook subscription events","href":"/api-reference/payment-apis/rest-api/webhooks/list-webhook-subscription-events"},{"openapi":"get /v2/data/webhooks/subscriptions","title":"List webhook subscriptions","href":"/api-reference/payment-apis/rest-api/webhooks/list-webhook-subscriptions"},{"openapi":"post /v2/data/webhooks/subscriptions","title":"Create webhook subscription","href":"/api-reference/payment-apis/rest-api/webhooks/create-webhook-subscription"},{"openapi":"put /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Update webhook subscription","href":"/api-reference/payment-apis/rest-api/webhooks/update-webhook-subscription"},{"openapi":"delete /v2/data/webhooks/subscriptions/{subscriptionId}","title":"Delete webhook subscription","href":"/api-reference/payment-apis/rest-api/webhooks/delete-webhook-subscription"}]}]}]},{"dropdown":"Payment Acceptance","icon":"https://mintlify-assets.b-cdn.net/commerceProduct-1.svg","groups":[{"group":"PAYMENT ACCEPTANCE","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payment-acceptance/overview"},{"group":"Payments","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/payments","title":"Create payment","href":"/api-reference/payment-acceptance/payments/create-payment"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/payments/{id}","title":"Get payment","href":"/api-reference/payment-acceptance/payments/get-payment"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/payments/{paymentId}/authorize","title":"Authorize payment","href":"/api-reference/payment-acceptance/payments/authorize-payment"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/payments/{paymentId}/capture","title":"Capture payment","href":"/api-reference/payment-acceptance/payments/capture-payment"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/payments/{paymentId}/void","title":"Void payment","href":"/api-reference/payment-acceptance/payments/void-payment"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/payments/{paymentId}/refund","title":"Refund payment","href":"/api-reference/payment-acceptance/payments/refund-payment"}]},{"group":"Operators","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/operators","title":"Create Operator","href":"/api-reference/payment-acceptance/operators/create-operator"}]},{"group":"Campaigns","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/campaigns","title":"Create campaign","href":"/api-reference/payment-acceptance/campaigns/create-campaign"}]},{"group":"Rewards","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/rewards/allocate","title":"Allocate rewards","href":"/api-reference/payment-acceptance/rewards/allocate-rewards"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/rewards/distribute","title":"Distribute rewards","href":"/api-reference/payment-acceptance/rewards/distribute-rewards"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/rewards/deallocate","title":"Deallocate rewards","href":"/api-reference/payment-acceptance/rewards/deallocate-rewards"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/rewards/send","title":"Send rewards","href":"/api-reference/payment-acceptance/rewards/send-rewards"}]},{"group":"Webhooks","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml post /api/v1/webhooks","title":"Create webhook","href":"/api-reference/payment-acceptance/webhooks/create-webhook"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhooks/{id}","title":"Get webhook","href":"/api-reference/payment-acceptance/webhooks/get-webhook"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml delete /api/v1/webhooks/{id}","title":"Delete webhook","href":"/api-reference/payment-acceptance/webhooks/delete-webhook"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml put /api/v1/webhooks/{id}","title":"Update webhook","href":"/api-reference/payment-acceptance/webhooks/update-webhook"}]},{"group":"Webhook Events","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhook-events","title":"List webhook events","href":"/api-reference/payment-acceptance/webhook-events/list-webhook-events"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhook-events/payment-operation/{operationId}","title":"Get webhook events by payment operation ID","href":"/api-reference/payment-acceptance/webhook-events/get-webhook-events-by-payment-operation"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhook-events/reward-operation/{operationId}","title":"Get webhook events by reward operation ID","href":"/api-reference/payment-acceptance/webhook-events/get-webhook-events-by-reward-operation"},{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhook-events/{id}","title":"Get webhook event by ID","href":"/api-reference/payment-acceptance/webhook-events/get-webhook-event-by-id"}]},{"group":"Webhook Deliveries","pages":[{"openapi":"/api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhook-deliveries/event/{eventId}","title":"Get webhook deliveries by event ID","href":"/api-reference/payment-acceptance/webhook-deliveries/get-webhook-deliveries-by-event-id"}]},{"title":"OpenAPI Spec","sidebarTitle":"OpenAPI Spec","url":"https://docs.cdp.coinbase.com/api-reference/payment-acceptance/payment-acceptance-api.yaml","href":"/api-reference/payment-acceptance/openapi-spec"}]}]},{"dropdown":"Coinbase Advanced Trade API","icon":"https://mintlify-assets.b-cdn.net/advancedTradeProduct-1.svg","groups":[{"group":"REST API","pages":[{"title":"Welcome to Coinbase Advanced Trade API","sidebarTitle":"Overview","href":"/api-reference/advanced-trade-api/rest-api/introduction"},{"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":"International Derivatives","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"}]}]}]},{"dropdown":"Coinbase App API","icon":"https://mintlify-assets.b-cdn.net/coinbase-0.svg","pages":[{"title":"Welcome to Coinbase App APIs","sidebarTitle":"Overview","href":"/coinbase-app/introduction/welcome"}]},{"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":"Payment Links","pages":[{"title":"Payment Link API Reference","sidebarTitle":"Overview","href":"/api-reference/business-api/rest-api/payment-links/introduction"},{"openapi":"post /api/v1/payment-links","playground":"simple","title":"Create Payment Link","href":"/api-reference/business-api/rest-api/payment-links/create-payment-link"},{"openapi":"get /api/v1/payment-links","playground":"simple","title":"List Payment Links","href":"/api-reference/business-api/rest-api/payment-links/list-payment-links"},{"openapi":"get /api/v1/payment-links/{paymentLinkId}","playground":"simple","title":"Get Payment Link","href":"/api-reference/business-api/rest-api/payment-links/get-payment-link"},{"openapi":"post /api/v1/payment-links/{paymentLinkId}/deactivate","playground":"simple","title":"Deactivate Payment Link","href":"/api-reference/business-api/rest-api/payment-links/deactivate-payment-link"}]},{"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 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":"Assets","pages":[{"title":"Get asset details","openapi":"GET /api/v1/assets/{asset}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/assets/get-asset-details"},{"title":"Get supported networks per asset","openapi":"GET /api/v1/assets/{asset}/networks","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/assets/get-supported-networks"},{"title":"List assets","openapi":"GET /api/v1/assets","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/assets/list-assets"}]},{"group":"Fee Rates","pages":[{"title":"List fee rate tiers","openapi":"GET /api/v1/fee-rate-tiers","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/fee-rates/list-fee-rate-tiers"}]},{"group":"Index","pages":[{"title":"Get index candles","openapi":"GET /api/v1/index/{index}/candles","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/index/get-index-candles"},{"title":"Get index composition","openapi":"GET /api/v1/index/{index}/composition","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/index/get-index-composition"},{"title":"Get index composition history","openapi":"GET /api/v1/index/{index}/composition-history","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/index/get-index-composition-history"},{"title":"Get index price","openapi":"GET /api/v1/index/{index}/price","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/index/get-index-price"}]},{"group":"Instruments","pages":[{"title":"Get aggregated candles data per instrument","openapi":"GET /api/v1/instruments/{instrument}/candles","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/get-aggegated-candles"},{"title":"Get daily trading volumes","openapi":"GET /api/v1/instruments/volumes/daily","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/get-daily-trading-volume"},{"title":"Get historical funding rates","openapi":"GET /api/v1/instruments/{instrument}/funding","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/get-historical-funding-rate"},{"title":"Get instrument details","openapi":"GET /api/v1/instruments/{instrument}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/get-instrument-details"},{"title":"Get quote per instrument","openapi":"GET /api/v1/instruments/{instrument}/quote","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/get-quote-per-instrument"},{"title":"List instruments","openapi":"GET /api/v1/instruments","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/instruments/list-instruments"}]},{"group":"Orders","pages":[{"title":"Cancel order","openapi":"DELETE /api/v1/orders/{id}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/cancel-order"},{"title":"Cancel orders","openapi":"DELETE /api/v1/orders","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/cancel-orders"},{"title":"Create order","openapi":"POST /api/v1/orders","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/create-order"},{"title":"Get order details","openapi":"GET /api/v1/orders/{id}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/get-order-details"},{"title":"List open orders","openapi":"GET /api/v1/orders","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/list-open-orders"},{"title":"Modify open order","openapi":"PUT /api/v1/orders/{id}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/orders/modify-open-order"}]},{"group":"Portfolios","pages":[{"title":"Acquire/repay loan","openapi":"POST /api/v1/portfolios/{portfolio}/loans/{asset}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/acquire-and-repay-loan"},{"title":"Create portfolio","openapi":"POST /api/v1/portfolios","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/create-portfolio"},{"title":"Enable/Disable portfolio auto margin mode","openapi":"POST /api/v1/portfolios/{portfolio}/auto-margin-enabled","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/enable-and-disable-portfolio"},{"title":"Enable/Disable portfolio cross collateral","openapi":"POST /api/v1/portfolios/{portfolio}/cross-collateral-enabled","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/enable-and-disable-cross"},{"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 fund transfer limit between portfolios","openapi":"GET /api/v1/portfolios/transfer/{portfolio}/{asset}/transfer-limit","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-fund-transfer-limit"},{"title":"Get loan info for portfolio/asset","openapi":"GET /api/v1/portfolios/{portfolio}/loans/{asset}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-loan-info-for-portfolio"},{"title":"Get portfolio details","openapi":"GET /api/v1/portfolios/{portfolio}/detail","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-details"},{"title":"Get portfolio margin call status","openapi":"GET /api/v1/portfolios/{portfolio}/margin-call-status","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-margin-call"},{"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 the open position limits for the portfolio instrument","openapi":"GET /api/v1/portfolios/{portfolio}/position-limits/positions/{instrument}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-the-open-position-limits"},{"title":"Get the total open position limit for the portfolio","openapi":"GET /api/v1/portfolios/{portfolio}/position-limits","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/get-the-total-open-position-limits"},{"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 active loans for the portfolio","openapi":"GET /api/v1/portfolios/{portfolio}/loans","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-active-loans-for-the-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 fee rates","openapi":"GET /api/v1/portfolios/fee-rates","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-fee-rates"},{"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"},{"title":"List the open position limits for all instruments","openapi":"GET /api/v1/portfolios/{portfolio}/position-limits/positions","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/list-open-position-limit"},{"title":"Patch portfolio","openapi":"PATCH /api/v1/portfolios/{portfolio}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/patch-portfolio"},{"title":"Preview loan update","openapi":"POST /api/v1/portfolios/{portfolio}/loans/{asset}/preview","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/preview-loan-update"},{"title":"Set portfolio margin override","openapi":"POST /api/v1/portfolios/margin","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/set-profile-margin"},{"title":"Transfer funds between portfolios","openapi":"POST /api/v1/portfolios/transfer","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/transfer-funds"},{"title":"Transfer positions between portfolios","openapi":"POST /api/v1/portfolios/transfer-position","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/transfer-positions"},{"title":"Update portfolio","openapi":"PUT /api/v1/portfolios/{portfolio}","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/update-portfolio"},{"title":"View max loan availability","openapi":"GET /api/v1/portfolios/{portfolio}/loans/{asset}/availability","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/portfolios/view-max-loan"}]},{"group":"Position Offsets","pages":[{"title":"List position offsets","openapi":"GET /api/v1/position-offsets","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/position-offsets/list-position-offsets"}]},{"group":"Rankings","pages":[{"title":"Get your rankings","openapi":"GET /api/v1/rankings/statistics","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/rankings/get-your-rankings"}]},{"group":"Transfers","pages":[{"title":"Create counterparty Id","openapi":"POST /api/v1/transfers/create-counterparty-id","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/create-counterparty-id"},{"title":"Create crypto address","openapi":"POST /api/v1/transfers/address","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/create-crypto-address"},{"title":"Get counterparty withdrawal limit","openapi":"GET /api/v1/transfers/withdraw/{portfolio}/{asset}/counterparty-withdrawal-limit","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/get-counterparty-withdrawal-limit"},{"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"},{"title":"Validate counterparty Id","openapi":"POST /api/v1/transfers/validate-counterparty-id","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/validate-counterparty-id"},{"title":"Withdraw to counterparty Id","openapi":"POST /api/v1/transfers/withdraw/counterparty","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/withdraw-to-counterparty-id"},{"title":"Withdraw to crypto address","openapi":"POST /api/v1/transfers/withdraw","playground":"simple","href":"/api-reference/international-exchange-api/rest-api/transfers/withdraw-to-crypto-address"}]}]},{"group":"FIX API","pages":[{"title":"INTX FIX API Overview","sidebarTitle":"Overview","href":"/international-exchange/fix-api/fix-api-overview"},{"title":"INTX FIX Dictionary Downloads","sidebarTitle":"Dictionary Downloads","href":"/international-exchange/fix-api/dictionary-downloads"},{"title":"INTX FIX Common Components","sidebarTitle":"Common Components","href":"/international-exchange/fix-api/common-components"},{"title":"INTX FIX Admin Messages","sidebarTitle":"Admin Messages","href":"/international-exchange/fix-api/admin-messages"},{"title":"INTX FIX Order Entry Messages","sidebarTitle":"Order Entry Messages","href":"/international-exchange/fix-api/order-entry-messages"},{"title":"INTX Take Profit Stop Loss Orders","sidebarTitle":"TPSL Orders","href":"/international-exchange/fix-api/tpsl-orders"},{"title":"INTX FIX Market Data Messages","sidebarTitle":"Market Data Messages","href":"/international-exchange/fix-api/market-data"},{"title":"INTX FIX Drop Copy Messages","sidebarTitle":"Drop Copy Messages","href":"/international-exchange/fix-api/drop-copy"}]},{"group":"WEBSOCKET FEED","pages":[{"title":"INTX WebSocket Overview","sidebarTitle":"Overview","href":"/international-exchange/websocket-feed/websocket-overview"},{"title":"INTX WebSocket Authentication","sidebarTitle":"Authentication","href":"/international-exchange/websocket-feed/authentication"},{"title":"INTX WebSocket Channels","sidebarTitle":"Channels","href":"/international-exchange/websocket-feed/channels"},{"title":"INTX WebSocket Errors","sidebarTitle":"Errors","href":"/international-exchange/websocket-feed/errors"}]}]},{"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":"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"},{"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":"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/entities/{entity_id}/conversion/fees","playground":"simple","title":"Get Conversion Fees (Beta)","href":"/api-reference/prime-api/rest-api/financing/get-conversion-fees-beta"},{"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}/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"},{"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"},{"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"},{"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"},{"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"},{"title":"Edit Order (Beta)","openapi":"PUT /v1/portfolios/{portfolio_id}/orders/{order_id}/edit","playground":"simple","href":"/api-reference/prime-api/rest-api/orders/edit-order-beta"}]},{"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 (Beta)","href":"/api-reference/prime-api/rest-api/products/get-public-product-candles-beta"},{"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 Data Dictionaries","sidebarTitle":"Prime FIX Data 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"},{"title":"Prime FIX Market Data Messages","sidebarTitle":"Market Data Messages","href":"/prime/fix-api/market-data"}]}]},{"group":"FIX 5.0 API","tag":"Beta","pages":[{"title":"Prime FIX 5.0 Messages","sidebarTitle":"Overview","href":"/prime/fix-5-0-api/overview"}]}]},{"dropdown":"Coinbase Derivatives API","icon":"https://mintlify-assets.b-cdn.net/derivativesProduct-2.svg","groups":[{"group":"REST API Overview","pages":[{"title":"Welcome to the Coinbase Derivatives REST API","sidebarTitle":"Overview","href":"/api-reference/derivatives-api/rest-api/introduction"},{"title":"Coinbase Derivatives 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":"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":"/get-started/demo-apps/learn"}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/get-started/changelog"}]}]},"basePath":"","title":"List x402 resources - Coinbase Developer Documentation","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}