{ "data": [ { "id": "ibx_3f9a0c7e12d4", "name": "grid-bot", "state": "creating", "size": "small", "mode": "paper", "runtime": "python", "markets": [ "perps", "outcomes" ], "region": "tokyo", "created_at": 1762520000000, "url": "https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4", "dashboard": "https://ironflow.sh/ironbox", "message": "Your Ironbox is being set up. We email you when it is ready." } ]}
{
"error": {
"code": "UNAUTHORIZED",
"message": "this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"
}
}
Ironbox
List your Ironboxes
GET /v1/ironbox lists the calling key’s Ironboxes, newest first.
{ "data": [ { "id": "ibx_3f9a0c7e12d4", "name": "grid-bot", "state": "creating", "size": "small", "mode": "paper", "runtime": "python", "markets": [ "perps", "outcomes" ], "region": "tokyo", "created_at": 1762520000000, "url": "https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4", "dashboard": "https://ironflow.sh/ironbox", "message": "Your Ironbox is being set up. We email you when it is ready." } ]}
{
"error": {
"code": "UNAUTHORIZED",
"message": "this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"
}
}
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Ironflow","colors":{"primary":"#B24E24","light":"#C45A2D","dark":"#A03D18"},"favicon":"https://mintcdn.com/ironflow/CrJwR04LYaIKFosO/favicon.svg?fit=max\u0026auto=format\u0026n=CrJwR04LYaIKFosO\u0026q=85\u0026s=fee2e1a6dea606cb489f6d9c8018d4c7","logo":{"light":"https://mintcdn.com/ironflow/CrJwR04LYaIKFosO/logo/light.svg?fit=max\u0026auto=format\u0026n=CrJwR04LYaIKFosO\u0026q=85\u0026s=2c50490df26c7762ab71eb17be6ad76e","dark":"https://mintcdn.com/ironflow/CrJwR04LYaIKFosO/logo/dark.svg?fit=max\u0026auto=format\u0026n=CrJwR04LYaIKFosO\u0026q=85\u0026s=1edf4ce6b050aed52ad875ebcb746b22"},"api":{"openapi":"openapi.yaml"},"appearance":{"default":"dark","strict":null},"background":{"decoration":null,"color":{"light":"#F4F2EF","dark":"#0A0A0A"}},"navbar":{"links":[{"label":"Website","href":"https://ironflow.sh"},{"label":"Status","href":"https://status.ironflow.sh"}],"primary":{"type":"button","label":"Get a free key","href":"https://ironflow.sh/key?utm_source=docs_topbar"}},"search":{"prompt":"Search docs..."},"footer":{"socials":{"x":"https://x.com/ironflowsh"},"links":[{"header":"Legal","items":[{"label":"Terms","href":"https://ironflow.sh/terms"},{"label":"API terms","href":"https://ironflow.sh/terms#api"},{"label":"Privacy","href":"https://ironflow.sh/privacy"},{"label":"Risk disclosure","href":"https://ironflow.sh/risk-disclosure"},{"label":"Acknowledgements","href":"https://ironflow.sh/acknowledgements"}]},{"header":"Ironflow","items":[{"label":"Website","href":"https://ironflow.sh"},{"label":"Terminal","href":"https://terminal.ironflow.sh"},{"label":"Status","href":"https://status.ironflow.sh"}]}]},"fonts":{"heading":{"family":"Space Grotesk","weight":600,"format":"woff2","source":"https://ironflow.sh/fonts/space-grotesk-latin-var.woff2"},"body":{"family":"Space Grotesk","weight":400,"format":"woff2","source":"https://ironflow.sh/fonts/space-grotesk-latin-var.woff2"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ironflow","hasAudioNarration":false,"actualSubdomain":"ironflow","customDomains":["docs.ironflow.sh"],"gitSource":{"type":"github","owner":"eternaut1","repo":"ironflow","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aef5b8b59edac7bace69fa1","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":122},{"language":"default","tag":"Documentation","count":23},{"language":"default","tag":"Market Data","count":18},{"language":"default","tag":"Analytics","count":10},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Concepts","count":8},{"language":"default","tag":"Wallet Analytics","count":7},{"language":"default","tag":"Keys and billing","count":5},{"language":"default","tag":"System","count":5},{"language":"default","tag":"Alerts","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/ironbox/list-ironboxes","slug":"/api-reference/ironbox/list-ironboxes","pageMetadata":{"title":"List your Ironboxes","sidebarTitle":"List Ironboxes","description":"GET /v1/ironbox lists the calling key's Ironboxes, newest first.","openapi":"GET /v1/ironbox","href":"/api-reference/ironbox/list-ironboxes"},"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: \"GET /v1/ironbox lists the calling key’s Ironboxes, newest first.\"\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":"List your Ironboxes","sidebarTitle":"List Ironboxes","description":"GET /v1/ironbox lists the calling key's Ironboxes, newest first.","openapi":"GET /v1/ironbox","href":"/api-reference/ironbox/list-ironboxes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ironflow/fdad569770b855d6/posthog.js"],"openApiReferenceData":{"operation":{"operationId":"listIronboxes","summary":"List your Ironboxes","description":"GET /v1/ironbox lists the calling key's Ironboxes, newest first.","tags":["Ironbox"],"security":["d817fd36-28ab-4c0a-947b-255319abe088"],"responses":{"200":"67b73ea0-6329-47cc-bd86-9fb88e5ca435","401":"f90ade75-85b0-4e6b-9fde-b4982018fd6e"},"method":"get","type":"path","servers":["e75206a2-6bd3-4f62-989c-f57c1c4fa178"],"path":"/v1/ironbox","baseUrlOptions":["https://api.ironflow.sh"],"title":"List your Ironboxes","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"67b73ea0-6329-47cc-bd86-9fb88e5ca435":{"description":"The key's Ironboxes.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","state","size","mode","runtime","markets","region","created_at","url","dashboard","message"],"properties":{"id":{"type":"string","pattern":"^ibx_[0-9a-f]{12}$","example":"ibx_3f9a0c7e12d4","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Empty when none was given.","example":"grid-bot","isRequired":true,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"state":{"type":"string","enum":["creating","running","stopped","deleted","error"],"isRequired":true,"uniqueKey":"data.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"size":{"type":"string","enum":["small","medium","large"],"isRequired":true,"uniqueKey":"data.items.[INDEX].size","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["paper","live"],"isRequired":true,"uniqueKey":"data.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"runtime":{"type":"string","enum":["python","node"],"isRequired":true,"uniqueKey":"data.items.[INDEX].runtime","typeLabel":"enum\u003cstring>"},"markets":{"type":"array","items":{"type":"string","enum":["perps","outcomes","spot"],"uniqueKey":"data.items.[INDEX].markets.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.items.[INDEX].markets","typeLabel":"enum\u003cstring>[]"},"region":{"type":"string","enum":["tokyo"],"isRequired":true,"uniqueKey":"data.items.[INDEX].region","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","format":"int64","description":"Unix milliseconds","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"integer\u003cint64>"},"url":{"type":"string","format":"uri","description":"GET it for the box's state; DELETE it to delete the box.","isRequired":true,"uniqueKey":"data.items.[INDEX].url","typeLabel":"string\u003curi>"},"dashboard":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.items.[INDEX].dashboard","typeLabel":"string\u003curi>"},"message":{"type":"string","description":"What the state means","in one line.":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].message","typeLabel":"string"}},"example":{"id":"ibx_3f9a0c7e12d4","name":"grid-bot","state":"creating","size":"small","mode":"paper","runtime":"python","markets":["perps","outcomes"],"region":"tokyo","created_at":1762520000000,"url":"https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4","dashboard":"https://ironflow.sh/ironbox","message":"Your Ironbox is being set up. We email you when it is ready."},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"ibx_3f9a0c7e12d4","name":"grid-bot","state":"creating","size":"small","mode":"paper","runtime":"python","markets":["perps","outcomes"],"region":"tokyo","created_at":1762520000000,"url":"https://api.ironflow.sh/v1/ironbox/ibx_3f9a0c7e12d4","dashboard":"https://ironflow.sh/ironbox","message":"Your Ironbox is being set up. We email you when it is ready."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f90ade75-85b0-4e6b-9fde-b4982018fd6e":{"description":"No API key. Any key works, a free one included.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","example":"RATE_LIMIT_EXCEEDED","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","example":"Rate limit exceeded. Retry after 60 seconds.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"upgrade":{"type":"object","description":"On a limit a higher plan lifts, the next plan, its price, what it lifts and the call that gets it.","uniqueKey":"error.upgrade","typeLabel":"object"},"ironbox":{"type":"object","description":"On a rate limit, the keyless daily cap, the stream limit and the SQL time budget, how to run the agent in an Ironbox instead.","properties":{"why":{"type":"string","example":"No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box.","uniqueKey":"error.ironbox.why","typeLabel":"string"},"create":{"type":"string","example":"POST https://api.ironflow.sh/v1/ironbox","uniqueKey":"error.ironbox.create","typeLabel":"string"},"url":{"type":"string","format":"uri","example":"https://ironflow.sh/ironbox?utm_source=api","uniqueKey":"error.ironbox.url","typeLabel":"string\u003curi>"}},"uniqueKey":"error.ironbox","typeLabel":"object"},"stream":{"type":"string","description":"On the keyless daily limit of `/v1/liquidations` and `/v1/trades`, the live stream that replaces polling.","example":"GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams)","uniqueKey":"error.stream","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"this request needs an API key. Free keys: https://ironflow.sh/key?utm_source=api, or POST https://api.ironflow.sh/v1/keys with {\"email\": \"[email protected]\"} (the key arrives by email)"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d817fd36-28ab-4c0a-947b-255319abe088":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e75206a2-6bd3-4f62-989c-f57c1c4fa178":{"url":"https://api.ironflow.sh","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"ironflow","siteName":"Ironflow","title":"List your Ironboxes - Ironflow","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T13:20:24.564Z","originalFileLocation":"api-reference/ironbox/list-ironboxes.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=\"GET /v1/ironbox lists the calling key\u0026#x27;s Ironboxes, newest first.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ironflow\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_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/ironflow/byzI622w4A47enFn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List your Ironboxes - Ironflow\">\u003cmeta data-mint-head property=\"og:description\" content=\"GET /v1/ironbox lists the calling key\u0026#x27;s Ironboxes, newest first.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ironflow\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ironflow.mintlify.site/_mintlify/api/og/v2?division=Ironbox\u0026amp;title=List+your+Ironboxes\u0026amp;description=GET+%2Fv1%2Fironbox+lists+the+calling+key%27s+Ironboxes%2C+newest+first.\u0026amp;theme=65db10876e49f8f53e58cbae\u0026amp;signature=9ba0f8d90e7a8e75e2d1008bf0c9556ab6529d5af03cd2b3e36347f920d5d255\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List your Ironboxes - Ironflow\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GET /v1/ironbox lists the calling key\u0026#x27;s Ironboxes, newest first.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ironflow.mintlify.site/_mintlify/api/og/v2?division=Ironbox\u0026amp;title=List+your+Ironboxes\u0026amp;description=GET+%2Fv1%2Fironbox+lists+the+calling+key%27s+Ironboxes%2C+newest+first.\u0026amp;theme=65db10876e49f8f53e58cbae\u0026amp;signature=9ba0f8d90e7a8e75e2d1008bf0c9556ab6529d5af03cd2b3e36347f920d5d255\">\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/ironflow/byzI622w4A47enFn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ironflow\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#B24E24\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ironbox/list-ironboxes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ironflow.sh/#organization\",\"name\":\"Ironflow\",\"url\":\"https://docs.ironflow.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ironflow/CrJwR04LYaIKFosO/logo/light.svg?fit=max\u0026auto=format\u0026n=CrJwR04LYaIKFosO\u0026q=85\u0026s=2c50490df26c7762ab71eb17be6ad76e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ironflow.sh#website\",\"name\":\"Ironflow\",\"url\":\"https://docs.ironflow.sh\",\"publisher\":{\"@id\":\"https://docs.ironflow.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes#webpage\",\"url\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes\",\"name\":\"List your Ironboxes\",\"description\":\"GET /v1/ironbox lists the calling key's Ironboxes, newest first.\",\"dateModified\":\"2026-11-07T13:20:24.564Z\",\"isPartOf\":{\"@id\":\"https://docs.ironflow.sh#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.ironflow.sh/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ironbox\",\"item\":\"https://docs.ironflow.sh/api-reference/ironbox/create-ironbox\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List your Ironboxes\",\"item\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes#apireference\",\"headline\":\"List your Ironboxes\",\"name\":\"List your Ironboxes\",\"description\":\"GET /v1/ironbox lists the calling key's Ironboxes, newest first.\",\"url\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ironflow.sh/api-reference/ironbox/list-ironboxes#webpage\"},\"dateModified\":\"2026-11-07T13:20:24.564Z\",\"publisher\":{\"@id\":\"https://docs.ironflow.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ironflow.sh#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ironflow\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ironflow","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Ironflow REST API reference","sidebarTitle":"API Reference","href":"/api-reference/introduction"},{"group":"Market Data","pages":[{"title":"List Hyperliquid markets","sidebarTitle":"List Markets","openapi":"GET /v1/markets","href":"/api-reference/market-data/list-markets"},{"title":"Hyperliquid markets snapshot","sidebarTitle":"Markets snapshot","openapi":"GET /v1/markets/snapshot","href":"/api-reference/market-data/markets-snapshot"},{"title":"Hyperliquid trade history","sidebarTitle":"List Trades","openapi":"GET /v1/trades","href":"/api-reference/market-data/list-trades"},{"title":"Hyperliquid order book (L2)","sidebarTitle":"Order Book","openapi":"GET /v1/book","href":"/api-reference/market-data/order-book"},{"title":"Hyperliquid fills by address","sidebarTitle":"List Fills","openapi":"GET /v1/fills","href":"/api-reference/market-data/list-fills"},{"title":"Hyperliquid liquidation history","sidebarTitle":"List Liquidations","openapi":"GET /v1/liquidations","href":"/api-reference/market-data/list-liquidations"},{"title":"Hyperliquid liquidation totals by market and window","sidebarTitle":"Liquidations summary","openapi":"GET /v1/liquidations/summary","href":"/api-reference/market-data/liquidations-summary"},{"title":"Hyperliquid auto-deleveraging (ADL) fills","sidebarTitle":"Auto-Deleveraging","openapi":"GET /v1/adl","href":"/api-reference/market-data/auto-deleveraging"},{"title":"Hyperliquid liquidations live stream","sidebarTitle":"Stream Liquidations","openapi":"GET /v1/liquidations/stream","href":"/api-reference/market-data/stream-liquidations"},{"title":"Hyperliquid trades live stream","sidebarTitle":"Stream Trades","openapi":"GET /v1/trades/stream","href":"/api-reference/market-data/stream-trades"},{"title":"Hyperliquid OHLCV candles","sidebarTitle":"List Candles","openapi":"GET /v1/candles","href":"/api-reference/market-data/list-candles"},{"title":"Hyperliquid funding rate history","sidebarTitle":"List Funding Rates","openapi":"GET /v1/funding","href":"/api-reference/market-data/list-funding-rates"},{"title":"Hyperliquid open interest history","sidebarTitle":"List Open Interest","openapi":"GET /v1/open-interest","href":"/api-reference/market-data/list-open-interest"},{"title":"Hyperliquid open interest movers","sidebarTitle":"Open Interest Changes","openapi":"GET /v1/open-interest/changes","href":"/api-reference/market-data/open-interest-changes"},{"title":"Hyperliquid mark vs oracle premium","sidebarTitle":"Premium","openapi":"GET /v1/premium","href":"/api-reference/market-data/premium"},{"title":"Hyperliquid mark and oracle prices","sidebarTitle":"List Mark Prices","openapi":"GET /v1/mark-prices","href":"/api-reference/market-data/list-mark-prices"},{"title":"Hyperliquid vault deposits and withdrawals","sidebarTitle":"List Vault Operations","openapi":"GET /v1/vault-operations","href":"/api-reference/market-data/list-vault-operations"},{"title":"Hyperliquid HIP-4 outcome markets summary","sidebarTitle":"Outcome markets summary","openapi":"GET /v1/predictions/summary","href":"/api-reference/market-data/predictions-summary"}]},{"group":"Analytics","pages":[{"title":"Hyperliquid net deposit and withdrawal flows","sidebarTitle":"Net Flows","openapi":"GET /v1/analytics/net-flows","href":"/api-reference/analytics/net-flows"},{"title":"Hyperliquid liquidations by price level","sidebarTitle":"Liquidation Levels","openapi":"GET /v1/analytics/liquidation-levels","href":"/api-reference/analytics/liquidation-levels"},{"title":"Hyperliquid liquidation map","sidebarTitle":"Liquidation Map","openapi":"GET /v1/liquidations/map","href":"/api-reference/analytics/liquidation-map"},{"title":"Markets in the Hyperliquid liquidation map","sidebarTitle":"Liquidation Map Markets","openapi":"GET /v1/liquidations/map/markets","href":"/api-reference/analytics/liquidation-map-markets"},{"title":"Hyperliquid order flow analysis","sidebarTitle":"Order Flow","openapi":"GET /v1/analytics/order-flow","href":"/api-reference/analytics/order-flow"},{"title":"Hyperliquid vault leaderboard","sidebarTitle":"Vault Leaderboard","openapi":"GET /v1/analytics/vault-leaderboard","href":"/api-reference/analytics/vault-leaderboard"},{"title":"Hyperliquid funding rate statistics","sidebarTitle":"Funding Stats","openapi":"GET /v1/analytics/funding-stats","href":"/api-reference/analytics/funding-stats"},{"title":"Hyperliquid PnL leaderboard","sidebarTitle":"PnL leaderboard","openapi":"GET /v1/analytics/leaderboard-pnl","href":"/api-reference/analytics/leaderboard-pnl"},{"title":"Top wallets in a Hyperliquid market","sidebarTitle":"Market top wallets","openapi":"GET /v1/analytics/market-top-wallets","href":"/api-reference/analytics/market-top-wallets"},{"title":"Hyperliquid wallet labels","sidebarTitle":"Wallet labels","openapi":"GET /v1/analytics/wallet-labels","href":"/api-reference/analytics/wallet-labels"}]},{"group":"Wallet Analytics","pages":[{"title":"Hyperliquid open positions and unrealized PnL","sidebarTitle":"User State","openapi":"GET /v1/analytics/user-state","href":"/api-reference/analytics/user-state"},{"title":"Hyperliquid wallet activity summary","sidebarTitle":"Wallet summary","openapi":"GET /v1/analytics/user-summary","href":"/api-reference/analytics/user-summary"},{"title":"Hyperliquid wallet PnL over time","sidebarTitle":"Wallet PnL series","openapi":"GET /v1/analytics/user-pnl-series","href":"/api-reference/analytics/user-pnl-series"},{"title":"Hyperliquid wallet positions at a past time","sidebarTitle":"Positions at a Time","openapi":"GET /v1/positions","href":"/api-reference/analytics/positions-at"},{"title":"Hyperliquid funding payments by address","sidebarTitle":"User Funding","openapi":"GET /v1/analytics/user-funding","href":"/api-reference/analytics/user-funding"},{"title":"Hyperliquid maker and taker breakdown by address","sidebarTitle":"User Maker / Taker","openapi":"GET /v1/analytics/user-maker-taker","href":"/api-reference/analytics/user-maker-taker"},{"title":"Hyperliquid deposits, withdrawals and ledger events","sidebarTitle":"User Ledger","openapi":"GET /v1/analytics/user-ledger","href":"/api-reference/analytics/user-ledger"}]},{"group":"SQL","pages":[{"title":"Run read-only SQL on Hyperliquid data","sidebarTitle":"Run SQL (POST)","openapi":"POST /v1/query","href":"/api-reference/query/run-query"},{"title":"Run Hyperliquid SQL from a URL","sidebarTitle":"Run SQL (GET)","openapi":"GET /v1/query","href":"/api-reference/query/run-query-get"},{"title":"Hyperliquid SQL tables and columns","sidebarTitle":"Query schema","openapi":"GET /v1/query/schema","href":"/api-reference/query/schema"}]},{"group":"Cohorts","pages":[{"title":"List Hyperliquid wallet cohorts","sidebarTitle":"List Cohorts","openapi":"GET /v1/cohorts","href":"/api-reference/cohorts/list-cohorts"},{"title":"Create a custom wallet cohort","sidebarTitle":"Create Cohort","openapi":"POST /v1/cohorts","href":"/api-reference/cohorts/create-cohort"},{"title":"Get the addresses in a wallet cohort","sidebarTitle":"Get Cohort Addresses","openapi":"GET /v1/cohorts/{name}","href":"/api-reference/cohorts/get-cohort-addresses"},{"title":"Delete a custom wallet cohort","sidebarTitle":"Delete Cohort","openapi":"DELETE /v1/cohorts/{name}","href":"/api-reference/cohorts/delete-cohort"}]},{"group":"Alerts","pages":[{"title":"List your liquidation alerts","sidebarTitle":"List Alerts","openapi":"GET /v1/alerts","href":"/api-reference/alerts/list-alerts"},{"title":"Create a Hyperliquid liquidation alert","sidebarTitle":"Create Alert","openapi":"POST /v1/alerts","href":"/api-reference/alerts/create-alert"},{"title":"Delete a liquidation alert","sidebarTitle":"Delete Alert","openapi":"DELETE /v1/alerts/{id}","href":"/api-reference/alerts/delete-alert"},{"title":"Send a test liquidation alert","sidebarTitle":"Test Alert","openapi":"POST /v1/alerts/{id}/test","href":"/api-reference/alerts/test-alert"}]},{"group":"Ironbox","pages":[{"title":"Create an Ironbox","sidebarTitle":"Create Ironbox","description":"POST /v1/ironbox creates a secure, sandboxed environment in Tokyo, next to Hyperliquid, for your trading agent.","openapi":"POST /v1/ironbox","href":"/api-reference/ironbox/create-ironbox"},{"title":"List your Ironboxes","sidebarTitle":"List Ironboxes","openapi":"GET /v1/ironbox","href":"/api-reference/ironbox/list-ironboxes"},{"title":"Get an Ironbox","sidebarTitle":"Get Ironbox","description":"GET /v1/ironbox/{id} returns one of your Ironboxes and its state.","openapi":"GET /v1/ironbox/{id}","href":"/api-reference/ironbox/get-ironbox"},{"title":"Delete an Ironbox","sidebarTitle":"Delete Ironbox","openapi":"DELETE /v1/ironbox/{id}","href":"/api-reference/ironbox/delete-ironbox"}]},{"group":"Keys and billing","pages":[{"title":"Request a free Hyperliquid API key","sidebarTitle":"Free API key","openapi":"POST /v1/keys","href":"/api-reference/billing/request-key"},{"title":"Ironflow API plans and prices","sidebarTitle":"List plans","openapi":"GET /v1/billing/plans","href":"/api-reference/billing/list-plans"},{"title":"Upgrade an API key with USDC on Hyperliquid","sidebarTitle":"Start an upgrade","openapi":"POST /v1/billing/upgrade","href":"/api-reference/billing/request-upgrade"},{"title":"Upgrade request status","sidebarTitle":"Upgrade status","openapi":"GET /v1/billing/upgrade","href":"/api-reference/billing/upgrade-status"},{"title":"Buy an Ironflow plan with x402","sidebarTitle":"Buy a plan (x402)","openapi":"POST /x402/v1/plans/{plan}/buy","href":"/api-reference/billing/buy-plan-x402"}]},{"group":"System","pages":[{"title":"Ironflow API index","sidebarTitle":"API index","openapi":"GET /v1","href":"/api-reference/system/index"},{"title":"Ironflow API status","sidebarTitle":"Status","openapi":"GET /v1/status","href":"/api-reference/system/status"},{"title":"Ironflow API uptime history","sidebarTitle":"Status History","openapi":"GET /v1/status/history","href":"/api-reference/system/history"},{"title":"Ironflow API health check","sidebarTitle":"Health Check","openapi":"GET /healthz","href":"/api-reference/system/health"},{"title":"Ironflow API performance metrics","sidebarTitle":"Status Metrics","openapi":"GET /v1/status/metrics","href":"/api-reference/system/metrics"}]}]}]}]},"basePath":"","title":"List your Ironboxes - Ironflow","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}