Skip to main content
GET
Live L2 order book of one market

Authorizations

Authorization
string
header
required

Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.

Query Parameters

market
string
required

Market symbol (BTC-PERP, xyz:NVDA-PERP, HYPE/USDC) or Hyperliquid coin name (BTC, @107).

depth
integer
default:20

Levels a side, 1 to 20.

Required range: 1 <= x <= 20
sig_figs
integer

Aggregate prices to 2 to 5 significant figures (coarser levels, deeper book). Leave out for full precision.

Required range: 2 <= x <= 5

Response

The order book.

market
string
Example:

"BTC-PERP"

coin
string
Example:

"BTC"

time
integer<int64>

Book time, Unix ms

bids
object[]
asks
object[]
best_bid
string
best_ask
string
mid
number
spread_bps
number
bid_depth_usd
number
ask_depth_usd
number
source
string
stale
boolean