Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Digital asset exchanges operate approximately 24x7x365. For daily aggregated data, the opening price is calculated as the first trade at or after 00:00:00 UTC. The closing price is calculated as the last trade prior to 00:00:00 UTC.
For Centralized Exchange(CEX) taker_side_sell
takes the value of true
when a taker's sell order fills a maker's buy order and false
when a taker's buy order fills a maker's sell order.
For Decentralized Exchanges (DEX) using Automatic Market Maker (AMM) protocols, the liquidity pool contract is considered the maker. The entity executing a transaction against the liquidity pool is the taker.
If an exchange does not appear below, it can be assumed that all data we provide is normalized correctly.
For exchanges where we were unable to confirm as reporting data from either a taker or a maker's perspective, we have included the notation mapping from the exchange's trade direction field to our taker_side_sell
field. This is necessary so that researchers who want to further study trade direction can make their own conclusions. For exchanges that classify trade direction differently or exclude the field entirely, we also include the notation mapping and a short explanation for how their variable differs.
Furthermore, there are some trades of the Australian Exchange Independent Reserve
, where we cannot decide if it is the taker buy or taker sell. As such, it is the only exchange that has 3 values, which are true
, false
and unknown
, in the field taker_side_sell
.
Finally, we have made a couple of errors in classifying exchanges as "maker" or "taker", typically early on in the process of developing taker_side_sell
. Rather than switch our trade reporting after years of data collection, we have simply marked exchanges where the inverse of the notation stated should be applied. For these exchanges, researchers should be aware that when taker_side_sell: false
, the inverse should be assumed.
Unconfirmed, Misclassified or Absent Trade Direction Field
Exchange
Exchange Notation
Kaiko taker_side_sell: true
equivalent to:
Comment
BTCBox
"type":
"buy" or "sell"
inverse notation: "type": "sell"
Inverse, but confirmed perspective from exchange.
Liquid (Quoine)
taker_side:
"buy" or "sell"
inverse notation: taker_side: "buy"
Inverse, but confirmed perspective from exchange.
Bithumb
"type":
"bid" or "ask"
inverse notation: "type": "bid"
Inverse, but confirmed perspective from exchange.
Coinone
"is_ask":
"0"(if seller is taker)/"1"(if seller is maker)
inverse notation: "is_ask": "1"
Inverse, confirmed from exchange but slightly different notation format
Bitstamp
type:
0 (buy) or 1 (sell)
type: 1
Unconfirmed perspective from exchange
Bit-Z
"s":
"buy" or "sell"
"s": "sell"
Unconfirmed perspective from exchange
EXX
type":
"buy" or "sell"
type: "sell"
Unconfirmed perspective from exchange
CEX.io
type:
"buy" or "sell"
type: "sell"
Unconfirmed perspective from exchange
Yobit
"type":
"bid" or "ask"
"type": "bid"
Unconfirmed perspective from exchange
itBit
None
Always returns true
No buy/sell field
Korbit
None
Always returns null
No buy/sell field
Coinflex
None
Always returns null
No buy/sell field
Independent Reserve
"Side":
"Buy"
or "Sell"
"Side": "Sell"
Some trades have "Unknown"
AsiaNext
None
Always returns false
No buy/sell field provided
Each endpoint for the Market Data solution lives under its own hostname. You must include an API key in the header of every request you make. The format for the API key is:
When interacting with Kaiko HTTP APIs, you are expected to pass two pieces of information in a header:
Accept: application/json
: API responses will be in JSON format.
Accept-Encoding: gzip
: All our endpoints benefit from use of compression.
All time parameters are in UTC time zone and returned in the following ISO 8601 datetime format:
YYYY-MM-DD
Thh:mm:ss.sss
Z
For example:
2017-12-17T13:35:24.351Z
The "T" separates the date from the time. The trailing "Z" indicates UTC time.
Find exchange codes here: .
Find instrument codes here: .
All Kaiko data is timestamped in the UTC time zone. All timestamps are returned as millisecond Unix timestamps (the number of milliseconds elapsed since 1970-01-01 00:00:00.000 UTC). For metadata fields, times are also returned in millisecond-resolution ISO 8601 datetime strings in the same format as input for convenience.
All API responses are in JSON format. A result
field, with a value of success
or error
is returned with each request. In the event of an error, a message
field will provide an error message.
An access
object is also echoed back. It contains two ranges of timestamps:
access_range
: The time range for which the Client has access to the API
data_range
: The time range of data the Client is authorized to access
access
{}
Time ranges of accesses.
data
[] | {}
Response result data.
message
string
Error message, if query was not successful.
query
{}
All handled query parameters echoed back.
result
string
success
if query successful, error
otherwise.
time
string
The current time at our endpoint.
timestamp
long
The current time at our endpoint.
Kaiko takes transparency and accountability very seriously. Therefore, our provided datasets are versioned. Dataset versioning is orthogonal to API versioning. Any potential breaking changes in results (e.g. semantical changes or corrections of historically incorrect data) will result in a new dataset version - no corrections or adjustments will be done in the dark. Addition of new data will not result in a new dataset version. Data is versioned on a per-base-data level.
The versioning is selected by selecting a base data set and a version. All current Market Data API endpoints take the commodity
and data_version
parameters.
By setting this to latest
, you will get the most recent version. The returned version is always included in the query
field and can be referred to if you would ever need to compare results, should we ever need to adjust historical data. Paginating over a request with version set to latest
will preserve the current version across subsequent pagination requests.
We recommend using the most current version explicitly in production integrations as the latest
label might move at any time to a breaking change. For the trades
and order_book_snapshots
commodities the latest version is currently v1
All API responses are in JSON format. A result
field, with a value of success
or error
is returned with each request. In the event of an error, a message
field will provide an error message.
HTTP error codes
The Kaiko platform API uses the following error codes:
400
Bad Request
401
Unauthorized -- You are not authenticated properly. See Authentication.
403
Forbidden -- You don't have access to the requested resource.
404
Not Found
405
Method Not Allowed
406
Not Acceptable
429
Rate limit reached
500
Internal Server Error -- We had a problem with our service. Try again later.
503
Service Unavailable -- We're temporarily offline for maintenance.
For queries that result in a larger dataset than can be returned in a single response, a continuation_token
field is included. Calling the same endpoint again with the continuation_token
query parameter added will return the next result page. For convenience, a next_url
field is also included, containing a URL that can be called directly to get the next page. Paginated endpoints also takes a page_size
parameter that specifies the maximum number of items that should be included in each response. Only the first call should include page_size
, all subsequent calls should only use continuation_token
. Paginating over a request with version set to latest
will preserve the current version across subsequent pagination requests.
Parameters
continuation_token
No
page_size
No
Maximum number of records to return in one response
The following script can be used to browse pages in Python. Make sure to update your trade_url
and X-Api-Key
.
This example uses Pandas for convenience. If you're unfamiliar with them, use the standard Python example.
Our standard Rest API is limited to 6000 requests per API key per minute. If you query the API beyond that threshold, a 429
an error message will occur.
If you'd like to discuss rate-limiting, please contact support@kaiko.com.
This endpoint returns transactions (borrows, repayments, withdrawals, deposits and liquidations) registered on-chain, for the main L&B protocols.
blockchain
No
ethereum
protocol
No
Should be one or several of the currently supported L&B protocols.
aav1,aav2
user_address
No
Filter on a specific wallet addresses (comma separated).
0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
live
No
Shows the data as soon as the block is validated.
(Default: false
, in case of block reorganization).
true
tx_hash
No
Filter on a specific transaction hash.
0xe68b84740**
asset
No
L&B events including the requested token. Default: all available tokens.
weth or weth,usdt,usdc
type
No
Event type: borrow, deposit, withdraw, repayment or liquidation.
borrow,withdraw
block_number
No
Block height.
10795593
start_block
No
Starting block height (inclusive).
129870
end_block
No
Ending block height (inclusive).
130000
start_time
No
Starting time in ISO 8601 (inclusive).
2022-04-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
sort
No
Returns the data in ascending or descending order.
Default: desc
.
ascending
page_size
No
1000
blockchain
The blockchain on which the transaction happened.
ethereum
block_number
The height of the block in which the transaction happened.
16025918
datetime
The timestamp of the block in which the transaction happened.
1669124591
transaction_hash
Transaction hash
---
log_index
Log index of the transaction
152
protocol
Code of the L&B protocol.
aave/v2
type
Event type: Borrow, deposit, withdraw, repayment or liquidation.
borrow
, deposit
, etc
user_address
Address of the user.
0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
asset_symbol
Symbol of the underlying asset.
crv
asset_address
Address of the underlying asset.
0xd533a949740bb3306d119cc777fa900ba034cd52
asset_decimals
Decimals of the underlying asset.
18
receipt_symbol
Symbol of the receipt asset.
acrv
receipt_address
Address of the receipt asset.
0x8dae6cb04688c62d939ed9b68d32bc62e49970b1
receipt_decimals
Decimals of the receipt asset.
18
amount
Amounts of the borrowed token.
299894.78
metadata
Metadata linked to the event type and protocol.
More information below.
Borrow event:
amount_receipt
Amounts of the receipt token.
299899
rate
Borrow rate (at the event level or at the contract level depending on the protocol).
0.02820253961814756
rate_type
Stable (1) or Variable (2)
1
or 2
on_behalf_of
The address of user who will incur the debt.
0xeffc18fc3b7eb8e676dac549e0c693ad50d1ce31
Deposit event:
amount_receipt
Amounts of the receipt token.
299899
rate
Supply rate of the overall lending pool.
0.000203088325657998768898798
on_behalf_of
The address that will receive the receipt tokens.
0xeffc18fc3b7eb8e676dac549e0c693ad50d1ce31
Withdraw event:
amount_receipt
Amounts of the receipt token.
299899
on_behalf_of
The address that will receive the underlying token.
0xeffc18fc3b7eb8e676dac549e0c693ad50d1ce31
Repayment event
amount_receipt
Amounts of the receipt token.
299899
on_behalf_of
The address of user who will incur the debt.
0xeffc18fc3b7eb8e676dac549e0c693ad50d1ce31
borrow_rate_mode
Stable (1) or Variable (2)
1
or 2
Liquidation event
liquidation_debt_asset_symbol
Symbol of the debt asset.
renfil
liquidation_debt_asset_address
Address of the debt asset.
0xd5147bc8e386d91cc5dbe72099dac6c9b99276f5
liquidation_debt_asset_decimals
Decimals of the debt asset.
18
liquidation_debt_amount_in_asset
Amount of the debt asset.
1899
liquidation_caller_address
The address that triggered the liquidation transaction.
0xdfd3bd446f1b7fd96dc995126ee845af0b1254cd
receive_receipt_token
The liquidator chooses to receive the collateral's asset (False) or recept token (True).
True
or False
liquidation_type
Debt (1) or Collateral (2)
1
Should be one or several of the currently supported blockchains. See
Number of snapshots to return data for. (default: 100, min: 1, max: 1000). See
You can also get OHLCV Candlesticks from the Trade Count, OHLCV, & VWAP endpoint.
This endpoint retrieves the OHLCV history for an instrument on an exchange.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
continuation_token
No
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1d
.
page_size
No
start_time
No
Starting time in ISO 8601 (inclusive).
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default desc
Automatically included in continuation tokens.
timestamp
Timestamp at which the interval begins.
open
Opening price of interval. null
when no trades reported.
high
Highest price during interval. null
when no trades reported.
low
Lowest price during interval. null
when no trades reported.
close
Closing price of interval. null
when no trades reported.
volume
Volume traded in interval. 0
when no trades reported.
This endpoint retrieves the Trade Count, OHLCV and VWAP history for any instrument on an exchange. The interval
parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively. By making use of the sort
parameter, data can be returned in ascending asc
(default) or descending desc
order.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
continuation_token
No
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1d
.
page_size
No
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default desc
Automatically included in continuation tokens.
timestamp
Timestamp at which the interval begins.
count
Then number of trades. 0
when no trades reported.
open
Opening price of interval. null
when no trades reported.
high
Highest price during interval. null
when no trades reported.
low
Lowest price during interval. null
when no trades reported.
close
Closing price of interval. null
when no trades reported.
volume
Volume traded in interval. 0
when no trades reported.
price
The volume weighted price during the time interval. null
when no trades reported.
You can also get OHLCV Candlesticks from the Trade Count, OHLCV, & VWAP endpoint.
This endpoint retrieves aggregated VWAP (volume-weighted average price) history for an instrument on an exchange.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
continuation_token
No
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1d
.
page_size
No
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc
) or descending (desc
) order.
Default: desc
Automatically included in continuation tokens.
timestamp
Timestamp at which the interval begins.
price
VWAP. null
when no trades reported.
Tick-level data is the most granular level of trading data and contains every single trade that occurs on centralized and decentralized exchanges. The data is normalized and timestamped and contains information such as the price and volume of each trade. For DEXs specifically, we also provide additional information on the user address, the blockchain, the pool address, and the transaction hash related to the trade.
The following parameters are unique to on-chain instruments.
The following fields are unique to on-chain instruments.
Market Depth provides insight into the "depth" of an exchange's order book by aggregating the volume of bids and asks within 0-10% of the best bid or ask, respectively. A higher volume of bids and asks at each level implies more liquidity.
We are unable to collect the full 10% snapshot from all exchanges we cover. Thus, for some exchanges, 'Market Depth' does not accurately portray the exchange's order book volume.
See
Instrument class
.
See
Instrument code
.
See
See
(min: 1, default: 100, max: 100000). See Automatically included in continuation tokens.
Information from this endpoint can be accessed through Google BigQuery. To get started, read our .
See
Instrument class
.
See
Instrument code
.
See
See Automatically included in continuation tokens.
Trade Count and OHLCV can be accessed through Google BigQuery. To get started, read our .
See
Instrument class
.
See
Instrument code
.
See
See
(min: 1, default: 100, max: 100000). See Automatically included in continuation tokens.
This endpoint uses our as source data and enhances its raw data with the Market Depth metric.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
See Exchange codes
instrument_class
Yes
Instrument class
.
See Exchange trading pair codes (instruments)
instrument
Yes
Instrument code
.
See Exchange trading pair codes (instruments)
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
page_size
No
See Pagination Automatically included in continuation tokens.
continuation_token
No
See Pagination
sort
No
Return the data in ascending (asc) or descending (desc) order. Default desc.
blockchain
No
Filter on a specific blockchain. (Default: ethereum).
pool_address
No
Filter on a specific pool address.
transaction_hash
No
Filter on a specific transaction hash. (Several trades can happen within a single transaction).
user_address
No
Filter on a specific address.
start_block
No
Starting block height (inclusive).
end_block
No
Ending block height (inclusive).
timestamp
The timestamp provided by the exchange or the collection timestamp in Unix Timestamp (in milliseconds)
trade_id
Unique trade ID (unique to the exchange). In case the exchange does not provide an ID, we generate it ourselves.
price
Price displayed in quote currency.
amount
Quantity of asset bought or sold (can be in base_asset, quote_asset or the number of contracts).
taker_side_sell
blockchain
The blockchain on which the trade happened.
transaction_hash
Transaction hash.
log_index
The log index of the transaction (in base 10).
pool_address
The address of the pool in which the trade happened.
user_address
Address that triggered the transaction.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
See Exchange codes
instrument_class
Yes
Instrument class
.
See Exchange trading pair codes (instruments)
instrument
Yes
Instrument code
.
See Exchange trading pair codes (instruments)
continuation_token
No
See Pagination
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
page_size
No
Number of snapshots to return data for. (default: 10, max: 100). See Pagination Automatically included in continuation tokens.
sort
No
Return the data in ascending asc
or descending desc
order.
Default: desc.
Automatically included in continuation tokens.
poll_timestamp
The timestamp at which the raw data snapshot was taken.
poll_date
The date at which the raw data snapshot was taken.
timestamp
The timestamp provided by the exchange. null
when not provided.
bid_volume_x
The volume of bids placed within 0 and x% of the best bid. This is what we call "Market Depth".
ask_volume_x
The volume of asks placed within 0 and x% of the best ask. This is what we call "Market Depth"
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.
This endpoint retrieves a list of assets and associated codes.
No parameters supported
asset_class
The asset's primary asset class
asset_classes
The asset's secondary asset classes
code
Kaiko identifier for the asset.
name
The asset name
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.
This endpoint retrieves a list of exchanges and associated codes.
No parameters supported
code
Kaiko identifier for the exchange.
kaiko_legacy_slug
Identifier used in delivery of aggregated data.
name
The exchange name.
We strive to use only one exchange code to cover all the instrument classes such as spot, futures and etc. However, due the legacy issues, we might use different exchange codes for one exchange. The following exchanges are the exchanges that have more than one exchange codes, covering different instrument classes.
Binance
Bybit
Huobi
Kraken
The Uniswap V3 Liquidity Estimator offers insight into the token reserves on Uniswap V3.
This data shows the liquidity across all the price levels for a specific pair of tokens on Uniswap V3. Each price level has a range, which is shown aslower_tick
(the lowest price of the level) and upper_tick
(the highest price of the level). The data shows you the amount of tokens and liquidity available at each price level.
We display all price-levels up to 10% either side of the current block price. The data is provided in a block-by-block granularity.
Access the methodology here.
pool_address
Yes
Pool address.
0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640
blockchain
No
ethereum
live
No
Shows the data as soon as the block is validated.
(Default: false
, in case of block reorganization).
true
start_block
No
Starting block height (inclusive).
129870
end_block
No
Ending block height (inclusive).
130000
start_time
No
Starting time in ISO 8601 (inclusive).
2022-04-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
price_range
No
The interval of price around the current price, in % (min: 0, default: 0.1, max: 0.2).
0.05
page_size
No
10
blockchain
The blockchain on which the transaction happened.
ethereum
block_number
The height of the block.
16028979
pool_name
Name of the pool as it is written on the blockchain.
USDC-WETH-0.001
pool_address
Address of the contract of the pool.
0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640
current_tick
The current tick at this block.
-58580
current_price
The current price at this block, normalized using the pool’s tokens decimals.
0.0028577887443084
datetime
The timestamp of the block. In seconds.
1669161611
snapshots
The snapshot of the liquidity at each tick of the pool.
See table below.
Field snapshots
amount0
The amount of token0 in the specified tick range, normalized using the token0 decimals.
0
amount1
The amount of token1 in the specified tick range, normalized using the token1 decimals.
26.4381078606
amount
The amount of liquidity in the specified tick range.
1.7305248294559624e+23
lower_tick
The lower tick of the range.
-59580
upper_tick
The upper tick of the range.
-59520
This indicates the amount of each token available for trading in a liquidity pool, identified through its blockchain pool address. A separate endpoint provides this data specifically for Uniswap V3 liquidity pools.
blockchain
No
ethereum
pool_address
Yes
Pool address.
0xbebc44782c7db0a1a60cb6fe97d0b483032ff1c7
live
No
Shows the data as soon as the block is validated. (Default: false, in case of block reorganization).
true
start_block
No
Starting block height (inclusive).
129870
end_block
No
Ending block height (inclusive).
130000
start_time
No
Starting time in ISO 8601 (inclusive).
2022-04-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
sort
No
Returns the data in ascending (asc) or descending (desc) order. Default: desc.
asc
page_size
No
100
blockchain
The blockchain on which the transaction happened.
ethereum
block_number
The height of the block.
129876
pool_name
Name of the pool as it is written on the blockchain.
3pool
pool_address
Address of the contract of the pool.
0xbebc44782c7db0a1a60cb6fe97d0b483032ff1c7
exchange
Code of the DEX.
curv
amounts
Snapshot of the liquidity pool's tokens.
See example
datetime
Timestamp at which the interval begins. In seconds.
1650441900
This endpoint uses our Raw order book snapshot as source data and enhances its raw data with the Price Slippage metric.
Price Slippage calculates the potential slippage for a market buy order if it were placed at the time the Order Book Snapshot was taken.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
continuation_token
No
page_size
No
sort
No
Return the data in ascending (asc) or descending (desc) order.
Default: desc
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
slippage
No
Order size (in quote asset) for which to calculate the percentage of slippage.
Default: 0
.
When null
is returned, not enough volume is present on the order book to execute the order.
slippage_ref
No
Price point for which to calculate slippage from. Either from the mid price (mid_price
) or from the best bid/ask (best
).
Default: mid_price
.
poll_timestamp
The timestamp at which the raw data snapshot was taken.
poll_date
The date at which the raw data snapshot was taken.
timestamp
The timestamp provided by the exchange. null
when not provided.
ask_slippage
The percentage price slippage for a market buy order placed at the time that the order book snapshot was taken.
bid_slippage
The percentage price slippage for a market sell order placed at the time that the order book snapshot was taken.
This endpoint returns the average price slippage for the requested period. Read more about how the aggregation period works here: .
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
continuation_token
No
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1h
.
page_size
No
sort
No
Return the data in ascending asc
or descending desc
order. Default desc
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
slippage
No
Order size (in quote asset) for which to calculate the percentage of slippage.
Default: 0
.
When null
is returned, not enough volume is present on the order book to execute the order.
slippage_ref
No
Price point for which to calculate slippage from. Either from the mid price (mid_price
) or from the best bid/ask (best
).
Default: mid_price
.
poll_timestamp
The timestamp at which the interval begins.
ask_slippage
The average percentage of price slippage for a market buy order over a specified interval.
bid_slippage
The average percentage of price slippage for a market sell order over a specified interval.
This endpoint returns the average market depth for the requested period.
We are unable to collect the full 10% snapshot from all exchanges we cover. Thus, for some exchanges, 'Market Depth' does not accurately portray the exchange's order book volume.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
continuation_token
No
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1h
.
page_size
No
sort
No
Return the data in ascending asc
or descending desc
order. Default desc
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
poll_timestamp
The timestamp at which the interval begins
bid_volume_x
The average volume of bids placed within 0 and x% of the best bid over a specified interval.
ask_volume_x
The average volume of asks placed within 0 and x% of the best ask over a specified interval.
This endpoint returns the following metrics, averaged for the requested period.
Bid volume
Ask volume
Bid-ask spread
Price Slippage
We are unable to collect the full 10% snapshot from all exchanges we cover. Thus, for some exchanges, 'Market Depth' does not accurately portray the exchange's order book volume.
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
instrument_class
Yes
instrument
Yes
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
continuation_token
No
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1h
.
page_size
No
sort
No
Return the data in ascending asc
or descending desc
order. Default desc
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
slippage
No
Order size (in quote asset) for which to calculate the percentage of slippage. Default: 0. When null
is returned, not enough volume is present on the order book to execute the order.
slippage_ref
No
Price point for which to calculate slippage from. Either from the mid price (mid_price
) or from the best bid/ask (best
). Default: mid_price
.
poll_timestamp
The timestamp at which the interval begins.
bid_volume_x
The average volume of bids placed within 0 and x% of the best bid over a specified interval.
ask_volume_x
The average volume of asks placed within 0 and x% of the best ask over a specified interval.
spread
The average difference between the best bid and the best ask over a specified interval.
mid_price
The average mid price between the best bid and the best ask over a specified interval
ask_slippage
The average percentage of price slippage for a market buy order over a specified interval.
bid_slippage
The average percentage of price slippage for a market sell order over a specified interval.
This endpoint retrieves information on instruments (exchange trading pairs) and their associated codes.
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
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.
The raw data on which our Level 2 Aggregations such as market depth , bid/ask spread, and price slippage are built. Details a point-in-time view of the bids and asks on an exhange's order book to 10% depth. Used to build your own custom level 2 aggregations. The snapshot is produced every 30 seconds.
This endpoint provides information about lending pools. It shows data such as how many tokens has been deposited and borrowed, as well as the interest rates for lending and borrowing at each block.
AAVE v1
AAVE v2
Compound
Cream
Maker
This endpoint returns raw order book used to calculate our aggregations, alongside the aggregations:
Market Depth - provides insight into the "depth" of an exchange's order book by aggregating the volume of bids and asks within 0-10% of the best bid or ask, respectively. A higher volume of bids and asks at each level implies more liquidity.
Price Slippage - calculates the potential slippage for a market buy order if it were placed at the time the Order Book Snapshot was taken.
Bid-ask Spread - The bid-ask spread is the difference between the highest price that a buyer is willing to pay for an asset (the bid) and the lowest price that a seller is willing to accept (the ask). A smaller spread implies more liquidity.
Should be one of the currently supported blockchains.
Number of snapshots to return data for. (default: 10, min: 1, max: 10). See
Should be one of the currently supported blockchains. See
Number of snapshots to return data for. (default: 1000, min: 1, max: 1000). See
See
Instrument class
.
See
Instrument code
.
See
See
Number of snapshots to return data for.
Default: 10
Max: 100
See
Automatically included in continuation tokens.
See
Instrument class
.
See
Instrument code
.
See
See
Number of snapshots to return data for. (default: 10, max: 100). See Automatically included in continuation tokens.
See
Instrument class
.
See
Instrument code
.
See
See
Number of snapshots to return data for. (default: 10, max: 100). See Automatically included in continuation tokens.
See
Instrument class
.
See
Instrument code
.
See
See
Number of snapshots to return data for. (default: 10, max: 100). See Automatically included in continuation tokens.
You can explore all exchanges, assets, and get codes for them using our . Alternatively, if you want to obtain the data in a more programmatic way, use this endpoint.
You can explore all exchanges, assets, and get codes for them using our . Alternatively, if you want to obtain the data in a more programmatic way, use this endpoint.
You can explore all exchanges, assets, and get codes for them using our . Alternatively, if you want to obtain the data in a more programmatic way, use this endpoint.
protocol
The protocol code. ex:crm
,aav2
, curv
, blc2
exchange_code
No
Exchange code
. See
base_asset
No
The desired base asset code
. See
quote_asset
No
The desired quote asset code
. See
code
No
Kaiko identifier for the instrument. Always base_asset-quote_asset
for spot
instruments.
kaiko_legacy_symbol
No
Kaiko legacy instrument symbol.
class
No
spot
, future
, perpetual-future
, option
, etc.
base_asset_class
No
Base asset class
.
quote_asset_class
No
Quote asset class
.
trade_start_timestamp
No
Starting time in ISO 8601 (inclusive).
trade_end_timestamp
No
Ending time in ISO 8601 (inclusive). Can also use "ongoing" to get ongoing instruments.
trade_count_min
No
Minimum number of trades.
trade_count_max
No
Maximum number of trades.
with_list_pools
No
true
or false
. For pairs traded on DEXs, provides the list of underlying pools to each instrument.
continuation_token
No
See
page_size
No
Maximum number of records to return in one response
orderBy
No
Order results by a specifit field. See below for all possible values.
order
No
Return the data in ascending (1) or descending (-1) order
blockchain
No
Filter on a specific blockchain for on-chain instruments.
base_asset
Base asset.
class
spot
, future
, perpetual-future
,...
code
Kaiko identifier for the instrument. Always base_asset-quote_asset
for spot
instruments.
exchange_code
Exchange code. See
exchange_pair_code
Identifier for the instrument used by the exchange.
For perpetual futures pairs, the code may differ from the exchange's and include a _perp
suffix (e.g., btcusdt_perp)
.
kaiko_legacy_exchange_slug
Legacy slug for the exchange. See
kaiko_legacy_symbol
Identifier used in past deliveries of historical market data and Data Feed.
quote_asset
Quote asset
trade_start_time
Time of the first available trade in Kaiko's data set.
trade_start_timestamp
Timestamp of the first available trade in Kaiko's data set.
trade_end_time
Time of the last available trade in Kaiko's data set. null
if instrument is still active
trade_end_timestamp
Timestamp of the last available trade in Kaiko's data set. null
if instrument is still active
trade_count
The total number of trades available through Kaiko Rest API and Kaiko Stream. For active pairs, this is an approximation.
trade_compressed_size
Approximate size in bytes of all available trades in Kaiko Stream.
list_pools
The list of the underlying pools to each instrument. (Only when arg with_list_pools=true
is provided).
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
See Exchange codes
instrument_class
Yes
Instrument class
.
See Exchange trading pair codes (instruments)
instrument
Yes
Instrument code
.
See Exchange trading pair codes (instruments)
continuation_token
No
See Pagination
limit_orders
No
Number of orders to return on bid and ask side per snapshot.
To retreive the best bid/ask, set this parameter to 1
Default: 10
page_size
No
Number of snapshots to return data for.
Default: 10
Max: 100
See Pagination
Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc) or descending (desc) order.
Default: desc
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
poll_timestamp
The timestamp at which the raw data snapshot was taken.
poll_date
The date at which the raw data snapshot was taken.
timestamp
The timestamp provided by the exchange. null
when not provided.
asks
The sell orders in the snapshot. If the limit_oders
parameter is used, this will be reflected here. amount
is the quantity of asset to sell, displayed in the base currency. price
is displayed in the quote currency.
bids
The buy orders in the snapshot. If the limit_oders
parameter is used, this will be reflected here. amount
is the quantity of asset to buy, displayed in the base currency. price
is displayed in the quote currency.
blockchain
One or several of the currently supported blockchain.
Default: ethereum
.
See Blockchain codes
ethereum
protocol
One or several of the currently supported L&B protocols.
aav1
asset
L&B events including the requested token. Default: all available tokens.
tusd
live
Shows the data as soon as the block is validated.
(Default: false
, in case of block reorganization).
true
block_number
Block height.
10795593
start_block
Starting block height (inclusive).
129870
end_block
Ending block height (inclusive).
130000
start_time
Starting time in ISO 8601 (inclusive).
2022-04-01T00:00:00.000Z
end_time
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
interval
Interval between each snapshot. The suffixes are s (second), m (minute), h (hour), d (day), b (block), change (whenever a change happens). Default: 1b.
152s
sort
Returns the data in ascending or descending order. Default: desc.
ascending
page_size
Number of snapshots to return data for.
(default: 100
, min: 1, max: 1000
).
See Pagination
1000
blockchain
The blockchain on which the transaction happened.
ethereum
block_number
The height of the block in which the transaction happened.
16025918
datetime
The timestamp of the block in which the transaction happened.
1669124591
protocol
Code of the L&B protocol.
aave/v2
asset_symbol
Symbol of the underlying asset.
crv
asset_address
Address of the underlying asset.
0xd533a949740bb3306d119cc777fa900ba034cd52
asset_decimals
Decimals of the underlying asset.
18
receipt_symbol
Symbol of the receipt asset.
acrv
receipt_address
Address of the receipt asset.
0x8dae6cb04688c62d939ed9b68d32bc62e49970b1
receipt_decimals
Decimals of the receipt asset.
18
total_liquidity
The total amount of liquidity for this pool.
1486160
available_liquidity
The total amount of available liquidity for this pool.
1279630
total_borrowed
The total amount of tokens borrowed for this pool.
206535
supply_rate
The supply rate.
0.00289186
stable_borrow_rate
The stable borrow rate.
0.0442648
variable_borrow_rate
The variable borrow rate.
0.0208089
metadata
Metadata specific to each protocol.
More information below
total_borrowed_stable
The total amount of assets borrowed with a stable rate for this pool.
0
total_borrowed_variable
The total amount of assets borrowed with a variable rate for this pool.
41872.928778
total_borrowed_stable
The total amount of assets borrowed with a stable rate for this pool.
4162389.524515
total_borrowed_variable
The total amount of assets borrowed with a variable rate for this pool.
345075360.304631
total_reserves
Total liquidity - All of the debt tokens supply.
51387128.92415
total_reserves
Total liquidity - All of the debt tokens supply.
3486037.365878
total_reserves
Total liquidity - All of the debt tokens supply.
033661.402437
collateral_ratio
Minimum ratio of collateral before liquidation.
1.5
debt_ceiling
Maximum amount of DAI that can be emitted on this type of vault.
2500000
debt_floor
Minimum amount of DAI that can be minted for this type of Vault.
2000
blockchain
No
Should be one of the currently supported blockchains. See Blockchain codes
ethereum
protocol
No
Filter on a currently supported DEX.
usp2
pool_address
No
Pool address related to the liquidity event. Default: all liquidity pools.
0x14de8287adc90f0f95bf567c0707670de52e3813
pool_contains
No
Mints and burns including the requested token. Default: all available tokens.
weth
or weth,usdt,usdc
block_number
No
Block height.
129876
user_addresses
No
Filter on specific user addresses (comma separated).
0x479bc**
live
No
Shows the data as soon as the block is validated.
(Default: false
, in case of block reorganization).
true
tx_hash
No
Filter on a specific transaction hash.
0xe68b84740**
start_block
No
Starting block height (inclusive).
129870
end_block
No
Ending block height (inclusive).
130000
start_time
No
Starting time in ISO 8601 (inclusive).
2022-04-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
sort
No
Returns the data in ascending asc
or descending desc
order.
Default: desc
.
asc
type
No
Event type. By default both burn and mint are shown.
burn
or mint
page_size
No
Number of snapshots to return data for. (default: 1000, min: 1, max: 1000). See Pagination
500
blockchain
The blockchain on which the transaction happened.
ethereum
block_number
The height of the block in which the transaction happened.
129876
type
Event type: mint or burn.
burn
or mint
pool_name
Name of the pool as it is written on the blockchain.
USDC-WETH-0.001
pool_address
Address of the contract of the pool.
0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640
exchange
Code of the DEX.
usp3
transaction_hash
Transaction hash
0x3d28ec9f35692ee6e9264735cd4f92c48bccda82487144d26ebc12376a418cdc
log_index
The log index of the transaction (in base 10)
152
user_address
Address that triggered the transaction.
0x479bc00624e58398f4cf59d78884d12fb515790a
price
Price of the token at the moment of the event.
0.000358096
amounts
Amounts of the tokens
See example
datetime
Timestamp at which the interval begins. In seconds.
1650441900
metadata
Only for Uniswap v3. Upper and lower ticker of the interval on which the liquidity is provided
{"lower_ticker": 190650, "upper_ticker": 195610}
region
Yes
Choose between eu
and us
.
exchange
Yes
Exchange code.
See Exchange codes
instrument_class
Yes
Instrument class
.
See Exchange trading pair codes (instruments)
instrument
Yes
Instrument code
.
See Exchange trading pair codes (instruments)
continuation_token
No
See Pagination
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
limit_orders
No
Number of orders to return on bid and ask side per snapshot.
To retrieve the best bid/ask, set this parameter to 1
Default: 10
page_size
No
Number of snapshots to return (default: 10, max: 100). See Pagination Automatically included in continuation tokens.
sort
No
Return the data in ascending asc
or descending desc
order.
Default: desc.
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
slippage
No
Order size (in quote asset) for which to calculate the percentage of slippage.
Default: 0
.
When null
is returned, not enough volume is present on the order book to execute the order.
slippage_ref
No
Price point for which to calculate slippage from. Either from the mid-price (mid_price
) or from the best bid/ask (best
).
Default: mid_price
.
poll_timestamp
The timestamp at which the raw data snapshot was taken.
poll_date
The date at which the raw data snapshot was taken.
timestamp
The timestamp provided by the exchange. null
when not provided.
bid_volume_x
The volume of bids placed within 0 and x% of the best bid. This is what we call "Market Depth"
ask_volume_x
The volume of asks placed within 0 and x% of the best ask. This is what we call "Market Depth"
spread
The difference between the best bid and the best ask at the time the snapshot was taken. This is what we call "Bid Ask Spread"
mid_price
The mid price between the best bid and the best ask.
ask_slippage
The percentage price slippage for a market buy order placed at the time that the order book snapshot was taken.
bid_slippage
The percentage price slippage for a market sell order placed at the time that the order book snapshot was taken.
asks
The sell orders in the snapshot. If the limit_oders
parameter is used, this will be reflected here. amount
is the quantity of asset to sell, displayed in the base currency. price
is displayed in the quote currency.
bids
The buy orders in the snapshot. If the limit_oders
parameter is used, this will be reflected here. amount
is the quantity of asset to buy, displayed in the base currency. price
is displayed in the quote currency.
id
The blockchain's id in our reference data.
name
The blockchain's name in our reference data.
is_evm
If the blockchain is EVM-Compatible or not.
Accurately value your digital assets to meet fair value standards and regulatory requirements.
This API provides circulating supply and market capitalization data for over 250 crypto assets. The data is an indicative value aggregated from multiple sources on a daily basis, starting from the asset’s deployment to the present day. Market capitalization is provided only when a reliable price for the day can be ensured.
asset
The asset you'd like information on.
Currently supported assets: 1inch, AAVE, ACH, ADA, AGIX, AGLD, ALGO, ALICE, AMP, ANKR, ANT, API3, APT, AR, ARB, ARPA, ATOM, AUDIO, AURA, AVAX, AXS, BAL, BAND, BAT, BCH, BETA, BICO, BIT, BLEO, BLUR, BNB, BNT, BOND, BORA, BSV, BTC, BTG, BTRFLY, BTSE, BTT, BUSD, BZZ, C98, CAKE, CDAI, CEL, CELO, CELR, CFX, CHSB, CHZ, CKB, COCOS, COMP, COTI, CQT, CRON, CRV, CSPR, CTSI, CUSDC, CVC, CVX, CVXCRV, DAI, DAO, DASH, DCR, DEXE, DFI, DGB, DOGE, DOT, DPX, DYDX, EFI, EGLD, ELON, ENJ, ENS, EOS, ETC, ETH, EURS, EVER, FET, FIL, FLOKI, FLOW, FLUX, FRAX, FRXETH, FTM, FXS, GAL, GALA, GFARM2, GLM, GLMR, GMX, GNO, GOG, GRT, GTC, GTX, GUSD, HBAR, HBTC, HFT, HIVE, HLM, HOT, HT, ICP, ID, ILV, IMX, INJ, INST, IOST, IOTA, IOTX, JASMY, JST, KAVA, KCS, KDA, KEEP, KLAY, KNC, KSM, LDO, LEVER, LINK, LOOKS, LPT, LQTY, LRC, LSK, LTC, LUNA, LYXE, MANA, MASK, MATIC, MBOX, MC, MEME, MIM, MINA, MIR, MKR, MLK, MULTI, NANO, NEAR, NEO, NEST, NEXO, NFT, NMR, NOIA, NU, NXRA, OCEAN, OGN, OHM, OKB, OKT, OMG, ONE, ONT, OP, OPUL, ORBS, OSMO, PAXG, PEOPLE, PHA, PLA, POLY, POND, PUNDIX, QNT, QTUM, RAD, RAIL, RBN, RDPX, REN, REQ, RIF, RLC, RLY, RNDR, RON, ROSE, RPETH, RPL, RSR, RUNE, RVN, SAITO, SAND, SC, SCRT, SETH, SFP, SFRXETH, SHIB, SKL, SNT, SNX, SOL, SPELL, SSV, STETH, STG, STORJ, STX, SURE, SUSD, SUSHI, SX, SXP, SYN, SYS, TEL, TFUEL, THETA, TRAC, TRIBE, TRX, TUSD, TWT, UMA, UNI, USDC, USDP, USDT, UST, VEN, VENUS, VGX, VTHO, WAVES, WAX, WBTC, WEMIX, WOO, XAUT, XCH, XDCE, XEC, XEM, XLM, XMR, XRD, XRP, XTZ, YFI, YFII, YGG, ZEC, ZEN, ZRX.
start_time
Yes
Start time.
2020-01-01T00:00:00.000Z
end_time
No
End time.
2023-11-08T00:00:00.000Z
page_size
No
Response page size. Default: 10
.
100
sort
No
Sort results in asc
or desc
order.
desc
timestamp
Timestamp of the block.
1670976000
asset
Ticker of the asset.
btc
circulating_supply
Circulating supply of the asset.
19248126.084439
market_cap
Market cap = Circulating supply x USD price.
345082843135.89093
Forecast market volatility with implied volatility models and access real-time contract-level derivatives data, including trading volume, open interest, funding rates, and options Greeks.
Analyze and report portfolio performance and measure potential investment losses.
This endpoint returns a price calculation for a specific pair by aggregating prices from our Trade Data. Read the methodology to learn about the calculation process.
If a null value is returned, it means there are not enough trades to calculate a direct price. In this case, use Kaiko Fair Market Value (Synthetic prices for low liquidity pairs) instead.
base_asset
Yes
quote_asset
Yes
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default is desc
.
interval
Yes
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 24h
.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive) Automatically included in continuation tokens.
page_size
No
Less than or equal to 1m
Default: 10
, Max: 100
1m
to 1h
Default: 4
, Max: 10
More than 1h
Default: 1
, Max: 4
Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default is desc
.
include_exchanges
No
exclude_exchanges
No
extrapolate_missing_values
No
When true
, if there are any null
(missing) prices for the calculation, they will be filled in using the last available price from the window requested. This is useful for assets that don't have a lot of trades or for data that is collected very frequently.
However, if the parameter is set to true
and no prices were available in that window, a null
value will still be returned.
timestamp
Timestamp at which the interval begins.
price
volume
Total volume in base asset traded in the interval.
0
when no trades are reported, except if extrapolate_missing_values
is true
.
count
Total amount of trades reported during the interval.
0
when no trades are reported, except if extrapolate_missing_values
is true
.
extrapolate_missing_values
true
if the value has been extrapolated from the last computed value available, false
if not.
Derivatives price endpoint
This endpoint shows the mark price, index price, and price (last traded price) of a derivative.
region
Yes
Choose between eu
and us
.
exchange
Yes
Should be one of the exchanges currently supported
okex
instrument_class
Yes
future
, perpetual-future
, or option
future
instrument
Yes
btcusdt250117
interval
No
Interval period (can be one of 1m
, 1h
, 4h
, and 1d
). Default 1m
When you query data using aninterval
greater than one minute, we'll return the data from the last minute of that time period. For example, if you query data for 09:00
with the interval
set at 1h
, we'll return data from 09:59
(since that's the last minute of the 09:00-10:00 hour period).
1h
page_size
No
10
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default desc
asc
start_time
No
Starting time in ISO 8601 (inclusive).
2025-01-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (exclusive).
2025-01-04T00:00:00.000Z
timestamp
Timestamp at which the interval begins. In milliseconds.
1650441900000
index_price
The price of the underlying index, often as a weighted average across multiple exchanges' spot prices
39713.3
mark_price
The mark price of the contract. It is used for calculating profit and loss (PnL) and liquidation price. Designed to be fair and avoid price manipulation.
39745.9
price
Most recent traded price of derivative contract
39767
timestamp
Timestamp at which the interval begins. In milliseconds.
1735850520000
index_price
The price of the underlying index, often as a weighted average across multiple exchanges' spot prices
97353.8
mark_price
The mark price of the contract. It is used for calculating profit and loss (PnL) and liquidation price. Designed to be fair and avoid price manipulation.
104276.62
price
Most recent traded price of derivative contract
104293.8
timestamp
Timestamp at which the interval begins. In milliseconds.
1735850520000
index_price
The price of the underlying index, often as a weighted average across multiple exchanges' spot prices
97508.58
mark_price
The mark price of the contract. It is used for calculating profit and loss (PnL) and liquidation price. Designed to be fair and avoid price manipulation.
0.0061
price
Most recent traded price of derivative contract
0.0065
This endpoint provides details of the contracts, including base asset, quote asset, contract size, contract size unit, listing_timestamp, expiry, strike price, and underlying index.
region
Yes
Choose between eu
and us
.
exchange
Yes
Should be one of the exchanges currently supported
okex
instrument_class
Yes
future
, perpetual-future
, or option
future
instrument
No
ethusd220624
, btc*220624
, *usdt
, btc*may22*
base_assets
No
For finding the instruments with the certain base asset
btc
, eth
quote_assets
No
For finding the instruments with the certain quote asset
usd
, usdt
option_type
No
option
only. For finding either only the call options or put options
C
, P
min_strike
No
option
only. Used to retrieve options whose strike price is above this minimum value (exclusive/inclusive)
10000
max_strike
No
option
only. Used to retrieve options whose strike price is below this maximum value (exclusive/inclusive)
90000
start_time
No
future
& option
only. Used to retrieve futures and options that expire after this date and time (inclusive)
2022-06-23T00:01:00.000Z
end_time
No
future
& option
only. Used to retrieve futures and options that are listed before this date and time (exclusive)
2022-06-25T23:59:00.000Z
page_size
No
500
exchange
The exchange where the specified instrument is being traded
binc
instrument_class
Shows wether the specified instrument is future
, perpetual-future
or option
perpetual-future
instrument
The specified instrument
btc-usdc
base
The base asset of the instrument
btc
quote
The unit in which the instrument is quoted
usdc
contract_size
Size of the contract
1
contract_size_unit
Unit in which contract is denominated
btc
listing_timestamp
Date listed by exchange
2024-01-03 12:30:00 UTC
funding_rate_frequency
Interval at which the funding rate is paid
8h
exchange
The exchange where the specified instrument is being traded
okex
instrument_class
Shows wether the specified instrument is future
, perpetual-future
or option
future
instrument
The specified instrument
btcusdt250117
base
The base asset of the instrument
btc
quote
The unit in which the instrument is quoted
usdt
contract_size
Size of the contract
0.01
contract_size_unit
Unit in which contract is denominated
btc
listing_timestamp
The timestamp when a certain option instrument is listed on the exchange
2025-01-03 08:10:00 UTC
expiry
Expiration date of the contract
2025-01-17 08:00:00 UTC
exchange
The exchange where the specified instrument is being traded
drbt
instrument_class
Shows wether the specified instrument is future
, perpetual-future
or option
option
instrument
The specified instrument
btc10dec21100000c
base
The base asset of the instrument
btc
quote
The unit in which the instrument is quoted
usd
contract_size
Size of the contract
1
contract_size_unit
Unit in which contract is denominated
btc
listing_timestamp
The timestamp when a certain option instrument is listed on the exchange
2021-11-18 08:16:00 UTC
expiry
Expiration date of the contract
2021-12-10 08:00:00 UTC
strike_price
The strike price of the contract in USD.
30000
underlying_index
Name of the underlying asset
BTC-10DEC21
You can get a list of all the futures or options that can be traded between two specific times by using the start_time
and end_time
settings. For instance, if you're interested in all the futures or options that can be traded between October 1, 2022, and October 2, 2022, you would set start_time as 2022-10-01T00:00:00.000Z
and end_time as 2022-10-03T00:00:00.000Z
. If you want to find futures or options that were traded at a specific time, simply use the same time for both start_time
and end_time
. If you only provide one of the start_time
or end_time
, the other one will be automatically determined as shown in the table below.
Given
Given
start_time (ISO 8601)
and end_time (ISO 8601)
are the specified datetime respectively
Given
Not given
end_time (ISO 8601)
= start_time (ISO 8601)
+ 1 day
Not given
Given
start_time (ISO 8601)
= end_time (ISO 8601)
- 1 day
Not given
Not given
all the instruments will be shown regardless of dates
This add-on endpoint ensures IFRS-compliant currency conversions for over 70 fiat pairs when a synthetic price is used in Fair Market Value Pricing. While synthetic prices can be generated in any fiat currency, this endpoint guarantees compliance for non-USD currencies. In low-liquidity cases, users request a synthetic price quoted in USD, then convert it into their desired fiat currency using this endpoint.
quote
Yes
The quote fiat currency. Automatically included in continuation tokens.
base
Yes
The base fiat currency. Automatically included in continuation tokens.
continuation_token
No
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
interval
No
The interval parameter is suffixed with m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one minute and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are m
(minute), h
(hour) and d
(day).
Default 1h
.
For each interval, the resulting FX rate is an average of all available FX rates over that period.
Automatically included in continuation tokens.
page_size
No
Default: 100
Automatically included in continuation tokens.
start_time
No
Starting time in ISO 8601 (inclusive). Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default is desc
.
Automatically included in continuation tokens.
timestamp
Timestamp at which the interval ends.
fx_rate
Average fx rate over the interval.
Thuis endpoints helps you calculate value at risk. Computed by a proprietary and thoroughly backtested methodology that accounts for the idiosyncrasies of crypto market structure. By convention it's a forecasting VaR, i.e. the prediction of the potential loss for the next day.
Derivatives risk endpoint
If you need implied volatilities for expiry dates that are not listed, you can use the "implied volatility surface" endpoint to calculate this.
The IV Smile endpoint lets you calculate volatility on a minute-by-minute basis from options market prices. The endpoint returns a volatility curve for a specific expiry date.
You can get volatility estimates by providing the following information:
Strikes
Forward-log-moneyness
Deltas
The calculation methodology leverages space interpolation.
Currently supported assets and exchanges:
BTC, ETH, SOL, MATIC, XRP on Deribit.
BTC, ETH on OKX.
BTC, ETH on Deribit & OKX (aggregated).
If you need data from other exchanges, we can add them on request.
Short listed-maturities (e.g. 7 days time-to-maturity) are only available for individual exchanges.
Use this example to calculate IV using deltas.
Use this example to calculate IV using forward log moneyness.
Use this example to calculate IV using strikes.
Use this example to calculate IV using deltas
Use this example to calculate IV using forward log moneyness
Use this example to calculate IV using forward log moneyness
The desired base asset code
.
See
The desired quote asset code
.
See
See
Page size limits differ by the interval
selected:
List of exchanges' code
to include in the calculation.
Default is all exchanges.
Automatically included in continuation tokens.
List of exchanges' code
to exclude in the calculation.
Automatically included in continuation tokens.
.
null
when no trades reported, except if extrapolate_missing_values
is true
Instrument code
.
See
One instrument returned per query.
Number of snapshots to return data for. (default: 100, min: 1, max: 1000). See
Information from this endpoint can be accessed through Google BigQuery. To get started, read our .
Instrument code
.
See
Number of snapshots to return data for. (default: 1000, min: 1, max: 1000). See
See
See
Minimum: 1
Maximum: 1000
This endpoint calculates a synthetic price when there is no liquidity (historic trades) between two assets (fiat or digital). Let's say, for example, there was no liquidity between NEXO and GBP, but you need a price. To calculate this, the liquidity engine will use a series of intermediary assets where there is liquidity (lots of trading history) to calculate the price for NEXO > GBP. To demonstrate how this calculation works, the engine might take the price for NEXO > BTC (where there is plenty of liquidity) and then the price of BTC > GBP (where there is also lots of liquidity) and combine the two to determine a robust synthetic price for NEXO > GBP. The engine will always use the path of highest liquidity, meaning several intermediary assets might be used. Read the full methodology .
When using a synthetic price, in order to to meet IFRS-compliance standards, any fiat currency value should be requested in USD and converted using the .
Information from this endpoint can be accessed through Google BigQuery. To get started, read our .
base_asset
Yes
The desired base asset code
.
See Asset codes
quote_asset
Yes
The desired quote asset code
.
See Asset codes
timestamp
Timestamp at which the interval begins.
price
Aggregated Robust Weighted Median using liquidity path engine.
null
when no trades reported, except if extrapolate_missing_values
is true
.
Liquidity path is calculated every 4 hours seeking for the most liquid pairs to convert from base asset to quote asset.
extrapolate_missing_values
true
if the value has been extrapolated from the last computed value available, false
if not.
bases
Yes
List of portfolio base components. See Asset codes
Total must match quantities
below.
The order of bases
and their respective quantities
must match in the request.
quote
Yes
The fiat currency. Asset codes
quantities
Yes
Quantities list of base asset in the portfolio.
Must match the number of bases
.
The order of quantities
and their respective bases
must match in the request.
risk_level
Yes
The Value at Risk confidence level.
Min: 0.90
(included)
Max: 1
(excluded)
start_time
Yes
First fixing of the calculation in ISO 8601 (inclusive).
end_time
Yes
Last fixing of the calculation in ISO 8601 (inclusive).
sources
No
boolean. If true, returns all pair prices which were used to compute the Value at Risk.
Default: false
var_time
The time at which the VaR is computed.
value_at_risk
Composed of two fields: value and risk_level (the Value at Risk estimator at the specified risk_level.)
additional_vars
List of additional VaRs for standard risk levels.
pair
The constituent pair. (showing only when sources
is set to be true)
ref_price
The reference price per asset. (showing only when sources
is set to be true)
date
The date of the reference price. (showing only when sources
is set to be true)
region
Yes
Choose between eu
and us
.
exchange
Yes
Should be one of the exchanges currently supported
okex
instrument_class
Yes
future
, perpetual-future
, or option
future
instrument
Yes
Instrument code
.
See Exchange trading pair codes (instruments)
One instrument returned per query.
btcusdt250117
interval
No
Interval period (can be one of 1m
, 1h
, 4h
, and 1d
). Default 1m
When you query data using aninterval
greater than one minute, we'll return the data from the last minute of that time period. For example, if you query data for 09:00
with the interval
set at 1h
, we'll return data from 09:59
(since that's the last minute of the 09:00-10:00 hour period).
1h
page_size
No
Number of snapshots to return data for. (default: 100, min: 1, max: 1000). See Pagination
10
sort
No
Return the data in ascending (asc) or descending (desc) order. Default desc
asc
start_time
No
Starting time in ISO 8601 (inclusive).
2025-01-01T00:00:00.000Z
end_time
No
Ending time in ISO 8601 (exclusive).
2025-01-04T00:00:00.000Z
timestamp
Timestamp at which the interval begins. In milliseconds.
1650441900000
24h_volume
The volume of the trades executed in the last 24 hours (can be in base_asset, quote_asset or the number of contracts)
5270648
open_interest
The total outstanding number of contracts (units in which open interest metrics are quoted vary by exchange)
1127623
funding_rate
The current funding rate.
-0.0000756735759807
predicted_funding_rate
The predicted funding rate for the next period.
-0.0000845044644161
timestamp
Timestamp at which the interval begins. In milliseconds.
1650441900000
24h_volume
The volume of the trades executed in the last 24 hours (can be in base_asset, quote_asset or the number of contracts)
5270648
open_interest
The total outstanding number of contracts (units in which open interest metrics are quoted vary by exchange)
1127623
time_to_expiry
The number of minutes remaining before expiry.
41504
nearby
The soonest expiring contract with the same base & quote asset on the specified exchange
boolean value
quarterly_nearby
The soonest expiring quarterly contract with the same base & quote asset on the specified exchange
boolean value
timestamp
Timestamp at which the interval begins. In milliseconds.
1650441900000
24h_volume
The volume of the trades executed in the last 24 hours (can be in base_asset, quote_asset or the number of contracts)
5270648
open_interest
The total outstanding number of contracts (units in which open interest metrics are quoted vary by exchange)
1127623
time_to_expiry
The number of minutes remaining before expiry.
41504
nearby
The soonest expiring contract with the same base & quote asset on the specified exchange
boolean value
quarterly_nearby
The soonest expiring quarterly contract with the same base & quote asset on the specified exchange
boolean value
ask_iv
Implied volatility for the best ask.
57.5
bid_iv
Implied volatility for the best bid.
65.4
mark_iv
The implied volatility for the mark price.
69.42
delta
The delta value for the option.
0.8841
gamma
The gamma value for the option.
0.00003
rho
The rho value for the option.
21.26122
theta
The theta value for the option.
-26.18193
vega
The vega value for the option.
2.36321
region
Yes
Choose between eu
and us
.
base
Yes
The desired base as the underlying of the options. See supported assets above.
btc
, eth
quote
Yes
The desired quote as the underlying of the options.
usd
or usdc
usd
value_time
Yes
The time at which to compute implied volatilities The time t should be smaller than the expiry T
2022-09-20T16:15:00.000Z
expiry
Yes
The expiry for which the implied volatilities are to be computed Must be an existing expiry on the selected exchange and tradable at the time of the computation.
2022-12-30T08:00:00.000Z
strikes
Yes, if neither forward_log_moneynesses
nor deltas
parameters are used.
The strike prices for which the implied volatilities are to be computed. Strike prices can be existing or non-existing ones (space interpolation included)
Either strikes
or forward_log_moneynesses
or deltas should be filled.
singular: 10000
plural: 10000,15000,20000
forward_log_moneynesses
Yes, if neither strikes
nor deltas
parameters are used.
The forward log moneyness for which the implied volatilities are to be computed.
Either strikes, forward_log_moneynesses
or deltas
should be filled.
singular: 1
plural: -1,-0.5,0,0.5,1
deltas
Yes, if neither forward_log_moneynesses
nor strikes
parameters are used.
The delta levels (of a Call option) for which the implied volatilities are to be computed.
Either strikes, forward_log_moneynesses
or deltas
should be filled.
exchanges
No
The desired exchange as source of options data. See supported exchanges above.
drbt
value_time
The time in parameter
2022-09-20T16:15:00.000Z
expiry
The expiry in parameter
2022-12-30T00:00:00.000Z
time_to_expiry
The associated time to expiry in year
0.27580868156450355
implied_volatilities
The list of requested implied volatilities
[{"strike": 40000,
"forward_log_moneyness": 0.7348555803648208,
"implied_volatility": 0.7341747093260883,
"delta": 0.04334612697660922,
"gamma": 0.000012437991693543254},
{"strike": 20000,
"forward_log_moneyness": 0.041708399804875465,
"implied_volatility": 0.6670092468551713,
"delta": 0.5223606946028295,
"gamma": 0.00005929353471794603}, ... ]
delta
The first derivative of the price with regards to the underlying price.
2.8863019124747424e-7
gamma
The second derivative of the price with regards to the underlying price.
2.416523346501216e-10
current_spot
The underlying spot price at the value timestamp.
71717
interest_rate
The implied interest rate.
0.14954983972466698
Explore market dynamics of assets and exchanges, including trading volumes, market depth, token metrics, and both on-chain and off-chain transaction data.
Crypto benchmarks built on enterprise-grade data. 24/7 infrastructure and support.
For a clear overview of the various Kaiko Indices access points, visit the Knowledge Hub.
start_time
No
Start time in ISO 8601 (exclusive). Automatically included in continuation tokens.
end_time
No
Ending time in ISO 8601 (exclusive). Automatically included in continuation tokens.
interval
No
The interval parameter is suffixed with s
, m
, h
or d
to specify seconds, minutes, hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are s
(second), m
(minute), h
(hour) and d
(day).
Default 1d
.
page_size
No
See Pagination
Page size limits differ by the interval
selected:
Less than or equal to 1m
Default: 10
, Max: 100
1m
to 1h
Default: 4
, Max: 10
More than 1h
Default: 1
, Max: 4
Automatically included in continuation tokens.
sort
No
Return the data in ascending (asc
) or descending (desc
) order. Default is desc
.
Automatically included in continuation tokens.
include_exchanges
No
List of exchanges' code
to include in the calculation.
Exchange codes
Default is all exchanges.
Automatically included in continuation tokens.
exclude_exchanges
No
extrapolate_missing_values
No
When true
, if there are any null
(missing) prices for the calculation, they will be filled in using the last available price from the window requested. This is useful for assets that don't have a lot of trades or for data that is collected very frequently.
However, if the parameter is set to true
and no prices were available in that window, a null
value will still be returned.
sources
No
When true,
the response includes the intermediary pair price details used to calculate the price.
Default: false
This endpoint helps inform exchange analysis with data such as total volume in USD, trades, the number of listed assets, and volume proportions by asset. The data aggregates all instruments available on the requested exchange. Only base assets are taken into consideration.
exchange
Yes
cbse
start_time
Yes
Starting time in ISO 8601 (inclusive). First time at which we want to have metrics.
2023-11-29T14:00:00.0000000Z
end_time
Yes
Ending time in ISO 8601 (exclusive). Last time at which we want to have exchange metrics.
2023-11-29T15:00:00.0000000Z
interval
Yes
The interval parameter is suffixed with h
or d
to specify hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are h
(hour) and d
(day).
Default: 1h
.
1h
sources
No
If true
, returns trading information detailed by pair.
Default: false
page_size
No
Default: 10
100
sort
No
If asc
, sort time-series in ascending. If desc, sort time-series in descending.
Default: desc
100
timestamp
Trading activity
Timestamp at which the interval begins.
2023-11-29T14:00:00.000Z
total_volume_usd
Trading activity
Total volume in USD traded in the interval. 0 when no trades are reported.
139803179.89191553
total_trade_count
Trading activity
Total trade count in the interval. 0 when no trades are reported.
121748
nb_listed_assets
Trading activity
Number of listed assets in the interval. 0 when no trades are reported.
235
nb_listed_pairs
Trading activity
Number of listed pairs in the interval. 0 when no trades are reported.
379
asset_volumes
Trading activity
Trading information details by asset.
[{"asset_code": "btc",
"asset_trade_count": 22772,
"asset_total_volume_usd": 61612344.01769975,
"asset_price_usd": 37994.62623807689,
"asset_contribution": 0.4407077440250888,
"pairs_volumes": []]}, ...]
asset_code
Trading activity
Asset code.
btc
asset_trade_count
Trading activity
Trade count in the interval by asset. 0 when no trades are reported.
159115
asset_total_volume_usd
Trading activity
Volume in USD traded in the interval by asset. 0 when no trades are reported.
61612344.01769975
asset_price_usd
Trading activity
Asset cross-price in USD used to compute volume in USD.
37994.62623807689
asset_contribution
Trading activity
Asset volume percentage over total volume.
0.4407077440250888
pairs_volumes
Trading activity
Trading information details by pair.
[{"pair_code": "btc-usd",
"pair_trade_count": 19193,
"pair_volume_usd": 57484171.99063697,
"pair_contribution": 0.9329976469345679}, ...]
pair_code
Trading activity
Pair code.
btc-usd
pair_trade_count
Trading activity
Trade count in the interval by pair. 0 when no trades are reported.
1686
pair_volume_usd
Trading activity
Volume in USD traded in the interval by pair. 0 when no trades are reported.
57484171.99063697
pair_contribution
Trading activity
Pair volume percentage over asset volume.
0.9329976469345679
This endpoint receives information on the trades involving a particular asset. Information includes volumes, trade counts, liquidity, and supply. All information is broken down by exchange. Trade data is aggregated across all instruments that include the specified token as a base or quote asset, whereas liquidity data is aggregated for the base asset only.
asset
Yes
agix
start_time
Yes
Starting time in ISO 8601 (inclusive).
2023-01-25T00:00:00.000Z
end_time
Yes
Ending time in ISO 8601 (exclusive).
2023-01-26T00:00:00.000Z
interval
Yes
The interval parameter is suffixed with h
or d
to specify hours or days, respectively.
Any arbitrary value between one second and one day can be used, as long as it sums up to a maximum of 1 day. The suffixes are h
(hour) and d
(day).
Default: 1h
.
1h
sources
No
boolean. If true, returns trading information and market depths detailed by exchanges as well as main holders.
Default: false
page_size
No
Default: 10
100
For any field in the "token information" category, we only cover ERC-20 tokens. Only 50 tokens have been backfilled, but we can add more on demand.
timestamp
Trading activity
Timestamp at which the interval begins.
2023-01-25T00:00:00.000Z
price
Trading activity
Average price in usd. null when no trades are reported.
0.1699233217119519
total_volume_usd
Trading activity
Total volume in usd traded in the interval.
0
when no trades are reported.
30508181.43789653
total_volume_asset
Trading activity
Total volume in number of assets traded in the interval.
0
when no trades are reported.
179540872.49784896
total_trade_count
Trading activity
The total amount of trades reported during the interval.
0
when no trades are reported.
159684
total_off_chain_volume_usd
Trading activity
Total off-chain volume in usd traded in the interval.
0
when no trades are reported.
30038710.382665947
total_off_chain_volume_asset
Trading activity
Total off-chain volume in number of assets traded in the interval.
0
when no trades are reported.
176778031.87949985
total_off_chain_trade_count
Trading activity
The total amount of trades reported off-chain during the interval.
0
when no trades are reported.
159115
trades_data
Trading activity
List of volume in usd, volume in number of assets and total amount of trades by centralized exchange.
[{"exchange": "binc",
"volume_usd": 27539301.29722444,
"volume_asset": 162068991,
"trade_count": 125188}, ...]
total_on_chain_volume_usd
Trading activity
Total on-chain volume in usd traded in the interval. 0 when no trades are reported.
1036710779.1918713
total_on_chain_volume_asset
Trading activity
Total on-chain volume in number of assets traded in the interval.
0
when no trades are reported.
1036710779.1918713
total_on_chain_trade_count
Trading activity
The total amount of trades reported on-chain during the interval.
0
when no trades are reported.
20513
trades_data
Trading activity
List of volume in usd, volume in number of assets and total amount of trades by decentralized exchange.
[{'exchange': 'blc2',
'volume_usd': 673716.6525764248,
'volume_asset': 674153.2032810001,
'trade_count': 129}, ...]
market_depth
Liquidity information
Dictionary from 0.1% to 10% market depth. Base asset aggregation only.
blockchain
Token information
Blockchain name.
ethereum
token_address
Token information
Token address.
0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
number_of_holders
Token information
Total amount of holders.
1622286
main_holders
Token information
List of addesses holding at least 1% of the total supply and the amounts of tokens.
[{'address': '0x0a59649758aa4d66e25f08dd01271e891fe52199',
'amount': 3262712000,
'percentage': 7.91745}, ...]
total_supply
Token information
Blockchain total supply.
0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
This endpoint is in Alpha. Changes to the format or data constraints might change without prior notice.
The Custom Valuation endpoint allows you to build completely customizable single-asset or multi-asset price feeds for NAV calculations, portfolio valuation, asset allocation strategies, and indices.
bases
Yes
quote
Yes
The fiat pricing currency.
percentages
Yes
List of percentages for outlier management.
Min: 1
Max: 5
To not enforce any outlier management, use 1
semi_length_window
Yes
The time interval to compute the transaction.
weights
Yes
Weighting list of base assets.
The order and length of bases
and their respective weights
must match in the request.
Weights must sum up to 1.
For single-asset price feeds use an asset weighting of 1
continuation_token
No
end_time
No
Last fixing of the calculation in ISO 8601 (exclusive).
exchanges
No
interval
No
Frequency in time unit after the first fixing.
Must be greater than twice the semi_length_window
Default: 1d
.
start_time
No
First fixing of the calculation in ISO 8601 (inclusive).
sources
No
boolean
. If true
, returns all prices and volumes which were used to calculate valuation price.
Default: false
timestamp
Timestamp at which the interval begins.
percentage
Percent of the price distribution centered around the median price.
price
The composite price, with a base of 100.
pair
The constituent pair.
contribution
The asset contribution to the composite price.
ref_price
The reference price per asset.
weight
The weight per asset.
List of exchanges' code
to exclude in the calculation.
Automatically included in continuation tokens.
The desired exchange code
.
See
See
Minimum: 1
Maximum: 100
The desired asset code
.
See
See
Minimum: 1
Maximum: 100
Information from this endpoint can be accessed through Google BigQuery. To get started, read our .
List of portfolio base components.
Min: 1
Max: 5
See
The order and length of bases
and their respective weights
must match in the request.
See
Each response will only contain maximum 7 days of data.
To get more data, the continuation_token
should be used.
List of exchanges to source data from. See Default: All exchanges
Blockchain Monitoring can also be accessed through Google BigQuery. See for more information.
Blockchain Monitoring can also be accessed through Google BigQuery. To get started, read our .
This endpoint retrieves a list of our Single-Asset Rates. You can learn more about Kaiko Benchmarks .
This endpoint returns our historical values for our Reference Rates. To subscribe to the live rate, please use . More information on the rates and its methodology can be found .
blockchain
Always bitcoin
.
bitcoin
sort
The sorting order for the results.
asc
or desc
page_size
Number of results to return data for. (max: 5000).
See Pagination
100
start_block
Starting block height (inclusive).
600000
end_block
Ending block height (inclusive).
700000
start_time
Starting time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
end_time
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
transaction_hash
The specific transaction hash to query.
f6932e70e4c5483d7b1fa2ee7c56ad89207221bbf186ad0a15cd0cc4e18906f5
chain
Blockchain name.
bitcoin
block_number
The height of the block.
395211
timestamp
The timestamp of the block.
1453853136
transaction_hash
Transaction hash.
94ad60ff0ef4cd0f31cab884adc6c39720273e9468ac0019a339911f0dd26e76
transaction_id
Transaction ID.
f6932e70e4c5483d7b1fa2ee7c56ad89207221bbf186ad0a15cd0cc4e18906f5
transaction_index
The index of the transaction.
0
sender_addresses
The addresses that sends the coin.
[1A8MMLhpGEyNqEsqzkReXtmBx9LBQgt8Mh]
receiver_addresses
The addresses that receives the coin.
[19Ntq9wC9i39284EZVVf4R7DbCz7gThxzs,12eKGe5hLdKBe8mQ7dv8NixEcX96XHBkoZ]
token_symbol
Symbol of the coin transfered
BTC
amount_out
Amount of asset transfered.
10.12592654
fees
Fees paid for the transaction.
0.0004
amount_out_usd
Amount of asset transferred in usd.
3965.771819253574
fees_usd
Fees paid for the transaction in usd.
0.15665813112855445
blockchain
Always bitcoin
.
bitcoin
sort
The sorting order for the results.
asc
or desc
page_size
Number of results to return data for. (max: 5000).
See Pagination
100
start_time
Starting time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
end_time
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
transaction_hash
The transaction hash to filter on.
5ae688ab08139338e3024e150339ffa94c9d2ba23f38d0838025a41dc2fac3e6
user_address
The address to filter on.
bc1qm8ktha9m745u2gh54kprk72eu9t6n5xa2adckn
blockchain
Blockchain name.
bitcoin
block_number
The height of the block.
871899
timestamp
The timestamp of the block.
1732536300000000000
address
The address on which the row is focused.
bc1qhyar38j6catjs8y30naptzrs8jhgudhzcv8s98
transaction_hash
Transaction hash.
e84b146c3f26545b525772a38425513f36a1738bfbb49a474aefe14a8c6d7903
transaction_id
Transaction ID.
334480d40ca84435bf440da99e9454cca25d06163996cd9a6ba4b517b9da1608
transaction_type
Transaction type. See information below.
witness_v0_keyhash
transaction_index
The index of the transaction.
4695
internal_transaction_index
1
token_symbol
Symbol of the token or coin transfered
BTC
direction
Inflow or outflow from the user_address.
out
amount
Amount of asset transfered.
0.0022931
amount_usd
Amount of asset transferred in usd.
225.6601111753002
balance_after
Wallet balance for the user_address for this asset.
0
balance_after_usd
Wallet balance for the user_address for this asset in usd.
0
minerReward
multisig
pubkey
pubkeyhash
scripthash
witness_unknown
witness_v0_keyhash
witness_v0_scripthash
witness_v1_taproot
nulldata
nonstandard
blockchain
Always ethereum
.
ethereum
sort
The sorting order for the results.
asc
or desc
page_size
Number of results to return data for. (max: 5000).
See Pagination
100
start_time
Starting time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
end_time
Ending time in ISO 8601 (inclusive).
2022-05-01T00:00:00.000Z
transaction_hash
The transaction hash to filter on.
0xf7825247b9a9355c0fb45ec0d008fe638ce5bae9cb877c6a28a91d9ea5f17341
user_address
The address to filter on.
0x000000fee13a103a10d593b9ae06b3e05f2e7e1c
token_address
The token address to filter on.
0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
chain
Blockchain name.
ethereum
block_number
The height of the block.
7005997
timestamp
The timestamp of the block.
1546560004
user_address
The address on which the row is focused.
0xc8c939539efb7f5ba903fc99b61656979c46c045
transaction_hash
Transaction hash.
0x5a9e11432e5c7e2fccf598606858619cbd72f1de40db625fc4749ec1b032e144
transaction_type
Event type. See more information below.
gas_buy
transaction_index
The index of the transaction.
0
ordinal
Generated number that gives the order of each balance impact, for one file. Based on call index and log indexes.
2
sender_address
The address that sends tokens or coins.
0xc8c939539efb7f5ba903fc99b61656979c46c045
receiver_address
The address that receives tokens or coins.
0x5a0b54d5dc17e0aadc383d2db43b0a0d3e029c4c
initiator_address
The address that signed the transaction.
0xc8c939539efb7f5ba903fc99b61656979c46c045
token_symbol
Symbol of the token or coin transfered
ETH
token_address
The address of the token or coin transfered.
0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
direction
Inflow or outflow from the user_address.
out
amount
Amount of asset transfered.
0.16
amount_usd
Amount of asset transferred in usd.
23.863262042004745
balance_after
Wallet balance for the user_address for this asset.
0.4814735188
balance_after_usd
Wallet balance for the user_address for this asset in usd.
71.80955465881561
reward_mine_uncle
Uncle block rewards are awarded to miners who generate an uncle block that gets included in a valid block added to the chain. These uncle blocks are analogous to stale blocks in Bitcoin. However, rather than being disregarded, uncle blocks receive rewards dependent on their novelty.
reward_mine_block
Rewards granted to the miner who mines the current block.
dao_refund_contract
This is related to the execution of the DAO hard-fork, an event that occurred as a response to the notorious DAO hack in 2016. This hard-fork moved all the Ether initially stored in The DAO (and its child DAOs) to a refund contract. From this contract, original DAO token holders could claim their proportional share of the funds.
dao_adjust_balance
Refers to any adjustment made to an account’s balance in relation to DAO-related hard-fork or operations.
coin_transfer
A coin transfer operation.
genesis_balance
Refers to the balance attributed to addresses during the genesis block.
gas_buy
The amount of gas purchased by the initiator to execute the transaction.
reward_transaction_fee
Reward earned by the miner for including the transaction in the block.
reward_fee_reset
gas_refund
The process of refunding gas to the initiator when the state store is cleared.
touch_account
Refers to the process of interacting with an account in some way, such as updating its nonce.
suicide_refund
The process of refunding gas to a contract owner when the SELFDESTRUCT operation is called, as it clears the store.
suicide_withdraw
This action allows the withdrawal of the remaining coin (ex: ETH) in a self-destructed account to a specific address.
call_balance_override
This operation overrides the default balance of an account.
burn
Burning coins in chains where this process occurs.
withdrawal
Allows the withdrawal of rewards or stake for validators.
token_transfer
This operation involves the transfer of (ERC20) tokens.
wrap_coin
This operation mints WETH tokens after a coin (ex: ETH) deposit.
unwrap_coin
This operation burns WETH tokens before a coin (ex: ETH) withdrawal.
token_deposit
This operation allows the deposit of (ERC20) tokens into staking contracts or escrow.
token_withdrawal
This operation allows the withdrawal of (ERC20) tokens from the staking contracts or escrow.
unknown
Unknown balance_change reason, only happens for the chain’s coin.
ticker
The ticker of the rate.
long_name
Extensive name format of the rate issued
short_name
Short name format of the rate issued
type
Category to which the rate belongs . i.e . Reference Rate
or Benchmark Reference Rate
dissemination
Frequency of publication of the rate
quote
Long and short name of the quote asset
base
Long and short name of the base asset
pair
Asset pair represented by the rate.
launch_date
Date when the rate was launched and entered into production.
inception_date
Earliest effective date of historical data for a rate.
brand
Qualifies if the rate is issued from a partnership or from Kaiko standard offer.
isin
The ISIN code of the rate
exposition
"Public"
: Indicates that it is open reference data accessible to all users.
index_code
Yes
The desired rate ticker
KK_BRR_BTCUSD
start_time
Yes
Starting time in ISO 8601 (inclusive).
2023-01-25T00:00:00.000Z
end_time
Yes
Ending time in ISO 8601 (exclusive).
2023-01-26T00:00:00.000Z
parameters
No
boolean. If true, returns the underlying composition data of the rate such as exchanges and calculation window
Default: false
detail
No
boolean. If true, returns the underlying partition data for each publication
Default: false
page_size
No
(min: 1, default: 100, max: 100000). See Pagination
Automatically included in continuation tokens.
continuation_token
No
See Pagination
interval_start
Starting timestamp of calculation window
2023-01-25T01:01:00.000Z
interval_end
Ending timestamp of calculation window
2023-01-25T01:02:00.000Z
price
Price of the reference rate at interval_end
67685.61363636363
parameters
Underlying composition data of the rate such as exchanges and calculation window
'asset': 'btc',
'exchanges': ['cbse', 'gmni', 'krkn', 'lmax', 'stmp'],
'calc_window': 300
detail
Underlying partition data for each publication including price, volume, trade count and underlying data of the trade selected from the partition.
'partition': 0,
'price': 67678,
'volume': 5.14445852,
'count': 125,
'underlying_trade': {'datetime': '2024-10-27T15:55:17.334Z',
'exchange': 'stmp',
'volume': 0.20137745,
'id': '366038625'}
CME Group publishes fixing prices, typically calculated based on the volume-weighted average price (VWAP) of contracts traded during a pre-defined window of time. These price references are used to determine the exercise and assignment of options positions at expiration and serve as an informational reference point for market participants. Fixing prices also can play an important role in determination of price limits during rapidly moving markets.
For the fixing prices of cryptocurrencies, Bitcoin fixing price will be based on a notionally adjusted volume-weighted average traded price of Bitcoin futures and Micro Bitcoin futures during the 30 minutes prior to 4:00 p.m. London time. For Ethereum fixing price, it will be based on Ether futures and Micro Ether futures.
No parameters supported
trade_date
Reference date of the Fixing Prices
timestamp
Event timestamp
product_code
Product code
instrument
Instrument code
description
Description of the instrument
fixing_price
Fixing price published by CME
This REST API endpoint provides several CME CF Reference Rates, including Bitcoin, Ethereum and others, which are published once a day. These benchmark index prices aggregate trade data from multiple USD markets operated by major cryptocurrency exchanges that conform to the CME CF Constituent Exchange Criteria.
No parameters supported
ref_date
Publication date of the reference rates
instrument
Reference rates name
price
Value of the reference rates
Kaiko Reference Rates are available exclusively through our Stream Service. This helps you identify the underlying trades used to calculate each publication. Simply take the sequence_id
field from any published rate you receive via Stream, and query this endpoint. The endpoint then generates a URL to query our Tick-Level Trades endpoint where you'll see all the trades.
We support publications for up to 72 hours using this endpoint. If you require the trades for a rate published more than 72 hours ago, contact our operations team.
sequence_id
Yes
List of publication ID to explore. A publication is defined by event occurring on a specific instrument at a given point in time. Publication IDs can be retrieved from your index response.
cmrqt2dugrtbh9jbhlk0,cmt40b74tfbpmrtbk180
sort
No
If asc, sort time-series in ascending. If desc, sort time-series in descending.
asc
page_size
No
100
index_code
Ticker identifying the rate.
KK_PR_BTCUSD
index_type
Type of publication: real-time or fixings.
SIC_REAL_TIME
sequenceID
cnb0k3vvavm8ib6863qg
underlying_data
List of links to specific pre-filtered queries on the Rest API trades endpoint for the selected SequenceID.
[
"https://us.market-api.kaiko.io/v3/data/trades.v1/exchanges/bfnx/spot/btc-usd/trades?start_time=2024-02-21T14:29:55.000Z&end_time=2024-02-21T14:34:55.000Z&index_inserted_at=2024-02-21T14:34:50.863ZZ&sort=asc",
"https://us.market-api.kaiko.io/v3/data/trades.v1/exchanges/cbse/spot/btc-usd/trades?start_time=2024-02-21T14:29:55.000Z&end_time=2024-02-21T14:34:55.000Z&index_inserted_at=2024-02-21T14:34:50.863ZZ&sort=asc"]
See
Min: 1
Max: 100
Default: 10
The publication ID to explore. A publication is defined by event occurring on a specific instrument at a given point in time. Publication IDs can be retrieved from response.
The IV surface endpoint lets you calculate volatility from options market prices. Feed the endpoint a set of maturity dates or timeframes for when options can be exercised, and you'll receive a volatility surface, which shows how volatility changes over different dates and prices.
You can get volatility estimates based on:
A specific set of strike prices
A forward-log-moneyness grid
A specific set of delta values
A delta grid
The calculation methodology leverages space and time interpolation.
Currently supported assets and exchanges:
BTC, ETH, SOL, MATIC, XRP on Deribit.
BTC, ETH on OKX.
BTC, ETH on Deribit & OKX (aggregated).
If you need data from other exchanges, we can add them on request.
region
Yes
Choose between eu
and us
.
Short listed-maturities (e.g. 7 days time-to-maturity) are only available for individual exchange.
Time extrapolation is not permitted. I.e. the shortest requested expiry should be after the exchange’s shortest expiry, and the furthest requested expiry must be before the exchange’s latest expiry. If these conditions are not met, only a partial surface will be returned within the available expiry range. The completeness of the output is indicated in the complete_output
field.
Strikes and forward-log-moneynesses are only available when retrieving implied volatilities by strikes or forward-log-moneynesses (not by delta).
base
Yes
The desired base as the underlying of the options. See asset support above.
btc
, eth
quote
Yes
The desired quote as the underlying of the options. See asset support above.
usd
exchanges
Yes
The desired exchange as source of options data. See exchange support above.
drbt
value_time
Yes
The time at which to compute implied volatilities The time t should be smaller than the lowest requested expiry.
2022-06-25T16:00:00.000Z
expiry_list
Yes, if the set of parameters (tte_min
, tte_max
, tte_step
) is not used.
The expiries for which the implied volatilities are to be computed. Expiries can be listed or non-listed ones.
Expiries should be between minimum and maximum listed maturities on exchange. If not, a partial output will be returned.
Either expiry_list
or (tte_min
, tte_max
, tte_step
) should be filled.
expiry_list=2022-08-28T08:00:00.000Z, 2022-08-30T08:00:00.000Z
or tte_min=0.034288&tte_max=1&tte_step=0.02
tte_min
Yes, if expiry_list
is not used. To be used along with tte_max
, tte_step
.
Minimum time-to-expiry on the time grid.
Strictly positive value allowed.
If the `tte_min` is below the time to expiry associated with the minimum listed maturity, partial output will be returned.
Either expiry_list
or (tte_min
, tte_max
, tte_step
) should be filled.
0.034288
tte_max
Yes, if expiry_list
is not used. To be used along with tte_min
, tte_step
.
Maximum time-to-expiry on the time grid.
Strictly positive value above the `tte_min`.
If the `tte_max` is above the time to expiry associated with the maximum listed maturity, partial output will be returned.
Either expiry_list
or (tte_min, tte_max,tte_step)
should be filled.
1
tte_step
Yes, if expiry_list
is not used. To be used along with tte_min
, tte_max
.
Step between two time-to-expiries in time grid.
Strictly positive value allowed.
Either expiry_list
or (tte_min, tte_max, tte_step)
should be filled.
0.02
strike_list
Yes, if the set of parameters (f_log_min
, f_log_max
, f_log_step
) or deltas
or the set of parameters (delta_min
, delta_max
, delta_step
) are not used.
The strike prices for which the implied volatilities are to be computed. Strike prices can be listed or non-listed ones.
Strictly positives values allowed.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
strike_list=25000, 29150, 29155, 29160
or f_log_m_min=-1.5&f_log_m_max=1.5&f_log_m_step=0.05
f_log_m_min
Yes, if strike_list
or deltas
or the set of parameters (delta_min
, delta_max
, delta_step
) are not used.
To be used along with f_log_m_max
, f_log_m_step
.
Minimum forward log-moneyness on the space grid.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
-1.5
f_log_m_max
Yes, if strike_list
or deltas
or the set of parameters (delta_min
, delta_max
, delta_step
) are not used.
To be used along with f_log_m_min
, f_log_m_step
.
Maximum forward log-moneyness on the space grid.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
1
f_log_m_step
Yes, if strike_list
or deltas
or the set of parameters (delta_min
, delta_max
, delta_step
) are not used.
To be used along with f_log_m_min
, f_log_m_max
.
Step between two forward log moneyness in space grid.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
0.02
deltas
Yes, if strike_list
or the sets of parameters (delta_min, delta_max, delta_step)
or (f_log_m_min
, f_log_m_max
, f_log_m_step
) are not used.
The delta levels (of a Call option) for which the implied volatilities are to be computed.
Only delta values between 0.01
and 0.99
are allowed.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
deltas=0.25,0.5,0.75
delta_min
Yes, if strike_list
or deltas
or the set of parameters (f_log_m_min
, f_log_m_max
, f_log_m_step
) are not used. To be used along with delta_max
, delta_step
.
Minimum delta (of a Call option) on the space grid.
Only delta values between 0.01
and 0.99
are allowed.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
0.01
delta_max
Yes, if strike_list
or deltas
or the set of parameters (f_log_m_min
, f_log_m_max
, f_log_m_step
) are not used. To be used along with delta_min
, delta_step
.
Maximum delta (of a Call option) on the space grid.
Only delta values between 0.01
and 0.99
are allowed.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
0.99
delta_step
Yes, if strike_list
or deltas
or the set of parameters (f_log_m_min
, f_log_m_max
, f_log_m_step
) are not used. To be used along with delta_min
, delta_max
.
Step between two deltas (of a Call option) on the space grid.
Either strike_list
, (f_log_m_min
, f_log_m_max
, f_log_m_step
), deltas
or
(delta_min
, delta_max
, delta_step
) should be filled.
complete_output
This indicates whether the output covers the entire requested range within the listed expiries, or only the valid subset.
True
value_time
The time in parameter
2022-06-25T16:00:00Z
expiry
The expiry at which the IV has been interpolated.
2022-08-28T08:00:00Z
time_to_expiry
The associated time-to-expiry (in year).
0.17442922374429223
strike
The strike at which the IV has been computed. Not provided when the input is a delta list.
265.88827409960714
forward_log_moneyness
The associated forward log-moneyness. Not provided when the input is a delta list.
-1.5
implied_volatility
The calibrated and interpolated implied volatilities.
1.8088997727784055
delta
The first derivative of the price (of a Call option) with regards to the underlying price
-0.009058250602524742
gamma
The second derivative of the price with regards to the underlying price
0.000027152549142705487
interest_rate
The implied interest rate.
0.14954983972466698
current_spot
The underlying spot price at the value timestamp.
71717
Use this example to calculate IV Surface using Deltas.
Use this example to calculate IV Surface using forward log moneyness.
Use this example to calculate IV Surface using strikes.
"Snapshots" show a point-in-time view generated every 30 seconds, whereas "aggregations" show an aggregation of all 30-second snapshots from the period requested.
"Snapshots" show a point-in-time view generated every 30 seconds, whereas "aggregations" show an aggregation of all 30-second snapshots from the period requested.
"Snapshots" show a point-in-time view generated every 30 seconds, whereas "aggregations" show an aggregation of all 30-second snapshots from the period requested.
"Snapshots" show a point-in-time view generated every 30 seconds, whereas "aggregations" show an aggregation of all 30-second snapshots from the period requested.
Fair Market Value Pricing can also be accessed via on-chain delivery to power any smart contract. Learn how to set it up .