Get HIP-3 full-depth L2 order book

{ "success": true, "data": { "symbol": "BTC", "coin": "BTC", "timestamp": "2025-01-21T10:30:45.123Z", "bids": [ { "px": "42150.00", "sz": "1.5", "n": 15 } ], "asks": [ { "px": "42150.00", "sz": "1.5", "n": 15 } ], "mid_price": "42150.50", "spread": "1.00", "spread_bps": "2.37", "bid_levels": 9842, "ask_levels": 10318, "total_bid_size": 10234.56, "total_ask_size": 9876.54 }, "meta": { "count": 123, "next_cursor": "<string>", "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } }

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://www.0xarchive.io/dashboard/

Path Parameters

symbol

string

required

HIP-3 symbol (case-sensitive, e.g., hyna:BTC, km:US500)

Example:

"km:US500"

Query Parameters

timestamp

integer<int64>

Unix timestamp in milliseconds. If not provided, returns the latest full-depth L2 snapshot.

Example:

1767225600000

depth

integer

Requested full-depth L2 price levels per side. Plan caps apply: Free 20 where available, Build 200, Pro/Enterprise full depth.

Example:

200

Response

Full-depth L2 order book snapshot

success

boolean

Example:

true

data

object

0xArchive full-depth aggregated L2 order book snapshot derived from L4 data

Hide child attributes

data.symbol

string

required

Trading pair symbol

Example:

"BTC"

data.coin

string

required

deprecated

Trading pair symbol (deprecated, use symbol instead)

Example:

"BTC"

data.timestamp

string<date-time>

required

Snapshot timestamp (UTC)

Example:

"2025-01-21T10:30:45.123Z"

data.bids

object[]

required

Bid price levels (best bid first)

Hide child attributes

data.bids.px

string

required

Price

Example:

"42150.00"

data.bids.sz

string

required

Total size at this price level

Example:

"1.5"

data.bids.n

integer

required

Number of orders at this level

Example:

15

data.asks

object[]

required

Ask price levels (best ask first)

Hide child attributes

data.asks.px

string

required

Price

Example:

"42150.00"

data.asks.sz

string

required

Total size at this price level

Example:

"1.5"

data.asks.n

integer

required

Number of orders at this level

Example:

15

data.mid_price

string

Mid price (best bid + best ask) / 2

Example:

"42150.50"

data.spread

string

Spread in absolute terms (best ask - best bid)

Example:

"1.00"

data.spread_bps

string

Spread in basis points

Example:

"2.37"

data.bid_levels

integer

Total bid price levels available before any depth truncation

Example:

9842

data.ask_levels

integer

Total ask price levels available before any depth truncation

Example:

10318

data.total_bid_size

number

Aggregate bid size across the available full-depth L2 book

Example:

10234.56

data.total_ask_size

number

Aggregate ask size across the available full-depth L2 book

Example:

9876.54