Instruments
You can explore all exchanges, assets, and get codes for them using our instrument explorer. Alternatively, if you want to obtain the data in a more programmatic way, use this endpoint.
What is this endpoint for?
This endpoint retrieves information on either all or specific supported instruments.
Endpoint
Parameters
Field | Required? | Description |
---|---|---|
| No | Exchange |
| No | The desired base asset |
| No | The desired quote asset |
| No | Kaiko identifier for the instrument. Always |
| No | Kaiko legacy instrument symbol. |
| No |
|
| No | Base asset |
| No | Quote asset |
| No | Starting time in ISO 8601 (inclusive). |
| No | Ending time in ISO 8601 (inclusive). Can also use "ongoing" to get ongoing instruments. |
| No | Minimum number of trades. |
| No | Maximum number of trades. |
| No |
|
| No | See Pagination |
| No | Maximum number of records to return in one response |
| No | Order results by a specifit field. See below for all possible values. |
| No | Return the data in ascending (1) or descending (-1) order |
| No | Filter on a specific blockchain for on-chain instruments. |
You can order your request by: exchange_code, class, kaiko_legacy_symbol, trade_start_timestamp, trade_end_timestamp, trade_count, base_asset, quote_asset, code, trade_count_min, trade_count_max
Repeated parameters
All parameters, except for trade_count_min/max
, trade_start/end_timestamp
can be repeated in the URL to filter. For example to get instruments for coinbase & deribit, the request would be instruments?exchange_code=cbse&exchange_code=drbt
Fields
Field | Description |
---|---|
| Base asset. |
|
|
| Kaiko identifier for the instrument. Always |
| Exchange code. See Exchanges |
| Identifier for the instrument used by the exchange.
For perpetual futures pairs, the code may differ from the exchange's and include a |
| Legacy slug for the exchange. See Exchanges |
| Identifier used in past deliveries of historical market data and Data Feed. |
| Quote asset |
| Time of the first available trade in Kaiko's data set. |
| Timestamp of the first available trade in Kaiko's data set. |
| Time of the last available trade in Kaiko's data set. |
| Timestamp of the last available trade in Kaiko's data set. |
| The total number of trades available through Kaiko Rest API and Kaiko Stream. For active pairs, this is an approximation. |
| Approximate size in bytes of all available trades in Kaiko Stream. |
| The list of the underlying pools to each instrument. (Only when arg |
Some exchanges may refer to "base" and "quote" currencies differently.
When we report the "price" of a trade, we're referring to the "base_asset" price as reported by the exchange.
When we report the "volume" involved in a trade, we're referring to volume od the "base_asset" as reported by the exchange.
Note: some exchanges reverse the ordering of base/quote in their pair codes.
Request example
Response example
Last updated