Orderbook

Retrieve the full order book for a trading pair with individual price levels via the V4 API.

GET /api/v4/public/orderbook/{market}

Orderbook

cURL

curl --request GET \
  --url https://whitebit.com/api/v4/public/orderbook/{market}

200

{
  "ticker_id": "BTC_PERP",
  "timestamp": 1594391413,
  "asks": [
    [
      "9184.41",
      "0.773162"
    ]
  ],
  "bids": [
    [
      "9181.19",
      "0.010873"
    ]
  ]
}

Public order book responses exclude Retail Price Improvement (RPI) orders. Private active order endpoints and private WebSocket streams return RPI orders. The exchange UI order book (web and mobile) displays RPI orders.

Path Parameters

market · string · required

Market pair name

Example:

"BTC_USDT"

Query Parameters

limit · integer · default: 100

Orders depth quantity: 0 - 100. Not defined or 0 will return 100 entries.

Required range: 0 <= x <= 100

Example:

100

level · integer

Optional parameter that controls the aggregation level. Level 0 – default, no aggregation. Levels 1–5 provide increasing aggregation of the order book.

Required range: 0 <= x <= 5

Example:

2

Response

200

application/json

Successful response

ticker_id · string

Market Name

Example:

"BTC_PERP"

timestamp · integer

Current timestamp

Example:

1594391413

asks · string[][]

Array of ask orders

[price, quantity] — price in quote currency, quantity in base currency

Required array length: 2 elements

Example:

["9184.41", "0.773162"]

bids · string[][]

Array of bid orders

[price, quantity] — price in quote currency, quantity in base currency

Required array length: 2 elements

Example:

["9181.19", "0.010873"]