{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kraken Developers","colors":{"primary":"#101114","light":"#FFFFFF","dark":"#101114"},"logo":{"light":"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/light.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=6be2f97a23f9a7aa6ef071ae334cc89c","dark":"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/dark.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=97e079a88bc1e9f156ed533a5f9d5d05"},"favicon":"https://mintcdn.com/kraken/qRZxIUN3tXcpjqG0/favicon.svg?fit=max\u0026auto=format\u0026n=qRZxIUN3tXcpjqG0\u0026q=85\u0026s=1215f433d712b5e667fd4e7599391422","api":{"examples":{"languages":["curl","python","javascript","go"]}},"appearance":{"default":"dark","strict":false},"navbar":{"primary":{"type":"button","label":"Get API key","href":"https://pro.kraken.com/app/settings/api"}},"footer":{"socials":{"x":"https://x.com/krakenfx","github":"https://github.com/krakenfx","linkedin":"https://linkedin.com/company/kraken-exchange"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kraken","hasAudioNarration":false,"actualSubdomain":"kraken","customDomains":["docs.kraken.com"],"gitSource":{"type":"gitlab","owner":"eng-devs","repo":"kraken-api-docs","hostUrl":"https://roshi-korin.honeycrypt.com","projectId":28500,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae409ffdeedd8eab56b09ad","collectionId":"fd382adb-1030-466c-89c7-7cb3f265aabc","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae409ffdeedd8eab56b09ad"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4bbf6af0623d0054ded3b","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":366},{"language":"default","tag":"Exchange","count":309},{"language":"default","tag":"Institutional","count":96},{"language":"default","tag":"Spot REST","count":81},{"language":"default","tag":"Derivatives REST","count":71},{"language":"default","tag":"Guides","count":45},{"language":"default","tag":"Market Data","count":39},{"language":"default","tag":"Session","count":31},{"language":"default","tag":"Trading","count":29},{"language":"default","tag":"Custody REST","count":25}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"@import url(https://assets.kraken.com/fonts/kraken.css);@import url(https://assets.kraken.com/fonts/celias.css);body,body *,html{font-family:var(--kp-font-sans)!important;-webkit-font-smoothing:antialiased}h1,h2,h3,h4{font-family:var(--kp-font-brand)!important}.prose h1,.prose h2,.prose h3,.prose h4,.prose h5,.prose h6{font-family:var(--kp-font-brand)!important;font-weight:500!important}.kp-mono,.kp-mono *,body [class*=Code],body [class*=code],body code,body code *,body kbd,body pre,body pre *,body samp{font-family:var(--kp-font-mono)!important}:root{--kp-primary:#101114;--kp-primary-hover:#2a2c33;--kp-brand:#7132f5;--kp-font-sans:'Kraken-Product', system-ui, -apple-system, sans-serif;--kp-font-mono:'Kraken-Mono', ui-monospace, monospace;--kp-font-brand:'Kraken-Brand', 'Celias', system-ui, sans-serif;--kp-bg-page:#f6f5f9;--kp-bg-card:#ffffff;--kp-bg-subtle:rgba(104, 107, 130, 0.12);--kp-text-heading:#101114;--kp-text-body:#686b82;--kp-text-placeholder:#9497a9;--kp-text-accent:#101114;--kp-text-meta:#9497a9;--kp-border:rgba(104, 107, 130, 0.16);--kp-terminal-bg:transparent;--kp-terminal-text:var(--kp-text-body);--kp-terminal-heading:var(--kp-text-heading);--kp-terminal-muted:var(--kp-text-placeholder)}html.dark{--kp-primary:#ffffff;--kp-primary-hover:#e7e7e7;--kp-brand:#8a61ff;--kp-bg-page:#0b0611;--kp-bg-card:#16121f;--kp-bg-subtle:rgba(255, 255, 255, 0.07);--kp-text-heading:#ffffff;--kp-text-body:#c6c7d2;--kp-text-placeholder:#9497a9;--kp-text-accent:#ffffff;--kp-text-meta:rgba(255, 255, 255, 0.45);--kp-border:rgba(255, 255, 255, 0.1)}@media (prefers-reduced-motion:reduce){.kp-terminal *,.kp-welcome-hero *{animation-duration:.01ms!important;animation-iteration-count:1!important;transition-duration:.01ms!important}}body,body #almond-background-color{background-color:var(--kp-bg-page)!important}.prose{--tw-prose-body:var(--kp-text-body)!important;--tw-prose-headings:var(--kp-text-heading)!important;--tw-prose-links:var(--kp-text-accent)!important;--tw-prose-bold:var(--kp-text-heading)!important;--tw-prose-code:var(--kp-text-heading)!important;--tw-prose-counters:var(--kp-text-body)!important;--tw-prose-bullets:var(--kp-text-placeholder)!important;--tw-prose-hr:var(--kp-border)!important;--tw-prose-quotes:var(--kp-text-body)!important;--tw-prose-quote-borders:var(--kp-border)!important;--tw-prose-th-borders:var(--kp-border)!important;--tw-prose-td-borders:var(--kp-border)!important}nav a,nav button{color:var(--kp-text-body)}nav a:hover,nav button:hover{color:var(--kp-text-heading)}.nav-logo{width:150px!important;height:auto!important}[data-component-part=field-root]{border-color:var(--kp-border)!important}[role=tablist] button[data-state=active]{color:var(--kp-text-heading)!important;border-color:var(--kp-primary)!important}[role=tablist] button[data-state=inactive]{color:var(--kp-text-placeholder)!important}body:has(.kp-welcome-hero) #header{display:none!important}@media (min-width:1024px){.kp-welcome-hero{display:grid;grid-template-columns:1fr 1fr;gap:2rem;align-items:start;margin-bottom:2.5rem}}.prose .kp-welcome-title{font-size:36px!important;line-height:1.15!important;letter-spacing:-.01em;margin:0 0 1rem!important}.kp-welcome-hero-code .code-group{margin-top:0!important;margin-bottom:0!important}.prose a.kp-hero-btn-primary{text-decoration:none!important;border:1px solid var(--kp-primary)!important;background-color:var(--kp-primary);color:var(--kp-bg-card)!important}.prose a.kp-hero-btn-primary:hover{background-color:var(--kp-primary-hover);border-color:var(--kp-primary-hover)!important}html.dark .prose a.kp-hero-btn-primary{color:var(--kp-bg-page)!important}.kp-terminal{background:var(--kp-terminal-bg)!important;border-color:var(--kp-border)!important}.kp-terminal.kp-terminal-card{background:var(--kp-bg-card)!important}.kp-terminal .kp-term-output{color:var(--kp-terminal-text)}.kp-terminal .kp-term-prompt-text{color:var(--kp-terminal-heading)!important}.kp-terminal .kp-term-cursor{background:var(--kp-terminal-heading)!important}.kp-terminal span[aria-hidden=true]:first-child{color:var(--kp-terminal-muted)!important}.kp-term-output,pre code{scrollbar-width:none}.kp-cli-install::-webkit-scrollbar,.kp-term-output::-webkit-scrollbar,pre code::-webkit-scrollbar{display:none}@media (max-width:480px){.kp-term-output{font-size:11px!important;padding:12px 14px!important}}.kp-cli-install{scrollbar-width:none}.kp-cli-copy-btn{transition:color .15s ease}.kp-cli-install:hover .kp-cli-copy-btn{color:var(--kp-text-heading)!important}.kp-cli-install:focus-visible{outline:2px solid var(--kp-brand);outline-offset:-2px}.kp-cli-copy-btn svg{transition:transform .15s ease}.kp-cli-install:hover .kp-cli-copy-btn svg{transform:scale(1.15)}.login-link{display:none!important}"},{"filePath":"global.css","content":"hr{margin-top:1rem!important;margin-bottom:1rem!important}[data-component-part=field-content]{margin-top:.25rem!important}.api-banner{display:flex;align-items:center;gap:.5rem;border:1px solid light-dark(#e5e6ec,#353746);box-shadow:0 0 0 5px light-dark(#fff,#0b0611),0 0 0 6px light-dark(#e5e6ec,#353746);border-radius:1rem;padding:.4rem;margin-bottom:.8rem}.api-banner .api-protocol{color:#fff;font-weight:800;font-size:12px;padding:.1rem .5rem;border-radius:1rem;text-transform:uppercase}.api-banner .api-protocol.ws{background:light-dark(#0079b4,#004e75)}.api-banner .api-protocol.fix{background:light-dark(#a67c1d,#6f5000)}.api-banner .api-detail,.api-banner .api-tag{font-family:var(--kp-font-mono);font-size:14px;color:light-dark(#484b5e,#9497a9)}.api-banner .api-tag{margin-left:auto;font-weight:600;font-size:12px;background:light-dark(#eeeff3,#292b38);color:light-dark(#484b5e,#c6c7d2);padding:.1rem 1.5rem;border-radius:.7rem}div:has(>.nav-tag-pill){order:-1;margin-left:0!important;margin-right:.9rem!important}.prose code:not(pre *){padding-inline:.15em}pre code{font-size:12px!important}[data-component-part=code-block-root],[data-component-part=code-group-tab-content]{line-height:1.25rem!important}#content-side-layout{position:relative!important;top:auto!important;height:auto!important;max-height:none!important}#header .prose{font-size:16px}.field-attr{font-weight:600;font-size:12px;line-height:16px;color:light-dark(#686b82,#9497a9)}"}],"page":{"pagePath":"api-reference/api-keys/check-v3-api-key","slug":"/api-reference/api-keys/check-v3-api-key","pageMetadata":{"title":"Check v3 API key","description":"Verify API key access and return the authenticated key's details.","deprecated":null,"version":null,"openapi":"/openapi/futures-auth-rest.yaml get /api-keys/v3/check","href":"/api-reference/api-keys/check-v3-api-key","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Verify API key access and return the authenticated key’s details.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Check v3 API key","description":"Verify API key access and return the authenticated key's details.","deprecated":null,"version":null,"openapi":"/openapi/futures-auth-rest.yaml get /api-keys/v3/check","href":"/api-reference/api-keys/check-v3-api-key","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"checkV3ApiKey","tags":["API Keys"],"summary":"Check v3 API key","description":"Verify API key access and return the authenticated key's details.","security":["bd56abef-172a-4362-a14c-6afb145d2ce0"],"responses":{"200":"098a655d-7f8c-4c69-b8f9-cd614390bc54","401":"6df177be-7c17-41ff-b2ef-5f319d40fd57"},"method":"get","type":"path","servers":["5301c924-7881-4438-98bb-7bfe2801a156"],"path":"/api-keys/v3/check","baseUrlOptions":["https://futures.kraken.com/api/auth/v1"],"title":"Check v3 API key","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"098a655d-7f8c-4c69-b8f9-cd614390bc54":{"description":"API key authentication is valid and details have been returned.","content":{"application/json":{"schema":{"type":"object","properties":{"apiKey":{"description":"API key that signed the request.","type":"string","format":"base64","example":"Gom9BsP75m41c9fuY6oJk/unMWaDZjYIcTP4/5kqPvtzdbj5JU5/Fyeb","isRequired":true,"uniqueKey":"apiKey","typeLabel":"file"},"accountUid":{"description":"UID of the account that the API key belongs to.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"accountUid","typeLabel":"string\u003cuuid>"},"iiban":{"oneOf":[{"type":"string","description":"IIBAN of the account that the API key belongs to.","pattern":"^AA[A-Z0-9]{2} [A-Z0-9]{4} [A-Z0-9]{4} [A-Z0-9]{4}$","x-rustType":"iiban::Iiban","example":"AA08 N84G CPAR UN7A","isRequired":true,"uniqueKey":"iiban.oneOf.0","typeLabel":"string"},{"type":"null","description":"IIBAN of the account that the API key belongs to.","isRequired":true,"uniqueKey":"iiban.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"iiban","typeLabel":"string | null"},"createdAt":{"description":"Date-time that the API key was created.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"permissions":{"type":"object","properties":{"general":{"description":"Tier of access granted to an API key.","type":"string","enum":["NO_ACCESS","READ_ONLY","FULL_ACCESS"],"x-exhaustive":true,"isRequired":true,"uniqueKey":"permissions.general","typeLabel":"enum\u003cstring>"},"transfer":{"description":"Tier of access granted to an API key.","type":"string","enum":["NO_ACCESS","READ_ONLY","FULL_ACCESS"],"x-exhaustive":true,"isRequired":true,"uniqueKey":"permissions.transfer","typeLabel":"enum\u003cstring>"}},"required":["general","transfer"],"description":"Permissions of the API key.","isRequired":true,"uniqueKey":"permissions","typeLabel":"object"},"allowedCidrBlock":{"oneOf":[{"type":"string","description":"Range of IP addresses that may use the API key.","format":"cidr","x-rustType":"ipnetwork::IpNetwork","example":"192.168.0.0/16","isRequired":true,"uniqueKey":"allowedCidrBlock.oneOf.0","typeLabel":"string\u003ccidr>"},{"type":"null","isRequired":true,"uniqueKey":"allowedCidrBlock.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"allowedCidrBlock","typeLabel":"string\u003ccidr> | null"},"allowedCidrBlocks":{"description":"Ranges of IP addresses that may use the API key.","type":"array","items":{"description":"Range of IP addresses that may use the API key.","type":"string","format":"cidr","example":"192.168.0.0/16","x-rustType":"ipnetwork::IpNetwork","uniqueKey":"allowedCidrBlocks.items.[INDEX]","typeLabel":"string\u003ccidr>"},"isRequired":true,"uniqueKey":"allowedCidrBlocks","typeLabel":"string\u003ccidr>[]"}},"required":["apiKey","accountUid","iiban","createdAt","permissions","allowedCidrBlock","allowedCidrBlocks"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"apiKey":"Gom9BsP75m41c9fuY6oJk/unMWaDZjYIcTP4/5kqPvtzdbj5JU5/Fyeb","accountUid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","iiban":"AA08 N84G CPAR UN7A","createdAt":"2019-08-24T14:15:22Z","permissions":{"general":"NO_ACCESS","transfer":"NO_ACCESS"},"allowedCidrBlock":"192.168.0.0/16","allowedCidrBlocks":["192.168.0.0/16"]}}},"exampleType":"generated"}},"exampleType":"generated"},"6df177be-7c17-41ff-b2ef-5f319d40fd57":{"description":"API key is not found or request signature is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"suberror":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"suberror.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"suberror.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"suberror","typeLabel":"string | null"}},"required":["error","message","suberror"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","suberror":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bd56abef-172a-4362-a14c-6afb145d2ce0":{"api-key-any":{"type":"apiKey","description":"API Key with any permissions.","in":"header","name":"apikey","x-inlineDescription":true,"scopes":[],"schemeName":"api-key-any"},"request-signature":{"type":"apiKey","description":"Request signature.","in":"header","name":"authent","x-inlineDescription":true,"scopes":[],"schemeName":"request-signature"}}},"servers":{"5301c924-7881-4438-98bb-7bfe2801a156":{"url":"https://futures.kraken.com/api/auth/v1","description":"Kraken Futures Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API Key with any permissions.","in":"header","name":"apikey","x-inlineDescription":true,"scopes":[],"schemeName":"api-key-any"},"schema":{"title":"apikey","type":"string","description":"API Key with any permissions.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key-any","name":"apikey"},{"scheme":{"type":"apiKey","description":"Request signature.","in":"header","name":"authent","x-inlineDescription":true,"scopes":[],"schemeName":"request-signature"},"schema":{"title":"authent","type":"string","description":"Request signature.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"request-signature","name":"authent"}],"title":"api-key-any \u0026 request-signature"}]},"originalFileLocation":"openapi/futures-auth-rest.yaml"},"subdomain":"kraken","siteName":"Kraken Developers","title":"Check v3 API key - Kraken Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T08:26:44.436Z","originalFileLocation":"api-reference/api-keys/check-v3-api-key.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Verify API key access and return the authenticated key\u0026#x27;s details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kraken Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Check v3 API key - Kraken Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Verify API key access and return the authenticated key\u0026#x27;s details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kraken Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kraken.mintlify.app/_mintlify/api/og/v2?division=API+Keys\u0026amp;title=Check+v3+API+key\u0026amp;description=Verify+API+key+access+and+return+the+authenticated+key%27s+details.\u0026amp;theme=5c8759ca94ea0060c63352cf\u0026amp;signature=50b9faefcade6acd96f32d7b5cb53fa75828ef2bd9c608630d647a9750774695\">\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=\"Check v3 API key - Kraken Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Verify API key access and return the authenticated key\u0026#x27;s details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kraken.mintlify.app/_mintlify/api/og/v2?division=API+Keys\u0026amp;title=Check+v3+API+key\u0026amp;description=Verify+API+key+access+and+return+the+authenticated+key%27s+details.\u0026amp;theme=5c8759ca94ea0060c63352cf\u0026amp;signature=50b9faefcade6acd96f32d7b5cb53fa75828ef2bd9c608630d647a9750774695\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/kraken/WtiP_7MUCtGxw5vL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kraken Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#101114\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/api-keys/check-v3-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kraken.com/#organization\",\"name\":\"Kraken Developers\",\"url\":\"https://docs.kraken.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kraken/opwCJHYUnRFWd1O3/logo/light.svg?fit=max\u0026auto=format\u0026n=opwCJHYUnRFWd1O3\u0026q=85\u0026s=6be2f97a23f9a7aa6ef071ae334cc89c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kraken.com#website\",\"name\":\"Kraken Developers\",\"url\":\"https://docs.kraken.com\",\"publisher\":{\"@id\":\"https://docs.kraken.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key#webpage\",\"url\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key\",\"name\":\"Check v3 API key\",\"description\":\"Verify API key access and return the authenticated key's details.\",\"dateModified\":\"2026-10-14T08:26:44.436Z\",\"isPartOf\":{\"@id\":\"https://docs.kraken.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Kraken Developers\",\"item\":\"https://docs.kraken.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Check v3 API key\",\"item\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key#apireference\",\"headline\":\"Check v3 API key\",\"name\":\"Check v3 API key\",\"description\":\"Verify API key access and return the authenticated key's details.\",\"url\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kraken.com/api-reference/api-keys/check-v3-api-key#webpage\"},\"dateModified\":\"2026-10-14T08:26:44.436Z\",\"publisher\":{\"@id\":\"https://docs.kraken.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kraken.com#website\"}}]}\u003c/script>","siteName":"Kraken Developers","nav":{"global":{},"products":[{"product":"Home","pages":[{"title":"Home","href":""}]},{"product":"Exchange","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/exchange/guides/overview"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"Exchange API reference","sidebarTitle":"Overview","href":"/exchange/api-reference/overview"}]},{"dropdown":"Spot REST","icon":"code","groups":[{"group":"Market Data","public":true,"pages":[{"title":"Get Server Time","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Time","href":"/api-reference/market-data/get-server-time"},{"title":"Get System Status","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/SystemStatus","href":"/api-reference/market-data/get-system-status"},{"title":"Get Maintenance Schedule","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/MaintenanceSchedule","href":"/api-reference/market-data/get-maintenance-schedule"},{"title":"Get Asset Info","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Assets","href":"/api-reference/market-data/get-asset-info"},{"title":"Get Tradable Asset Pairs","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/AssetPairs","href":"/api-reference/market-data/get-tradable-asset-pairs"},{"title":"Get Ticker Information","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Ticker","href":"/api-reference/market-data/get-ticker-information"},{"title":"Get OHLC Data","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/OHLC","href":"/api-reference/market-data/get-ohlc-data"},{"title":"Get Order Book","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Depth","href":"/api-reference/market-data/get-order-book"},{"title":"Query L3 Order Book","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Level3","href":"/api-reference/market-data/query-l3-order-book"},{"title":"Get Grouped Order Book","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/GroupedBook","href":"/api-reference/market-data/get-grouped-order-book"},{"title":"Get Recent Trades","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Trades","href":"/api-reference/market-data/get-recent-trades"},{"title":"Get Recent Spreads","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/Spread","href":"/api-reference/market-data/get-recent-spreads"}]},{"group":"Account Data","public":true,"pages":[{"title":"Get Account Balance","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Balance","href":"/api-reference/account-data/get-account-balance"},{"title":"Get Extended Balance","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/BalanceEx","href":"/api-reference/account-data/get-extended-balance"},{"title":"Get Credit Lines","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CreditLines","href":"/api-reference/account-data/get-credit-lines"},{"title":"Get Trade Balance","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/TradeBalance","href":"/api-reference/account-data/get-trade-balance"},{"title":"Get Open Orders","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/OpenOrders","href":"/api-reference/account-data/get-open-orders"},{"title":"Get Closed Orders","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/ClosedOrders","href":"/api-reference/account-data/get-closed-orders"},{"title":"Query Orders Info","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/QueryOrders","href":"/api-reference/account-data/query-orders-info"},{"title":"Get Order Amends","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/OrderAmends","href":"/api-reference/account-data/get-order-amends"},{"title":"Get Trades History","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/TradesHistory","href":"/api-reference/account-data/get-trades-history"},{"title":"Query Trades Info","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/QueryTrades","href":"/api-reference/account-data/query-trades-info"},{"title":"Get Open Positions","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/OpenPositions","href":"/api-reference/account-data/get-open-positions"},{"title":"Get Ledgers Info","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Ledgers","href":"/api-reference/account-data/get-ledgers-info"},{"title":"Query Ledgers","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/QueryLedgers","href":"/api-reference/account-data/query-ledgers"},{"title":"Get Trade Volume","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/TradeVolume","href":"/api-reference/account-data/get-trade-volume"},{"title":"Request Export Report","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AddExport","href":"/api-reference/account-data/request-export-report"},{"title":"Get Export Report Status","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/ExportStatus","href":"/api-reference/account-data/get-export-report-status"},{"title":"Retrieve Data Export","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/RetrieveExport","href":"/api-reference/account-data/retrieve-data-export"},{"title":"Delete Export Report","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/RemoveExport","href":"/api-reference/account-data/delete-export-report"},{"title":"Get API Key Info","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/GetApiKeyInfo","href":"/api-reference/account-data/get-api-key-info"},{"title":"List Wallet Accounts","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/ListWalletAccounts","href":"/api-reference/account-data/list-wallet-accounts"}]},{"group":"Trading","public":true,"pages":[{"title":"Add Order","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AddOrder","href":"/api-reference/trading/add-order"},{"title":"Amend Order","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AmendOrder","href":"/api-reference/trading/amend-order"},{"title":"Edit Order","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/EditOrder","href":"/api-reference/trading/edit-order"},{"title":"Cancel Order","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CancelOrder","href":"/api-reference/trading/cancel-order"},{"title":"Cancel All Orders","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CancelAll","href":"/api-reference/trading/cancel-all-orders"},{"title":"Cancel All Orders After X","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CancelAllOrdersAfter","href":"/api-reference/trading/cancel-all-orders-after-x"},{"title":"Add Order Batch","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AddOrderBatch","href":"/api-reference/trading/add-order-batch"},{"title":"Cancel Order Batch","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CancelOrderBatch","href":"/api-reference/trading/cancel-order-batch"},{"title":"Get Websockets Token","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/GetWebSocketsToken","href":"/api-reference/trading/get-websockets-token"}]},{"group":"Algo Trading","public":true,"pages":[{"title":"Add Strategy","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AddStrategy","href":"/api-reference/algo-trading/add-strategy"},{"title":"Cancel Strategy","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CancelStrategy","href":"/api-reference/algo-trading/cancel-strategy"},{"title":"Get Open Strategies","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/GetOpenStrategies","href":"/api-reference/algo-trading/get-open-strategies"},{"title":"Query Strategies","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/QueryStrategies","href":"/api-reference/algo-trading/query-strategies"},{"title":"Get Closed Strategies","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/GetClosedStrategies","href":"/api-reference/algo-trading/get-closed-strategies"}]},{"group":"Funding (Beta)","public":true,"pages":[{"title":"Calculate Funding Fees","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/fees/{method_id}","href":"/api-reference/funding-beta/calculate-funding-fees"},{"title":"Claim Funding Deposit Address","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml put /funding/v1/deposit/address","href":"/api-reference/funding-beta/claim-funding-deposit-address"},{"title":"Create Funding Address","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /funding/v1/addresses","href":"/api-reference/funding-beta/create-funding-address"},{"title":"Create Funding Withdrawal","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /funding/v1/withdrawals","href":"/api-reference/funding-beta/create-funding-withdrawal"},{"title":"Delete Funding Address","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml delete /funding/v1/addresses/{id}","href":"/api-reference/funding-beta/delete-funding-address"},{"title":"List Funding Addresses","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/addresses","href":"/api-reference/funding-beta/list-funding-addresses"},{"title":"List Funding Assets","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/assets/{direction}","href":"/api-reference/funding-beta/list-funding-assets"},{"title":"List Funding Claimed Addresses (v2)","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v2/deposit/addresses","href":"/api-reference/funding-beta/list-funding-claimed-addresses-v2"},{"title":"List Funding Deposit Limits","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/limits/deposit/{asset_class}/{asset}","href":"/api-reference/funding-beta/list-funding-deposit-limits"},{"title":"List Funding Deposits","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/deposits","href":"/api-reference/funding-beta/list-funding-deposits"},{"title":"List Funding Methods","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/methods/{direction}","href":"/api-reference/funding-beta/list-funding-methods"},{"title":"List Funding Networks","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/networks","href":"/api-reference/funding-beta/list-funding-networks"},{"title":"List Funding Withdrawal Limits","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/limits/withdrawal/{asset_class}/{asset}","href":"/api-reference/funding-beta/list-funding-withdrawal-limits"},{"title":"List Funding Withdrawals","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /funding/v1/withdrawals","href":"/api-reference/funding-beta/list-funding-withdrawals"},{"title":"Update Funding Address","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml put /funding/v1/addresses/{id}","href":"/api-reference/funding-beta/update-funding-address"}]},{"group":"Funding (Legacy)","public":true,"pages":[{"title":"Get Deposit Methods","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/DepositMethods","href":"/api-reference/funding/get-deposit-methods"},{"title":"Get Deposit Addresses","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/DepositAddresses","href":"/api-reference/funding/get-deposit-addresses"},{"title":"Get Status of Recent Deposits","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/DepositStatus","href":"/api-reference/funding/get-status-of-recent-deposits"},{"title":"Get Withdrawal Methods","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WithdrawMethods","href":"/api-reference/funding/get-withdrawal-methods"},{"title":"Get Withdrawal Addresses","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WithdrawAddresses","href":"/api-reference/funding/get-withdrawal-addresses"},{"title":"Get Withdrawal Information","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WithdrawInfo","href":"/api-reference/funding/get-withdrawal-information"},{"title":"Withdraw Funds","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Withdraw","href":"/api-reference/funding/withdraw-funds"},{"title":"Get Status of Recent Withdrawals","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WithdrawStatus","href":"/api-reference/funding/get-status-of-recent-withdrawals"},{"title":"Request Withdrawal Cancellation","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WithdrawCancel","href":"/api-reference/funding/request-withdrawal-cancellation"},{"title":"Request Wallet Transfer","deprecated":true,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/WalletTransfer","href":"/api-reference/funding/request-wallet-transfer"}]},{"group":"Subaccounts","public":true,"pages":[{"title":"Create Subaccount","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/CreateSubaccount","href":"/api-reference/subaccounts/create-subaccount"},{"title":"Account Transfer","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/AccountTransfer","href":"/api-reference/subaccounts/account-transfer"}]},{"group":"Earn","public":true,"pages":[{"title":"List Earn Strategies","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/Strategies","href":"/api-reference/earn/list-earn-strategies"},{"title":"List Earn Allocations","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/Allocations","href":"/api-reference/earn/list-earn-allocations"},{"title":"Allocate Earn Funds","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/Allocate","href":"/api-reference/earn/allocate-earn-funds"},{"title":"Deallocate Earn Funds","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/Deallocate","href":"/api-reference/earn/deallocate-earn-funds"},{"title":"Get Allocation Status","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/AllocateStatus","href":"/api-reference/earn/get-allocation-status"},{"title":"Get Deallocation Status","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml post /private/Earn/DeallocateStatus","href":"/api-reference/earn/get-deallocation-status"}]},{"group":"Transparency","public":true,"pages":[{"title":"Pre-Trade Data","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/PreTrade","href":"/api-reference/transparency/pre-trade-data"},{"title":"Post-Trade Data","deprecated":null,"version":null,"openapi":"/openapi/spot-rest.yaml get /public/PostTrade","href":"/api-reference/transparency/post-trade-data"}]}]},{"dropdown":"Affiliate REST","icon":"users","groups":[{"group":"Affiliate reporting","public":true,"pages":[{"title":"Get Daily Activity","deprecated":null,"version":null,"openapi":"/openapi/affiliate-rest.yaml get /affiliate/v1/daily-activity","href":"/api-reference/affiliate/get-daily-activity"},{"title":"Get CPA Progress","deprecated":null,"version":null,"openapi":"/openapi/affiliate-rest.yaml get /affiliate/v1/cpa-progress","href":"/api-reference/affiliate/get-cpa-progress"},{"title":"Get Payout History","deprecated":null,"version":null,"openapi":"/openapi/affiliate-rest.yaml get /affiliate/v1/payout-history","href":"/api-reference/affiliate/get-payout-history"}]}]},{"dropdown":"Spot WebSocket v2","icon":"bolt","pages":[{"title":"Spot WebSocket","sidebarTitle":"Spot WebSocket","href":"/exchange/api-reference/spot-websocket"},{"group":"Public Channels","public":true,"pages":[{"title":"Ticker","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/ticker"},{"title":"Book (Level 2)","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/book"},{"title":"Candles (OHLC)","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/ohlc"},{"title":"Trades","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/trade"},{"title":"Instruments","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/instrument"},{"title":"Orders (Level 3)","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/level3"},{"title":"Status","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/status"},{"title":"Heartbeat","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/heartbeat"}]},{"group":"Trading","public":true,"pages":[{"title":"Add Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/add_order"},{"title":"Edit Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/edit_order"},{"title":"Amend Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/amend_order"},{"title":"Cancel Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/cancel_order"},{"title":"Cancel All","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/cancel_all"},{"title":"Cancel on Disconnect","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/cancel_after"},{"title":"Batch Add","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/batch_add"},{"title":"Batch Cancel","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/batch_cancel"}]},{"group":"Account","public":true,"pages":[{"title":"Balances","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/balances"},{"title":"Executions","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/executions"}]},{"group":"System","public":true,"pages":[{"title":"Ping","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v2/ping"}]}]},{"dropdown":"Unified WebSocket","icon":"lock","hidden":true,"groups":[{"group":"Public Channels","public":true,"pages":[{"title":"Ticker","tag":"UWS","href":"/exchange/api-reference/unified-ws/ticker"},{"title":"Book (Level 2)","tag":"UWS","href":"/exchange/api-reference/unified-ws/book"},{"title":"Candles (OHLC)","tag":"UWS","href":"/exchange/api-reference/unified-ws/ohlc"},{"title":"Trades","tag":"UWS","href":"/exchange/api-reference/unified-ws/trade"},{"title":"Instruments","tag":"UWS","href":"/exchange/api-reference/unified-ws/instrument"},{"title":"Orders (Level 3)","tag":"UWS","href":"/exchange/api-reference/unified-ws/level3"},{"title":"Status","tag":"UWS","href":"/exchange/api-reference/unified-ws/status"},{"title":"Heartbeat","tag":"UWS","href":"/exchange/api-reference/unified-ws/heartbeat"}]},{"group":"Trading","public":true,"pages":[{"title":"Add Order","tag":"UWS","href":"/exchange/api-reference/unified-ws/add_order"},{"title":"Amend Order","tag":"UWS","href":"/exchange/api-reference/unified-ws/amend_order"},{"title":"Cancel Order","tag":"UWS","href":"/exchange/api-reference/unified-ws/cancel_order"},{"title":"Cancel All","tag":"UWS","href":"/exchange/api-reference/unified-ws/cancel_all"},{"title":"Cancel on Disconnect","tag":"UWS","href":"/exchange/api-reference/unified-ws/cancel_after"}]},{"group":"Account","public":true,"pages":[{"title":"Balances","tag":"UWS","href":"/exchange/api-reference/unified-ws/balances"},{"title":"Executions","tag":"UWS","href":"/exchange/api-reference/unified-ws/executions"},{"title":"Ledgers","tag":"UWS","href":"/exchange/api-reference/unified-ws/ledgers"},{"title":"Margin","tag":"UWS","href":"/exchange/api-reference/unified-ws/margin"},{"title":"Positions","tag":"UWS","href":"/exchange/api-reference/unified-ws/positions"},{"title":"Preferences","tag":"UWS","href":"/exchange/api-reference/unified-ws/preferences"}]},{"group":"System","public":true,"pages":[{"title":"Ping","tag":"UWS","href":"/exchange/api-reference/unified-ws/ping"}]}]},{"dropdown":"Spot WebSocket v1","icon":"bolt","groups":[{"group":"Public Channels","public":true,"pages":[{"title":"Ticker","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/ticker"},{"title":"Candles (OHLC)","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/ohlc"},{"title":"Trade","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/trade"},{"title":"Spread","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/spread"},{"title":"Book","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/book"}]},{"group":"Trading","public":true,"pages":[{"title":"Add Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/addorder"},{"title":"Edit Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/editorder"},{"title":"Amend Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/amendorder"},{"title":"Cancel Order","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/cancelorder"},{"title":"Cancel All","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/cancelall"},{"title":"Cancel on Disconnect","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/cancelallordersafter"}]},{"group":"Account","public":true,"pages":[{"title":"Own Trades","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/owntrades"},{"title":"Open Orders","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/openorders"}]},{"group":"System","public":true,"pages":[{"title":"Ping","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/ping"},{"title":"Heartbeat","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/heartbeat"},{"title":"System Status","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/systemstatus"},{"title":"Subscription Status","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/subscriptionstatus"},{"title":"Unsubscribe","tag":"WSS","href":"/exchange/api-reference/spot-websocket-v1/unsubscribe"}]}]},{"dropdown":"Derivatives REST","icon":"code","groups":[{"group":"Market Data","public":true,"pages":[{"title":"Get tickers","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /tickers","href":"/api-reference/market-data/get-tickers"},{"title":"Get ticker by symbol","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /tickers/{symbol}","href":"/api-reference/market-data/get-ticker-by-symbol"},{"title":"Get orderbook","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /orderbook","href":"/api-reference/market-data/get-orderbook"},{"title":"Get trade history","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /history","href":"/api-reference/market-data/get-trade-history"}]},{"group":"Instruments","public":true,"pages":[{"title":"Get instruments","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /instruments","href":"/api-reference/instrument-details/get-instruments"},{"title":"Get trading instruments","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /trading/instruments","href":"/api-reference/instrument-details/get-trading-instruments"},{"title":"Get instrument status list","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /instruments/status","href":"/api-reference/instrument-details/get-instrument-status-list"},{"title":"Get instrument status","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /instruments/{symbol}/status","href":"/api-reference/instrument-details/get-instrument-status"}]},{"group":"Order Management","public":true,"pages":[{"title":"Send order","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /sendorder","href":"/api-reference/order-management/send-order"},{"title":"Edit order","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /editorder","href":"/api-reference/order-management/edit-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /cancelorder","href":"/api-reference/order-management/cancel-order"},{"title":"Cancel all orders","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /cancelallorders","href":"/api-reference/order-management/cancel-all-orders"},{"title":"Dead man's switch","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /cancelallordersafter","href":"/api-reference/order-management/dead-mans-switch"},{"title":"Batch order management","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /batchorder","href":"/api-reference/order-management/batch-order-management"},{"title":"Get open orders","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /openorders","href":"/api-reference/order-management/get-open-orders"},{"title":"Get Specific Orders' Status","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /orders/status","href":"/api-reference/order-management/get-specific-orders-status"}]},{"group":"Account","public":true,"pages":[{"title":"Get wallets","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /accounts","href":"/api-reference/account-information/get-wallets"},{"title":"Get open positions","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /openpositions","href":"/api-reference/account-information/get-open-positions"},{"title":"Get position percentile of unwind queue","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /unwindqueue","href":"/api-reference/account-information/get-position-percentile-of-unwind-queue"},{"title":"Get portfolio margin parameters","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /portfolio-margining/parameters","href":"/api-reference/account-information/get-portfolio-margin-parameters"},{"title":"Calculate portfolio margin, pnl and greeks","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /portfolio-margining/simulate","href":"/api-reference/account-information/calculate-portfolio-margin-pnl-and-greeks"}]},{"group":"Multi-Collateral","public":true,"pages":[{"title":"Get PNL currency preferences","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /pnlpreferences","href":"/api-reference/multi-collateral/get-pnl-currency-preferences"},{"title":"Set PNL currency preference","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml put /pnlpreferences","href":"/api-reference/multi-collateral/set-pnl-currency-preference"},{"title":"Get leverage settings","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /leveragepreferences","href":"/api-reference/multi-collateral/get-leverage-settings"},{"title":"Set leverage settings","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml put /leveragepreferences","href":"/api-reference/multi-collateral/set-leverage-settings"}]},{"group":"Fee Schedules","public":true,"pages":[{"title":"Get fee schedules","deprecated":true,"version":null,"openapi":"/openapi/futures-rest.yaml get /feeschedules","href":"/api-reference/fee-schedules/get-fee-schedules"},{"title":"Get fee schedule volumes","deprecated":true,"version":null,"openapi":"/openapi/futures-rest.yaml get /feeschedules/volumes","href":"/api-reference/fee-schedules/get-fee-schedule-volumes"}]},{"group":"Historical Data","public":true,"pages":[{"title":"Get your fills","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /fills","href":"/api-reference/historical-data/get-your-fills"},{"title":"Historical funding rates","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /historical-funding-rates","href":"/api-reference/historical-funding-rates/historical-funding-rates"}]},{"group":"Trading Settings","public":true,"pages":[{"title":"Get self trade strategy","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /self-trade-strategy","href":"/api-reference/trading-settings/get-self-trade-strategy"},{"title":"Update self trade strategy","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml put /self-trade-strategy","href":"/api-reference/trading-settings/update-self-trade-strategy"},{"title":"Get the off-book max leverage cap","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfq-assignment/max-leverage","href":"/api-reference/trading-settings/get-the-off-book-max-leverage-cap"},{"title":"Set the off-book max leverage cap","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml put /rfq-assignment/max-leverage","href":"/api-reference/trading-settings/set-the-off-book-max-leverage-cap"},{"title":"Clear the off-book max leverage cap","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml delete /rfq-assignment/max-leverage","href":"/api-reference/trading-settings/clear-the-off-book-max-leverage-cap"}]},{"group":"Subaccounts","public":true,"pages":[{"title":"Get subaccounts","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /subaccounts","href":"/api-reference/subaccounts/get-subaccounts"},{"title":"Check subaccount trading status","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /subaccount/{subaccountUid}/trading-enabled","href":"/api-reference/subaccounts/check-subaccount-trading-status"},{"title":"Update subaccount trading status","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml put /subaccount/{subaccountUid}/trading-enabled","href":"/api-reference/subaccounts/update-subaccount-trading-status"}]},{"group":"Transfers","public":true,"pages":[{"title":"Initiate wallet transfer","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /transfer","href":"/api-reference/transfers/initiate-wallet-transfer"},{"title":"Initiate sub account transfer","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /transfer/subaccount","href":"/api-reference/transfers/initiate-sub-account-transfer"},{"title":"Initiate withdrawal to Spot wallet","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /withdrawal","href":"/api-reference/transfers/initiate-withdrawal-to-spot-wallet"}]},{"group":"Assignment Program","public":true,"pages":[{"title":"List assignment programs","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /assignmentprogram/current","href":"/api-reference/assignment-program/list-assignment-programs"},{"title":"Add assignment preference","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /assignmentprogram/add","href":"/api-reference/assignment-program/add-assignment-preference"},{"title":"Deletes assignment preference","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /assignmentprogram/delete","href":"/api-reference/assignment-program/deletes-assignment-preference"},{"title":"List assignment preferences history","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /assignmentprogram/history","href":"/api-reference/assignment-program/list-assignment-preferences-history"}]},{"group":"RFQs","public":true,"pages":[{"title":"List all open RFQs","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfqs","href":"/api-reference/rfqs/list-all-open-rfqs"},{"title":"Retrieve a single RFQ (open or recently closed)","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfqs/{rfqUid}","href":"/api-reference/rfqs/retrieve-a-single-rfq-open-or-recently-closed"},{"title":"List open offers on open RFQs","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfqs/open-offers","href":"/api-reference/rfqs/list-open-offers-on-open-rfqs"},{"title":"List offers placed by the account on closed RFQs","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfqs/closed-offers","href":"/api-reference/rfqs/list-offers-placed-by-the-account-on-closed-rfqs"},{"title":"Place new offer on an open RFQ","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /rfqs/place-offer/{rfqUid}","href":"/api-reference/rfqs/place-new-offer-on-an-open-rfq"},{"title":"Cancel open offer on open RFQ","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml delete /rfqs/cancel-offer/{rfqUid}","href":"/api-reference/rfqs/cancel-open-offer-on-open-rfq"},{"title":"List open RFQs for account","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /rfqs/open-rfqs","href":"/api-reference/rfqs/list-open-rfqs-for-account"},{"title":"Create a new RFQ","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /rfqs/open-rfqs","href":"/api-reference/rfqs/create-a-new-rfq"},{"title":"Cancel an open RFQ","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml delete /rfqs/open-rfqs/{rfqUid}","href":"/api-reference/rfqs/cancel-an-open-rfq"},{"title":"Accept an offer on an open RFQ","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml post /rfqs/open-rfqs/accept-offer/{rfqUid}","href":"/api-reference/rfqs/accept-an-offer-on-an-open-rfq"}]},{"group":"General","public":true,"pages":[{"title":"Get notifications","deprecated":null,"version":null,"openapi":"/openapi/futures-rest.yaml get /notifications","href":"/api-reference/general/get-notifications"}]},{"group":"Account History","public":true,"pages":[{"title":"Get execution events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /executions","href":"/api-reference/account-history/get-execution-events"},{"title":"Get order events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /orders","href":"/api-reference/account-history/get-order-events"},{"title":"Get trigger events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /triggers","href":"/api-reference/account-history/get-trigger-events"},{"title":"Get position update events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /positions","href":"/api-reference/account-history/get-position-update-events"},{"title":"Get account log","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /account-log","href":"/api-reference/account-history/get-account-log"},{"title":"Account log (CSV)","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /accountlogcsv","href":"/api-reference/account-history/account-log-csv"}]},{"group":"Market History","public":true,"pages":[{"title":"Get public execution events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /market/{tradeable}/executions","href":"/api-reference/market-history/get-public-execution-events"},{"title":"Get public order events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /market/{tradeable}/orders","href":"/api-reference/market-history/get-public-order-events"},{"title":"Get public mark price events","deprecated":null,"version":null,"openapi":"/openapi/futures-history-rest.yaml get /market/{tradeable}/price","href":"/api-reference/market-history/get-public-mark-price-events"}]},{"group":"Candles","public":true,"pages":[{"title":"Tick Types","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /","href":"/api-reference/candles/tick-types"},{"title":"Markets","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /{tick_type}","href":"/api-reference/candles/markets"},{"title":"Resolutions","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /{tick_type}/{symbol}","href":"/api-reference/candles/resolutions"},{"title":"Market Candles","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /{tick_type}/{symbol}/{resolution}","href":"/api-reference/candles/market-candles"}]},{"group":"Analytics","public":true,"pages":[{"title":"Get liquidity pool statistic","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /analytics/liquidity-pool","href":"/api-reference/analytics/get-liquidity-pool-statistic"},{"title":"Market Analytics","description":"Analytics data divided into time buckets","deprecated":null,"version":null,"openapi":"/openapi/futures-charts-rest.yaml get /analytics/{symbol}/{analytics_type}","href":"/api-reference/analytics/market-analytics"}]},{"group":"API Keys","public":true,"pages":[{"title":"Check v3 API key","deprecated":null,"version":null,"openapi":"/openapi/futures-auth-rest.yaml get /api-keys/v3/check","href":"/api-reference/api-keys/check-v3-api-key"}]}]},{"dropdown":"Derivatives WebSocket","icon":"bolt","pages":[{"title":"Derivatives WebSocket","sidebarTitle":"Derivatives WebSocket","description":"Real-time market data and account streaming for the Kraken Derivatives WebSocket API","href":"/exchange/api-reference/futures-websocket"},{"group":"Public Channels","public":true,"pages":[{"title":"Ticker","tag":"WSS","href":"/exchange/api-reference/futures-websocket/ticker"},{"title":"Ticker Lite","tag":"WSS","href":"/exchange/api-reference/futures-websocket/ticker_lite"},{"title":"Trade","tag":"WSS","href":"/exchange/api-reference/futures-websocket/trade"},{"title":"Book","tag":"WSS","href":"/exchange/api-reference/futures-websocket/book"},{"title":"Heartbeat","tag":"WSS","href":"/exchange/api-reference/futures-websocket/heartbeat"}]},{"group":"Private Channels","public":true,"pages":[{"title":"Balances","tag":"WSS","href":"/exchange/api-reference/futures-websocket/balances"},{"title":"Fills","tag":"WSS","href":"/exchange/api-reference/futures-websocket/fills"},{"title":"Open Orders","tag":"WSS","href":"/exchange/api-reference/futures-websocket/open_orders"},{"title":"Open Orders (Verbose)","tag":"WSS","href":"/exchange/api-reference/futures-websocket/open_orders_verbose"},{"title":"Open Positions","tag":"WSS","href":"/exchange/api-reference/futures-websocket/open_position"},{"title":"Account Log","tag":"WSS","href":"/exchange/api-reference/futures-websocket/account_log"},{"title":"Notifications","tag":"WSS","href":"/exchange/api-reference/futures-websocket/notifications"}]},{"group":"Authentication","public":true,"pages":[{"title":"Challenge","tag":"WSS","href":"/exchange/api-reference/futures-websocket/challenge"}]}]},{"dropdown":"Unified FIX","icon":"terminal","pages":[{"title":"Unified FIX","sidebarTitle":"Unified FIX","href":"/exchange/api-reference/unified-fix"},{"group":"Trading","public":true,"pages":[{"title":"New Order Single","tag":"FIX","href":"/exchange/api-reference/unified-fix/nos"},{"title":"Order Cancel Request","sidebarTitle":"Cancel Order","tag":"FIX","href":"/exchange/api-reference/unified-fix/ocr"},{"title":"Order Cancel Replace Request","sidebarTitle":"Cancel Replace","tag":"FIX","href":"/exchange/api-reference/unified-fix/ocrr"},{"title":"Order Status Request","sidebarTitle":"Order Status","tag":"FIX","href":"/exchange/api-reference/unified-fix/osr"},{"title":"Order Mass Cancel Request","sidebarTitle":"Mass Cancel","tag":"FIX","href":"/exchange/api-reference/unified-fix/omcr"},{"title":"Execution Report","tag":"FIX","href":"/exchange/api-reference/unified-fix/er"}]},{"group":"Market Data","public":true,"pages":[{"title":"Instrument List Request","sidebarTitle":"Instrument List Req","tag":"FIX","href":"/exchange/api-reference/unified-fix/slr"},{"title":"Instrument List","tag":"FIX","href":"/exchange/api-reference/unified-fix/sl"},{"title":"Market Data Request","tag":"FIX","href":"/exchange/api-reference/unified-fix/mdr"},{"title":"Market Data Request Reject","sidebarTitle":"MD Request Reject","tag":"FIX","href":"/exchange/api-reference/unified-fix/mdrr"},{"title":"Market Data Snapshot Full Refresh","sidebarTitle":"MD Snapshot Full Refresh","tag":"FIX","href":"/exchange/api-reference/unified-fix/mdsfr"},{"title":"Market Data Incremental Refresh","sidebarTitle":"MD Incremental Refresh","tag":"FIX","href":"/exchange/api-reference/unified-fix/mdir"},{"title":"News","sidebarTitle":"News","tag":"FIX","href":"/exchange/api-reference/unified-fix/news"},{"title":"Trading Session Status Request","sidebarTitle":"Session Status Request","tag":"FIX","href":"/exchange/api-reference/unified-fix/tssr"},{"title":"Trading Session Status","sidebarTitle":"Session Status","tag":"FIX","href":"/exchange/api-reference/unified-fix/tss"}]},{"group":"Session","public":true,"pages":[{"title":"Header \u0026 Trailer","tag":"FIX","href":"/exchange/api-reference/unified-fix/header-trailer"},{"title":"Logon","tag":"FIX","href":"/exchange/api-reference/unified-fix/logon"},{"title":"Logout","tag":"FIX","href":"/exchange/api-reference/unified-fix/logout"},{"title":"Resend Request","tag":"FIX","href":"/exchange/api-reference/unified-fix/resend-request"},{"title":"Reject - Session Level","sidebarTitle":"Session Reject","tag":"FIX","href":"/exchange/api-reference/unified-fix/reject-session"},{"title":"Reject - Business Level","sidebarTitle":"Business Reject","tag":"FIX","href":"/exchange/api-reference/unified-fix/reject-business"},{"title":"Sequence Reset","tag":"FIX","href":"/exchange/api-reference/unified-fix/sequence-reset"}]}]},{"dropdown":"SBE","icon":"chart-line","pages":[{"title":"SBE","sidebarTitle":"SBE","href":"/exchange/api-reference/sbe"},{"group":"Session","public":true,"pages":[{"title":"Negotiate","tag":"SBE","href":"/exchange/api-reference/sbe/negotiate"},{"title":"NegotiationResponse","tag":"SBE","href":"/exchange/api-reference/sbe/negotiation-response"},{"title":"NegotiationReject","tag":"SBE","href":"/exchange/api-reference/sbe/negotiation-reject"},{"title":"AdminHeartbeat","tag":"SBE","href":"/exchange/api-reference/sbe/admin-heartbeat"},{"title":"SubscriberHeartbeat","tag":"SBE","href":"/exchange/api-reference/sbe/subscriber-heartbeat"},{"title":"Terminate","tag":"SBE","href":"/exchange/api-reference/sbe/terminate"},{"title":"SubscriptionRequest","tag":"SBE","href":"/exchange/api-reference/sbe/subscription-request"},{"title":"SubscriptionResponse","tag":"SBE","href":"/exchange/api-reference/sbe/subscription-response"},{"title":"Session enums \u0026 encodings","tag":"SBE","href":"/exchange/api-reference/sbe/session-types"}]},{"group":"Market Data","public":true,"pages":[{"title":"InstrumentDefinitionSnapshot","tag":"SBE","href":"/exchange/api-reference/sbe/instrument-definition-snapshot"},{"title":"OrderBookIncremental","tag":"SBE","href":"/exchange/api-reference/sbe/order-book-incremental"},{"title":"TradeIncremental","tag":"SBE","href":"/exchange/api-reference/sbe/trade-incremental"},{"title":"OrderBookSnapshot","tag":"SBE","href":"/exchange/api-reference/sbe/order-book-snapshot"},{"title":"InstrumentStatusIncremental","tag":"SBE","href":"/exchange/api-reference/sbe/instrument-status-incremental"},{"title":"TradingSessionStatusIncremental","tag":"SBE","href":"/exchange/api-reference/sbe/trading-session-status-incremental"},{"title":"InstrumentDefinitionIncremental","tag":"SBE","href":"/exchange/api-reference/sbe/instrument-definition-incremental"},{"title":"TradingSessionStatusSnapshot","tag":"SBE","href":"/exchange/api-reference/sbe/trading-session-status-snapshot"},{"title":"Market data enums \u0026 encodings","tag":"SBE","href":"/exchange/api-reference/sbe/market-data-types"}]}]},{"dropdown":"Drop Copy","icon":"copy","hidden":true,"pages":[{"title":"Drop Copy","sidebarTitle":"Drop Copy","href":"/exchange/api-reference/drop-copy"},{"group":"Session","public":true,"pages":[{"title":"Logon","tag":"FIX","href":"/exchange/api-reference/drop-copy/logon"},{"title":"Logout","tag":"FIX","href":"/exchange/api-reference/drop-copy/logout"},{"title":"Heartbeat","tag":"FIX","href":"/exchange/api-reference/drop-copy/heartbeat"},{"title":"Test Request","tag":"FIX","href":"/exchange/api-reference/drop-copy/test-request"},{"title":"Resend Request","tag":"FIX","href":"/exchange/api-reference/drop-copy/resend-request"},{"title":"Sequence Reset","tag":"FIX","href":"/exchange/api-reference/drop-copy/sequence-reset"},{"title":"Reject","tag":"FIX","href":"/exchange/api-reference/drop-copy/reject"},{"title":"Header \u0026 Trailer","tag":"FIX","href":"/exchange/api-reference/drop-copy/header-trailer"}]},{"group":"Execution","public":true,"pages":[{"title":"Execution Report","tag":"FIX","href":"/exchange/api-reference/drop-copy/er"}]}]},{"dropdown":"Unified FIX v2","icon":"terminal","pages":[{"title":"Unified FIX v2","sidebarTitle":"Unified FIX v2","href":"/exchange/api-reference/unified-fix-v2"},{"group":"Session","public":true,"pages":[{"title":"Logon","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/logon"},{"title":"Logout","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/logout"},{"title":"Heartbeat","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/heartbeat"},{"title":"Test Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/test-request"},{"title":"Resend Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/resend-request"},{"title":"Sequence Reset","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/sequence-reset"},{"title":"Header \u0026 Trailer","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/header-trailer"}]},{"group":"Order Entry","public":true,"pages":[{"title":"New Order Single","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/nos"},{"title":"Order Cancel Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/ocr"},{"title":"Order Cancel Replace Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/ocrr"},{"title":"Order Mass Cancel Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/omcr"},{"title":"Order Status Request","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/osr"}]},{"group":"Execution \u0026 Rejects","public":true,"pages":[{"title":"Execution Report","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/er"},{"title":"Order Cancel Reject","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/ocj"},{"title":"Reject (Session)","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/reject-session"},{"title":"Business Message Reject","tag":"FIX","href":"/exchange/api-reference/unified-fix-v2/reject-business"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/exchange/changelog"}]}]},{"product":"Institutional","pages":[{"title":"Institutional","href":"/institutional/guides/overview"}]},{"product":"Pay","pages":[{"title":"Pay","href":"/pay/guides/pay-webhook"}]},{"product":"Nodes","hidden":true,"pages":[{"title":"Nodes","href":"/nodes/guides/introduction"}]}]},"title":"Check v3 API key - Kraken Developers","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}