Skip to main content
GET
curl
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns the current L2 orderbook snapshot for a market, truncated to the requested number of levels per side. Optionally aggregates price levels to fewer significant figures via sigFigs (and roundStep). When aggregating, bids round down and asks round up to the bucket boundary so the displayed spread is never tighter than the true book, and the sizes of all merged levels are summed. Aggregation is applied before nLevels truncation.

Path Parameters

market
string
required

Market identifier.

Example:

"BTC-USD"

Query Parameters

nLevels
integer
default:20

Number of price levels to return per side (bids and asks). Default 20, maximum 100; requests above the maximum are silently clamped.

Required range: 1 <= x <= 100
sigFigs
enum<integer>

Aggregate price levels to this many significant figures. Omit for full precision (no aggregation).

Available options:
2,
3,
4,
5
roundStep
enum<integer>

Refines the finest bucket into steps of 1, 2, or 5. Takes effect only when sigFigs is 5; ignored otherwise.

Available options:
1,
2,
5

Response

Orderbook snapshot.

Full orderbook snapshot. Sent on subscribe for l2OrderbookUpdates, periodically re-broadcast on l2Orderbook, and returned by GET /l2OrderBook/{market}.

bids
string[][]

[price, size] tuple as strings

Required array length: 2 elements
asks
string[][]

[price, size] tuple as strings

Required array length: 2 elements
lastSequenceId
integer<uint64>

Max per-market sequence id for this snapshot (sync with stream).

globalSequenceId
integer<uint64>

Max global sequence id across levels when available; 0 if the store has no global_sequence column (legacy schema).

timestamp
integer<int64>

Snapshot time (epoch microseconds).