Sign in

v2

latestOpenAPI 3.0.4MIT License2026-08-015029332.0 KB
Order Book

Current depth of the order book

Retrieves the current depth of the order book for the specified symbol.

get/v1/orderbooks/{symbol_id}/depth/current

Path parameters

symbol_idstring required

The symbol ID (from the Metadata -> Symbols)

Query parameters

limit_levelsinteger

The maximum number of levels to include in the response.

Response

successful operation

symbol_idstring nullable

Gets or sets the symbol identifier.

time_exchangestring date-time

Gets or sets the exchange time of the order book.

time_coinapistring date-time

Gets or sets the CoinAPI time when the order book was received.

ask_levelsinteger

Gets or sets the number of ask levels in the order book.

bid_levelsinteger

Gets or sets the number of bid levels in the order book.

ask_depthnumber double

Gets or sets the depth of the ask side of the order book.

bid_depthnumber double

Gets or sets the depth of the bid side of the order book.