API reference, Price-level maps

Price level

The orders and positions inside one bucket of the maps: each stop / take-profit with its wallet and position, each position liquidated there.

GET https://api.femtos.xyz/v1/hypercore/price-level

Parameters

Param	In	Example or values	Meaning
`coin`	query	`BTC`	HyperCore perp coin: BTC, xyz:TSLA
`px_lo`	query	`50000`	Band low edge (inclusive), price
`px_hi`	query	`150000`	Band high edge (exclusive), price, over px_lo
`limit`	query	`50`	Orders, and positions, listed (largest first)

curl -H "Authorization: Bearer $FEMTOS_KEY" "https://api.femtos.xyz/v1/hypercore/price-level?coin=BTC&px_lo=50000&px_hi=150000&limit=50"

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

Field	Type	Meaning
`orders`	object[]	Open trigger orders in the band, largest executable notional first, then largest placed: {oid, user, coin, side, kind, exec, orderType, triggerPx, triggerCondition, limitPx, sz, origSz, …}
`orders.executableSz`	decimal	Size it would execute when it fires: a reduce-only one at most what is left of its wallet's position then
`orders.unbackedSz`	decimal	Size placed that would not execute (reduce-only past the position, or opening past the account's margin)
`orders.position`	object \| null	The wallet's open position in the coin; null without one: {address, szi, side, entryPx, notional, upnl, leverage, marginMode, liqPx, liqDistancePct, label, entity}
`ordersTotal`	int	Open trigger orders in the band
`liquidations`	object[]	Open positions whose liquidation price is in the band, largest liqNotional first: {address, szi, side, entryPx, notional, upnl, leverage, marginMode, liqPx, liqDistancePct, label, entity, …}
`liquidationsTotal`	int	Open positions whose liquidation price is in the band
`cut`	object	Where each source is cut: {stops, positions}
`markPx`	decimal \| null	Mark: last trade

Liquidation price map GET /v1/hypercore/liquidation-map HyperCore
Liquidation prices of every open position, from Hyperliquid's formula on each account's state, bucketed like the stop map.
Liquidation map stream WS hc.liquidations.map HyperCore
The GET /v1/hypercore/liquidation-map map, pushed on subscribe, then on each roll of the live positions (every 5 s) when it changes (whole, or as a JSON Patch).
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 /v1/hypercore/forced-flow map, pushed on subscribe, then on each roll of the live positions (every 5 s) when it changes (whole, or as a JSON Patch).
Stop map stream WS hc.stops.map HyperCore
The GET /v1/hypercore/stops map, pushed on subscribe, then on each roll of the live positions (every 5 s) when it changes (whole, or as a JSON Patch).