{
"error": {
"code": "NOT_FOUND",
"message": "no liquidation map for \"HYPE/USDC\": the map covers Hyperliquid perps with open positions, such as BTC-PERP or xyz:NVDA-PERP. GET /v1/liquidations/map/markets lists them"
}
}
{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "the liquidation map is not available right now (it is being built or its service did not answer); retry in 30 seconds"
}
}
Analytics
Hyperliquid liquidation map
GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node’s state snapshot.
GET
/
v1
/
liquidations
/
map
Liquidation map (where open positions would be liquidated)
{
"error": {
"code": "NOT_FOUND",
"message": "no liquidation map for \"HYPE/USDC\": the map covers Hyperliquid perps with open positions, such as BTC-PERP or xyz:NVDA-PERP. GET /v1/liquidations/map/markets lists them"
}
}
{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "the liquidation map is not available right now (it is being built or its service did not answer); retry in 30 seconds"
}
}
The map is built from every open perp position in our Hyperliquid node’s state snapshot, which the node writes about every 12 minutes. snapshot.height and snapshot.age_s say which snapshot the positions come from, and as_of when they were last priced.How liquidation prices are found:
For cross-margin positions they assume the account’s other positions stay at mark. In a real move correlated markets fall together, so cross-margin accounts are liquidated earlier than these prices.
Portfolio-margin accounts use Hyperliquid’s own liquidationPx. coverage.portfolio_margin_pct is their share of the market’s notional.
Notional is size times liquidation price.
cum_long_usd on a level below the mark is every long liquidated between the mark and that level: what a fall to that price would take out. cum_short_usd does the same for shorts above the mark.For a chart of liquidations that already happened, use liquidation levels.
Price bucket width. auto is about 0.25% of mark rounded to 1, 2 or 5 times a power
of ten (200 for BTC near 75,000, 0.2 for HYPE near 78). A number sets the width; one
finer than the map's grid is raised to the auto width, with a notice.
Present on keyless calls, which return a sample, and when bucket_size was raised.
{"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.4076","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/analytics/liquidation-map","slug":"/api-reference/analytics/liquidation-map","pageMetadata":{"title":"Hyperliquid liquidation map","sidebarTitle":"Liquidation Map","description":"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.","openapi":"GET /v1/liquidations/map","href":"/api-reference/analytics/liquidation-map"},"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/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node’s state snapshot.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The map is built from every open perp position in our Hyperliquid node’s state snapshot, which the node writes about every 12 minutes. `,_jsx(_components.code,{children:`snapshot.height`}),` and `,_jsx(_components.code,{children:`snapshot.age_s`}),` say which snapshot the positions come from, and `,_jsx(_components.code,{children:`as_of`}),` when they were last priced.`]}),`\n`,_jsx(_components.p,{children:`How liquidation prices are found:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Liquidation prices follow Hyperliquid’s maintenance margin rules.`}),`\n`,_jsx(_components.li,{children:`For cross-margin positions they assume the account’s other positions stay at mark. In a real move correlated markets fall together, so cross-margin accounts are liquidated earlier than these prices.`}),`\n`,_jsxs(_components.li,{children:[`Portfolio-margin accounts use Hyperliquid’s own `,_jsx(_components.code,{children:`liquidationPx`}),`. `,_jsx(_components.code,{children:`coverage.portfolio_margin_pct`}),` is their share of the market’s notional.`]}),`\n`,_jsx(_components.li,{children:`Notional is size times liquidation price.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`cum_long_usd`}),` on a level below the mark is every long liquidated between the mark and that level: what a fall to that price would take out. `,_jsx(_components.code,{children:`cum_short_usd`}),` does the same for shorts above the mark.`]}),`\n`,_jsxs(_components.p,{children:[`For a chart of liquidations that already happened, use `,_jsx(_components.a,{href:`/api-reference/analytics/liquidation-levels`,children:`liquidation levels`}),`.`]})]})}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":"Hyperliquid liquidation map","sidebarTitle":"Liquidation Map","description":"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.","openapi":"GET /v1/liquidations/map","href":"/api-reference/analytics/liquidation-map"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ironflow/fdad569770b855d6/posthog.js"],"openApiReferenceData":{"operation":{"operationId":"getLiquidationMap","summary":"Liquidation map (where open positions would be liquidated)","description":"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.","tags":["Analytics"],"parameters":["609b5b90-b938-4b05-aa52-593e99487e83","bd071d34-7251-47ea-9f2f-1416c12ed4dd","958d1e3c-1c5d-487d-8976-6c90b9f2eb0a","e50a8a84-d0fc-4024-b3ab-31ed30d35782"],"responses":{"200":"a3e680e9-3fa4-4937-a231-6afa78cc8acc","400":"e457d56b-a5da-4db4-bdbb-a82e823aff5a","404":"88260a7a-d479-4ce4-bee4-bd6f94549b31","429":"ed0d87af-e6f3-4b50-96db-aba0c59205b2","503":"2148f254-d2e8-4625-aede-ed69a3c429a8"},"method":"get","type":"path","servers":["e75206a2-6bd3-4f62-989c-f57c1c4fa178"],"security":["b07dda3a-069f-45b8-b7c3-db9dcc53cdac","a1e46810-a781-4c67-bac5-41bc142c68d9"],"path":"/v1/liquidations/map","baseUrlOptions":["https://api.ironflow.sh"],"title":"Liquidation map (where open positions would be liquidated)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"609b5b90-b938-4b05-aa52-593e99487e83":{"name":"market","in":"query","required":true,"description":"Perp symbol (BTC-PERP, xyz:NVDA-PERP) or Hyperliquid coin name (BTC, xyz:NVDA).","schema":{"type":"string","example":"BTC-PERP","isRequired":true,"description":"Perp symbol (BTC-PERP, xyz:NVDA-PERP) or Hyperliquid coin name (BTC, xyz:NVDA).","uniqueKey":"","typeLabel":"string"}},"bd071d34-7251-47ea-9f2f-1416c12ed4dd":{"name":"bucket_size","in":"query","description":"Price bucket width. `auto` is about 0.25% of mark rounded to 1, 2 or 5 times a power\nof ten (200 for BTC near 75,000, 0.2 for HYPE near 78). A number sets the width; one\nfiner than the map's grid is raised to the auto width, with a notice.\n","schema":{"type":"string","default":"auto","example":"500","description":"Price bucket width. `auto` is about 0.25% of mark rounded to 1, 2 or 5 times a power\nof ten (200 for BTC near 75,000, 0.2 for HYPE near 78). A number sets the width; one\nfiner than the map's grid is raised to the auto width, with a notice.\n","uniqueKey":"","typeLabel":"string"}},"958d1e3c-1c5d-487d-8976-6c90b9f2eb0a":{"name":"range_pct","in":"query","description":"How far from the mark to cover, in percent each way. Keyless calls cover 10.","schema":{"type":"number","exclusiveMinimum":0,"maximum":50,"default":20,"description":"How far from the mark to cover, in percent each way. Keyless calls cover 10.","uniqueKey":"","typeLabel":"number"}},"e50a8a84-d0fc-4024-b3ab-31ed30d35782":{"name":"side","in":"query","description":"Longs, shorts or both.","schema":{"type":"string","enum":["both","long","short"],"default":"both","description":"Longs, shorts or both.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"a3e680e9-3fa4-4937-a231-6afa78cc8acc":{"description":"The liquidation map.","headers":{"X-Ironflow-Notice":{"description":"Present on keyless calls (a sample) and when bucket_size was raised.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["market","mark_px","as_of","snapshot","bucket_size","range_pct","side","levels","coverage","stale","method"],"properties":{"market":{"type":"string","example":"BTC-PERP","isRequired":true,"uniqueKey":"market","typeLabel":"string"},"mark_px":{"type":"number","example":75782,"description":"The mark the liquidation prices were computed against","isRequired":true,"uniqueKey":"mark_px","typeLabel":"number"},"as_of":{"type":"string","format":"date-time","example":"2026-11-06T16:48:30Z","description":"When the positions were last priced","isRequired":true,"uniqueKey":"as_of","typeLabel":"string\u003cdate-time>"},"snapshot":{"type":"object","required":["height","time","age_s"],"description":"The node state snapshot the positions come from.","properties":{"height":{"type":"integer","format":"int64","example":1211490000,"description":"Block height of the snapshot","isRequired":true,"uniqueKey":"snapshot.height","typeLabel":"integer\u003cint64>"},"time":{"type":"string","format":"date-time","example":"2026-11-06T16:47:28Z","isRequired":true,"uniqueKey":"snapshot.time","typeLabel":"string\u003cdate-time>"},"age_s":{"type":"integer","example":62,"description":"Seconds since the snapshot","counted when this answer was made":null,"isRequired":true,"uniqueKey":"snapshot.age_s","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"snapshot","typeLabel":"object"},"bucket_size":{"type":"number","example":200,"isRequired":true,"uniqueKey":"bucket_size","typeLabel":"number"},"range_pct":{"type":"number","example":20,"description":"The range covered","in percent of mark each way":null,"isRequired":true,"uniqueKey":"range_pct","typeLabel":"number"},"side":{"type":"string","enum":["both","long","short"],"isRequired":true,"uniqueKey":"side","typeLabel":"enum\u003cstring>"},"levels":{"type":"array","description":"Price buckets holding positions, from the lowest price to the highest.","items":{"type":"object","required":["price_lo","price_hi","long_usd","long_positions","short_usd","short_positions","cum_long_usd","cum_short_usd"],"properties":{"price_lo":{"type":"number","example":72600,"isRequired":true,"uniqueKey":"levels.items.[INDEX].price_lo","typeLabel":"number"},"price_hi":{"type":"number","example":72800,"isRequired":true,"uniqueKey":"levels.items.[INDEX].price_hi","typeLabel":"number"},"long_usd":{"type":"number","example":21480000,"description":"Notional of longs liquidated in this range (size times liquidation price)","isRequired":true,"uniqueKey":"levels.items.[INDEX].long_usd","typeLabel":"number"},"long_positions":{"type":"integer","example":412,"isRequired":true,"uniqueKey":"levels.items.[INDEX].long_positions","typeLabel":"integer"},"short_usd":{"type":"number","example":0,"isRequired":true,"uniqueKey":"levels.items.[INDEX].short_usd","typeLabel":"number"},"short_positions":{"type":"integer","example":0,"isRequired":true,"uniqueKey":"levels.items.[INDEX].short_positions","typeLabel":"integer"},"cum_long_usd":{"type":"number","example":208900000,"description":"Longs liquidated from the mark down to this level","isRequired":true,"uniqueKey":"levels.items.[INDEX].cum_long_usd","typeLabel":"number"},"cum_short_usd":{"type":"number","example":0,"description":"Shorts liquidated from the mark up to this level","isRequired":true,"uniqueKey":"levels.items.[INDEX].cum_short_usd","typeLabel":"number"}},"uniqueKey":"levels.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"levels","typeLabel":"object[]"},"coverage":{"type":"object","description":"How much of the market's open notional the map prices, and how.","properties":{"notional_usd":{"type":"number","example":3286600394,"description":"Open notional of the market","both sides":null,"uniqueKey":"coverage.notional_usd","typeLabel":"number"},"with_liq_px_pct":{"type":"number","example":98.1,"description":"Share of it that has a liquidation price","uniqueKey":"coverage.with_liq_px_pct","typeLabel":"number"},"portfolio_margin_pct":{"type":"number","example":6,"description":"Share priced by Hyperliquid's own liquidationPx (portfolio-margin accounts)","uniqueKey":"coverage.portfolio_margin_pct","typeLabel":"number"},"unknown_mode_pct":{"type":"number","example":0.5,"description":"Share from accounts whose margin mode is not known yet","uniqueKey":"coverage.unknown_mode_pct","typeLabel":"number"}},"isRequired":true,"uniqueKey":"coverage","typeLabel":"object"},"stale":{"type":"boolean","description":"True when the map service did not answer and an older map is returned","isRequired":true,"uniqueKey":"stale","typeLabel":"boolean"},"method":{"type":"string","description":"How the map is made","isRequired":true,"uniqueKey":"method","typeLabel":"string"},"notice":{"type":"string","description":"Present on keyless calls, which return a sample, and when bucket_size was raised.","uniqueKey":"notice","typeLabel":"string"}},"example":{"market":"BTC-PERP","mark_px":75782,"as_of":"2026-11-06T16:48:30Z","snapshot":{"height":1211490000,"time":"2026-11-06T16:47:28Z","age_s":62},"bucket_size":200,"range_pct":20,"side":"both","levels":[{"price_lo":72600,"price_hi":72800,"long_usd":21480000,"long_positions":412,"short_usd":0,"short_positions":0,"cum_long_usd":208900000,"cum_short_usd":0},{"price_lo":78800,"price_hi":79000,"long_usd":0,"long_positions":0,"short_usd":9800000,"short_positions":61,"cum_short_usd":62400000,"cum_long_usd":0}],"coverage":{"notional_usd":3286600394,"with_liq_px_pct":98.1,"portfolio_margin_pct":6,"unknown_mode_pct":0.5},"stale":false,"method":"Every open position from our node's state snapshot. Liquidation prices follow Hyperliquid's maintenance margin rules; for cross-margin positions they assume the account's other positions stay at mark. Portfolio-margin accounts use Hyperliquid's own liquidationPx. Notional is size times liquidation price. In a real move correlated markets fall together, so cross-margin accounts are liquidated earlier than these prices."},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"market":"BTC-PERP","mark_px":75782,"as_of":"2026-11-06T16:48:30Z","snapshot":{"height":1211490000,"time":"2026-11-06T16:47:28Z","age_s":62},"bucket_size":200,"range_pct":20,"side":"both","levels":[{"price_lo":72600,"price_hi":72800,"long_usd":21480000,"long_positions":412,"short_usd":0,"short_positions":0,"cum_long_usd":208900000,"cum_short_usd":0},{"price_lo":78800,"price_hi":79000,"long_usd":0,"long_positions":0,"short_usd":9800000,"short_positions":61,"cum_short_usd":62400000,"cum_long_usd":0}],"coverage":{"notional_usd":3286600394,"with_liq_px_pct":98.1,"portfolio_margin_pct":6,"unknown_mode_pct":0.5},"stale":false,"method":"Every open position from our node's state snapshot. Liquidation prices follow Hyperliquid's maintenance margin rules; for cross-margin positions they assume the account's other positions stay at mark. Portfolio-margin accounts use Hyperliquid's own liquidationPx. Notional is size times liquidation price. In a real move correlated markets fall together, so cross-margin accounts are liquidated earlier than these prices."}}},"exampleType":"generated"}},"exampleType":"generated"},"e457d56b-a5da-4db4-bdbb-a82e823aff5a":{"description":"Invalid request parameters.","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":"BAD_REQUEST","message":"market is required (e.g. BTC-PERP)"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BAD_REQUEST","message":"market is required (e.g. BTC-PERP)"}}}},"exampleType":"examples"}},"exampleType":"examples"},"88260a7a-d479-4ce4-bee4-bd6f94549b31":{"description":"No map for this market (unknown, not a perp, or no open positions).","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":"NOT_FOUND","message":"no liquidation map for \"HYPE/USDC\": the map covers Hyperliquid perps with open positions, such as BTC-PERP or xyz:NVDA-PERP. GET /v1/liquidations/map/markets lists them"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"no liquidation map for \"HYPE/USDC\": the map covers Hyperliquid perps with open positions, such as BTC-PERP or xyz:NVDA-PERP. GET /v1/liquidations/map/markets lists them"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ed0d87af-e6f3-4b50-96db-aba0c59205b2":{"description":"Rate limit exceeded.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","example":60}}},"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":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Retry after 60 seconds."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Retry after 60 seconds."}}}},"exampleType":"examples"}},"exampleType":"examples"},"2148f254-d2e8-4625-aede-ed69a3c429a8":{"description":"The map is not ready (its service is starting) or its service did not answer and no recent map is cached. Retry after the Retry-After seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","example":30}}},"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":"UPSTREAM_UNAVAILABLE","message":"the liquidation map is not available right now (it is being built or its service did not answer); retry in 30 seconds"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UPSTREAM_UNAVAILABLE","message":"the liquidation map is not available right now (it is being built or its service did not answer); retry in 30 seconds"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b07dda3a-069f-45b8-b7c3-db9dcc53cdac":{"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"}},"a1e46810-a781-4c67-bac5-41bc142c68d9":{}},"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":"Hyperliquid liquidation map - Ironflow","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T22:15:57.374Z","originalFileLocation":"api-reference/analytics/liquidation-map.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/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node\u0026#x27;s state snapshot.\">\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=\"Hyperliquid liquidation map - Ironflow\">\u003cmeta data-mint-head property=\"og:description\" content=\"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node\u0026#x27;s state snapshot.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ironflow\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map\">\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=Analytics\u0026amp;title=Hyperliquid+liquidation+map\u0026amp;description=GET+%2Fv1%2Fliquidations%2Fmap+returns+where+open+Hyperliquid+perp+positions+would+be+liquidated%2C+by+price%2C+with+running+totals%2C+from+our+node%27s+state+snapshot.\u0026amp;theme=65db10876e49f8f53e58cbae\u0026amp;signature=cf3d700c03bb342097691845df41b1bb885d149e2aacd797b8f2826a7acabd2f\">\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=\"Hyperliquid liquidation map - Ironflow\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node\u0026#x27;s state snapshot.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ironflow.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Hyperliquid+liquidation+map\u0026amp;description=GET+%2Fv1%2Fliquidations%2Fmap+returns+where+open+Hyperliquid+perp+positions+would+be+liquidated%2C+by+price%2C+with+running+totals%2C+from+our+node%27s+state+snapshot.\u0026amp;theme=65db10876e49f8f53e58cbae\u0026amp;signature=cf3d700c03bb342097691845df41b1bb885d149e2aacd797b8f2826a7acabd2f\">\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/analytics/liquidation-map\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics/liquidation-map.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/analytics/liquidation-map#webpage\",\"url\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map\",\"name\":\"Hyperliquid liquidation map\",\"description\":\"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.\",\"dateModified\":\"2026-11-06T22:15:57.374Z\",\"isPartOf\":{\"@id\":\"https://docs.ironflow.sh#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.ironflow.sh/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Analytics\",\"item\":\"https://docs.ironflow.sh/api-reference/analytics/net-flows\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Hyperliquid liquidation map\",\"item\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map#apireference\",\"headline\":\"Hyperliquid liquidation map\",\"name\":\"Hyperliquid liquidation map\",\"description\":\"GET /v1/liquidations/map returns where open Hyperliquid perp positions would be liquidated, by price, with running totals, from our node's state snapshot.\",\"url\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ironflow.sh/api-reference/analytics/liquidation-map#webpage\"},\"dateModified\":\"2026-11-06T22:15:57.374Z\",\"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","description":"GET /v1/analytics/liquidation-levels buckets past Hyperliquid liquidations by price and side, for heatmaps of where longs and shorts were closed.","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","description":"GET /v1/liquidations/map/markets lists every Hyperliquid perp in the liquidation map with its mark and long and short notional at risk. No key needed.","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","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","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":"Hyperliquid liquidation map - Ironflow","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}