API reference · Price-level maps

Liquidation price map

Liquidation prices of every open position, from Hyperliquid's formula on each account's state, bucketed like the stop map.

GET https://api.femtos.xyz/v1/hypercore/liquidation-map

Parameters

Param	In	Example or values	Meaning
`coin`	query	`BTC`	HyperCore perp coin: BTC, xyz:TSLA
`buckets`	query	`40`	Most buckets (width rounded up to a round number); not with step
`step`	query	(optional)	Bucket width in price units, instead of buckets (at most 400 buckets)
`range_pct`	query	`10`	Half-width of the grid around the mark, percent, (0, 100]

curl -H "Authorization: Bearer $FEMTOS_KEY" "https://api.femtos.xyz/v1/hypercore/liquidation-map?coin=BTC&buckets=40&range_pct=10"

Key: Authorization: Bearer $FEMTOS_KEY. Get a free key, or with no browser through agent onboarding.

Field	Type	Meaning
`buckets[]`	object	Ascending price; empty when the mark is unknown: {pxLo, pxHi, long, short}
`below`	object	long: liquidated by a forced sell as price falls to it; short: by a forced buy as price rises to it: {long, short}
`above`	object	long: liquidated by a forced sell as price falls to it; short: by a forced buy as price rises to it: {long, short}
`totals`	object	long: liquidated by a forced sell as price falls to it; short: by a forced buy as price rises to it: {long, short}
`coverage`	object	How much of the open interest the map holds: every account's positions at `height`, each liquidation price from Hyperliquid's formula on the account state; none for portfolio-margin cross accounts and positions that cannot be liquidated: {positions, withLiqPx, sz, szWithLiqPx, share, note}
`asOf`	ms	Time of `height` (Unix ms)
`height`	int	Block the positions are at: the node's latest state (one every 10,000 blocks, ~12 min) rolled forward with every fill, funding payment and ledger update since, a few seconds behind the chain; the state itself while the roll is not running
`baseHeight`	int	Block of that node state (= height when not rolled forward)
`markPx`	decimal \| null	Mark: last trade
`rangePct`	decimal	range_pct applied
`step`	decimal \| null	Bucket width

Liquidation map stream WS hc.liquidations.map HyperCore
The GET /api/hypercore/liquidation-map map, pushed whole on subscribe and every 5 s when it changes.
Forced flow GET /v1/hypercore/forced-flow HyperCore
Stop-loss / take-profit orders and liquidations on the same buckets: the cascade (stops + liquidations, with the move) and the take-profits (against it) at each price.
Forced flow stream WS hc.forced_flow.map HyperCore
The GET /api/hypercore/forced-flow map, pushed whole on subscribe and every 5 s when it changes.
Stop map stream WS hc.stops.map HyperCore
The GET /api/hypercore/stops map, pushed whole on subscribe and every 5 s when it changes.