Order Book

Get current order book

Retrieves the current order book for the specified symbol.

get/v1/orderbooks/{symbol_id}/current

Request

Base URL
https://rest.coinapi.io
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/coinapi/apis/coinapi-market-data-rest-api/docs/v1/orderbooks/:symbol_id/current/get.ts
A function with typed inputs. Its response is checked against the schema.

symbol_idstring required

The symbol ID (from the Metadata -> Symbols)

limit_levelsinteger

The maximum number of levels to include in the 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.

asksunknown

bidsunknown

No operation changes recorded.