Skip to main content
GET
/
v1
/
l2OrderBook
/
{market}
curl
curl "https://api.testnet.arcus.xyz/v1/l2OrderBook/BTC-USD?nLevels=20"
{
  "bids": [
    [
      "<string>"
    ]
  ],
  "asks": [
    [
      "<string>"
    ]
  ],
  "lastSequenceId": 123,
  "globalSequenceId": 123,
  "timestamp": 123
}

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

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).