Accounts the key may act on. Each must be one the caller has access to.
When omitted, the key covers every account the caller can access. When
provided, the key is restricted to exactly those accounts.
Permissions to grant the key, intersected per request with the caller's
current permissions on the requested account (so a key can never
out-rank its owner). When omitted, the key is granted full permissions
and behaves as the user.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AX - Architect Exchange Docs","colors":{"primary":"#7bc9ff","light":"#0099ff","dark":"#0099ff"},"logo":{"light":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/light.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=4d22d6ccaea2329d7d235919f126dfc8","dark":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/dark.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=090614f78e5518059377b7965773cad1"},"favicon":"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/favicon.png?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=1cfa6ede544a434eea76dca196669f4e","navbar":{"links":[{"href":"mailto:support@architect.co","label":"Support"}],"primary":{"type":"button","label":"AX Sandbox","href":"https://sandbox.architect.exchange"}},"footer":{"socials":{"x":"https://x.com/","github":"https://github.com/","linkedin":"https://linkedin.com/company"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"architectfinancialtechnologiesinc","hasAudioNarration":false,"actualSubdomain":"architectfinancialtechnologiesinc","customDomains":["docs.architect.exchange"],"gitSource":{"type":"github","owner":"architect-xyz","repo":"ax-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acd633f2df4f53e3cb12a5b","collectionId":"d1f8e1a7-2ae0-40b6-87c3-5f46df10c2de","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acd633f2df4f53e3cb12a5b"},"entitlements":{},"buildId":"6acd633f2df4f53e3cb12a5b","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"Marketdata","count":14},{"language":"default","tag":"Order entry and management","count":10},{"language":"default","tag":"Portfolio management","count":9},{"language":"default","tag":"Candles","count":6},{"language":"default","tag":"User management","count":6},{"language":"default","tag":"Funding \u0026 Settlement","count":5},{"language":"default","tag":"How to Get Started","count":5},{"language":"default","tag":"About Us","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/user-management/create-api-key","slug":"/api-reference/user-management/create-api-key","pageMetadata":{"title":"Create API key","openapi":"openapi/api-gateway.json POST /api-keys","description":null,"href":"/api-reference/user-management/create-api-key"},"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":"Create API key","openapi":"openapi/api-gateway.json POST /api-keys","description":null,"href":"/api-reference/user-management/create-api-key"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["api-gateway"],"operationId":"create_api_key","requestBody":"b491239c-3fa9-4b2a-9275-6ec1555cafe4","responses":{"200":"c55892d0-81ab-4e56-a795-8410162ff379","401":"3c0ff0bc-5a40-479f-930d-aecfcb480258"},"security":["20762ba4-cb10-4c19-baf9-2deaeab09d0f"],"method":"post","type":"path","servers":["2daf5b66-2159-4ffe-8112-91a73625fa36"],"path":"/api-keys","baseUrlOptions":["https://gateway.architect.exchange/api"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"account_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Accounts the key may act on. Each must be one the caller has access to.\nWhen omitted, the key covers every account the caller can access. When\nprovided, the key is restricted to exactly those accounts.","uniqueKey":"account_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Accounts the key may act on. Each must be one the caller has access to.\nWhen omitted, the key covers every account the caller can access. When\nprovided, the key is restricted to exactly those accounts.","uniqueKey":"account_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"account_ids","typeLabel":"string[] | null"},"allowed_ips":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"allowed_ips.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"allowed_ips.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"allowed_ips.oneOf.1","typeLabel":"null"}],"uniqueKey":"allowed_ips","typeLabel":"string[] | null"},"permissions":{"oneOf":[{"type":"null","uniqueKey":"permissions.oneOf.0","typeLabel":"null"},{"type":"object","description":"Permissions to grant the key, intersected per request with the caller's\ncurrent permissions on the requested account (so a key can never\nout-rank its owner). When omitted, the key is granted full permissions\nand behaves as the user.","required":["can_list","can_read","can_set_limits","can_reduce_or_close","can_trade"],"properties":{"can_list":{"type":"boolean","isRequired":true,"uniqueKey":"permissions.oneOf.1.can_list","typeLabel":"boolean"},"can_read":{"type":"boolean","isRequired":true,"uniqueKey":"permissions.oneOf.1.can_read","typeLabel":"boolean"},"can_reduce_or_close":{"type":"boolean","isRequired":true,"uniqueKey":"permissions.oneOf.1.can_reduce_or_close","typeLabel":"boolean"},"can_set_limits":{"type":"boolean","isRequired":true,"uniqueKey":"permissions.oneOf.1.can_set_limits","typeLabel":"boolean"},"can_trade":{"type":"boolean","isRequired":true,"uniqueKey":"permissions.oneOf.1.can_trade","typeLabel":"boolean"}},"uniqueKey":"permissions.oneOf.1","typeLabel":"object"}],"uniqueKey":"permissions","typeLabel":"null | object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_ids":["\u003cstring>"],"allowed_ips":["\u003cstring>"],"permissions":{"can_list":true,"can_read":true,"can_reduce_or_close":true,"can_set_limits":true,"can_trade":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"c55892d0-81ab-4e56-a795-8410162ff379":{"description":"API key created successfully","content":{"application/json":{"schema":{"type":"object","required":["api_key","api_secret"],"properties":{"api_key":{"type":"string","isRequired":true,"uniqueKey":"api_key","typeLabel":"string"},"api_secret":{"type":"string","isRequired":true,"uniqueKey":"api_secret","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"api_key":"\u003cstring>","api_secret":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3c0ff0bc-5a40-479f-930d-aecfcb480258":{"description":"Invalid credentials","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"20762ba4-cb10-4c19-baf9-2deaeab09d0f":{"session_token":{"type":"http","scheme":"bearer","description":"User session token","scopes":[],"schemeName":"session_token"}}},"servers":{"2daf5b66-2159-4ffe-8112-91a73625fa36":{"url":"https://gateway.architect.exchange/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"User session token","scopes":[],"schemeName":"session_token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User session token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"session_token","name":"Authorization"}],"title":"session_token"}]},"originalFileLocation":"openapi/api-gateway.json"},"subdomain":"architectfinancialtechnologiesinc","siteName":"AX - Architect Exchange Docs","title":"Create API key - AX - Architect Exchange Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T21:25:34.842Z","originalFileLocation":"api-reference/user-management/create-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=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create API key - AX - Architect Exchange Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.architect.exchange/api-reference/user-management/create-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://architectfinancialtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=User+management\u0026amp;title=Create+API+key\u0026amp;theme=b2862bb0f68d7e13aef94a0d\u0026amp;signature=e7ecc7d1c1a5d0a5d1ff0084c800b1926ab3a4879477f00acb773a58cd429be7\">\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=\"Create API key - AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://architectfinancialtechnologiesinc.mintlify.app/_mintlify/api/og/v2?division=User+management\u0026amp;title=Create+API+key\u0026amp;theme=b2862bb0f68d7e13aef94a0d\u0026amp;signature=e7ecc7d1c1a5d0a5d1ff0084c800b1926ab3a4879477f00acb773a58cd429be7\">\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/architectfinancialtechnologiesinc/4wdrUypUrPQJEj8e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AX - Architect Exchange Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7bc9ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.architect.exchange/api-reference/user-management/create-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/user-management/create-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.architect.exchange/#organization\",\"name\":\"AX - Architect Exchange Docs\",\"url\":\"https://docs.architect.exchange\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/architectfinancialtechnologiesinc/4XOQAImBIXImMchB/logo/light.svg?fit=max\u0026auto=format\u0026n=4XOQAImBIXImMchB\u0026q=85\u0026s=4d22d6ccaea2329d7d235919f126dfc8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.architect.exchange#website\",\"name\":\"AX - Architect Exchange Docs\",\"url\":\"https://docs.architect.exchange\",\"publisher\":{\"@id\":\"https://docs.architect.exchange/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key#webpage\",\"url\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key\",\"name\":\"Create API key\",\"dateModified\":\"2026-10-05T21:25:34.842Z\",\"isPartOf\":{\"@id\":\"https://docs.architect.exchange#website\"},\"breadcrumb\":{\"@id\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"User management\",\"item\":\"https://docs.architect.exchange/api-reference/user-management/get-whoami\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create API key\",\"item\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key#apireference\",\"headline\":\"Create API key\",\"name\":\"Create API key\",\"url\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.architect.exchange/api-reference/user-management/create-api-key#webpage\"},\"dateModified\":\"2026-10-05T21:25:34.842Z\",\"publisher\":{\"@id\":\"https://docs.architect.exchange/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.architect.exchange#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AX - Architect Exchange Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AX - Architect Exchange Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"User management","pages":[{"title":"Get current user details","openapi":"openapi/api-gateway.json GET /whoami","href":"/api-reference/user-management/get-whoami"},{"title":"Logout","openapi":"openapi/api-gateway.json POST /logout","href":"/api-reference/user-management/logout"},{"title":"Get API keys","openapi":"openapi/api-gateway.json GET /api-keys","description":null,"href":"/api-reference/user-management/get-api-keys"},{"title":"Create API key","openapi":"openapi/api-gateway.json POST /api-keys","href":"/api-reference/user-management/create-api-key"},{"title":"Revoke API key","openapi":"openapi/api-gateway.json DELETE /api-keys","description":null,"href":"/api-reference/user-management/revoke-api-key"},{"title":"Get auth token","openapi":"openapi/api-gateway.json POST /authenticate","href":"/api-reference/user-management/authenticate"}]},{"group":"Liquidity program","pages":[{"title":"List liquidity programs","openapi":"openapi/api-gateway.json GET /mmlp/v2/programs","href":"/api-reference/liquidity-program/get-programs"},{"title":"Get reward accruals","openapi":"openapi/api-gateway.json GET /mmlp/v2/reward-accruals","href":"/api-reference/liquidity-program/get-reward-accruals"},{"title":"Get score snapshots","openapi":"openapi/api-gateway.json GET /mmlp/v2/{symbol}/score-snapshots","href":"/api-reference/liquidity-program/get-score-snapshots"}]},{"group":"Symbols and instruments","pages":[{"title":"Get instruments","openapi":"openapi/api-gateway.json GET /instruments","href":"/api-reference/symbols-instruments/get-instruments"},{"title":"Get instrument","openapi":"openapi/api-gateway.json GET /instrument","href":"/api-reference/symbols-instruments/get-instrument"}]},{"group":"Marketdata","pages":[{"group":"Candles","pages":[{"group":"OHLC Candles","pages":[{"title":"Get candles","openapi":"openapi/api-gateway.json GET /candles","href":"/api-reference/marketdata/get-candles"},{"title":"Get current candle","openapi":"openapi/api-gateway.json GET /candles/current","href":"/api-reference/marketdata/get-current-candle"},{"title":"Get last candle","openapi":"openapi/api-gateway.json GET /candles/last","href":"/api-reference/marketdata/get-last-candle"}]},{"group":"BBO Candles","pages":[{"title":"Get BBO candles","openapi":"openapi/api-gateway.json GET /bbo-candles","href":"/api-reference/marketdata/get-bbo-candles"},{"title":"Get current BBO candle","openapi":"openapi/api-gateway.json GET /bbo-candles/current","href":"/api-reference/marketdata/get-current-bbo-candle"},{"title":"Get last BBO candle","openapi":"openapi/api-gateway.json GET /bbo-candles/last","href":"/api-reference/marketdata/get-last-bbo-candle"}]}]},{"title":"Get tickers","openapi":"openapi/api-gateway.json GET /tickers","href":"/api-reference/marketdata/get-tickers"},{"title":"Get ticker","openapi":"openapi/api-gateway.json GET /ticker","href":"/api-reference/marketdata/get-ticker"},{"title":"Get trades","openapi":"openapi/api-gateway.json GET /trades","href":"/api-reference/marketdata/get-trades"},{"title":"Get orderbook","openapi":"openapi/api-gateway.json GET /book","href":"/api-reference/marketdata/get-book"},{"title":"Preview aggressive limit order","openapi":"openapi/api-gateway.json POST /preview-aggressive-limit-order","href":"/api-reference/marketdata/preview-aggressive-limit-order"},{"title":"Get funding rates","openapi":"openapi/api-gateway.json GET /funding-rates","href":"/api-reference/marketdata/get-funding-rates"},{"title":"Get upcoming special settlements","openapi":"openapi/api-gateway.json GET /special-settlements-pending","href":"/api-reference/marketdata/get-upcoming-special-settlements"},{"title":"Websocket marketdata","asyncapi":"openapi/asyncapi-marketdata-publisher.bundled.json marketdata","href":"/api-reference/marketdata/md-ws"}]},{"group":"Portfolio management","pages":[{"title":"Get balances","openapi":"openapi/api-gateway.json GET /balances","href":"/api-reference/portfolio-management/get-balances"},{"title":"Get fills","openapi":"openapi/api-gateway.json GET /fills","href":"/api-reference/portfolio-management/get-fills"},{"title":"Get liquidations","openapi":"openapi/api-gateway.json GET /liquidations","href":"/api-reference/portfolio-management/get-liquidations"},{"title":"Get positions","openapi":"openapi/api-gateway.json GET /positions","href":"/api-reference/portfolio-management/get-positions"},{"title":"Get risk snapshot","openapi":"openapi/api-gateway.json GET /risk-snapshot","href":"/api-reference/portfolio-management/get-risk-snapshot"},{"title":"Get transactions","openapi":"openapi/api-gateway.json GET /transactions","href":"/api-reference/portfolio-management/get-transactions"},{"title":"Get funding transactions","openapi":"openapi/api-gateway.json GET /funding-transactions","href":"/api-reference/portfolio-management/get-funding-transactions"},{"title":"Sandbox deposit","openapi":"openapi/api-gateway.json POST /sandbox/deposit","href":"/api-reference/portfolio-management/sandbox-deposit"},{"title":"Sandbox withdrawal","openapi":"openapi/api-gateway.json POST /sandbox/withdraw","href":"/api-reference/portfolio-management/sandbox-withdrawal"}]},{"group":"Order entry and management","pages":[{"title":"Get open orders","openapi":"openapi/order-gateway.json GET /open-orders","href":"/api-reference/order-management/get-open-orders"},{"title":"Get historical orders","openapi":"openapi/order-gateway.json GET /orders","href":"/api-reference/order-management/get-orders"},{"title":"Place order","openapi":"openapi/order-gateway.json POST /place-order","href":"/api-reference/order-management/place-order"},{"title":"Cancel order","openapi":"openapi/order-gateway.json POST /cancel-order","href":"/api-reference/order-management/cancel-order"},{"title":"Cancel all orders","openapi":"openapi/order-gateway.json POST /cancel-all-orders","href":"/api-reference/order-management/cancel-all-orders"},{"title":"Replace order","openapi":"openapi/order-gateway.json POST /replace-order","href":"/api-reference/order-management/replace-order"},{"title":"Search order status","openapi":"openapi/order-gateway.json GET /order-status","href":"/api-reference/order-management/get-order-status"},{"title":"See order fills","openapi":"openapi/order-gateway.json GET /order-fills","href":"/api-reference/order-management/get-order-fills"},{"title":"Calculate initial margin requirement","openapi":"openapi/order-gateway.json POST /initial-margin-requirement","href":"/api-reference/order-management/calculate-initial-margin-requirement"},{"title":"Websocket orders","asyncapi":"openapi/asyncapi-order-gateway.bundled.json orders","href":"/api-reference/order-management/orders-ws"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Create API key - AX - Architect Exchange Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}