Order Book

Get current order book

Retrieves the current order book for the specified symbol.

get/v1/orderbooks/{symbol_id}/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.

{"stackTrail":"components:schemas:v1.OrderBookBase:properties:asks","oasType":"schema","type":"unknown","description":"Gets or sets the asks made by market makers.","nullable":true}

{"stackTrail":"components:schemas:v1.OrderBookBase:properties:bids","oasType":"schema","type":"unknown","description":"Gets or sets the bids made by market makers.","nullable":true}

Changes

No changes recorded. 1 of the 9 revisions has no diff computed, so it could not be searched.