Orderbook

GET /v1/api/orderbook

This endpoint returns the full orderbook for the named symbol and up to the specified depth.

This is a public endpoint, authentication is not required.

Parameters

Name	Type	Comments
depth	integer	1-100
symbol	string	Instrument name e.g BTC-USD

Order Book Response

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
symbol	string	Instrument name e.g BTC-USD
tradeable_entity_id	integer	unique instrument id
buy	OrderBookItem[]	see below

OrderBookItem Message

Name	Type	Comments
price	float	"12.0" / "1.1245" / "0.000100"
quantity	float	"12.0" / "1.1245" / "0.000100"

Example

{
  "orderbook_response": {
    "server_utc_timestamp": "1670248227985984",
    "symbol": "BTC-20221209-10000C",
    "tradeable_entity_id": "4439",
    "buy": [
      { "price": "10.0", "quantity": "4.0" },
      { "price": "12.0", "quantity": "0.2" }
    ],
    "sell": []
  }
}