Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Market Data
Public

Retrieves the order book (bids and asks) for a given instrument ID, along with other market values such as best bid/ask prices, last trade price, mark price, and index price.

This method is similar to get_order_book but uses instrument ID instead of instrument name. The order book depth can be controlled using the depth parameter, which accepts values from 1 to 10000.

Try in API console

get/public/get_order_book_by_instrument_id

Query parameters

instrument_idinteger required

The instrument ID for which to retrieve the order book, see public/get_instruments to obtain instrument IDs.

depth1 | 5 | 10 | 20 | 50 | 100 | 1000 | 10000

The number of entries to return for bids and asks, maximum - 10000.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "instrument_name": "BTC-PERPETUAL",
    "timestamp": 1536569522277,
    "stats": {
      "price_change": 10.23
    },
    "index_price": 8247.27
  }
}