v1

latestOpenAPI 3.0.02026-07-2224101.3 MB
BTC Market Data

Open Interest

This endpoint returns BTC Perpetual Open Interest from derivative exchanges. Supported exchanges for Open Interest are below. Note we unify the unit of return value to USD for each exchange where its contract specification may vary.

NameExchangeSymbolAvailable Since
All Exchangesall_exchangeall_symbolThe earliest time in the exchanges below.
Binancebinanceall_symbol <br/> btc_busd <br/> btc_usd <br/> btc_usdtThe earliest time in the symbols. <br/> 2021-01-12 00:00:00 <br/> 2020-08-11 00:00:00 <br/> 2020-03-13 02:13:00
Bitfinexbitfinexall_symbol <br/> btc_usdtThe earliest time in the symbols. <br/> 2020-06-01 00:00:00
Bitmexbitmexall_symbol <br/> btc_usdThe earliest time in the symbols. <br/> 2019-03-30 00:00:00
Bybitbybitall_symbol <br/> btc_usd <br/> btc_usdtThe earliest time in the symbols. <br/> 2019-11-07 00:00:00 <br/> 2020-05-28 00:00:00
Deribitderibitall_symbol <br/> btc_usdThe earliest time in the symbols. <br/> 2019-03-30 00:00:00
FTX**ftxall_symbol <br/> btc_usdThe earliest time in the symbols. <br/> 2020-05-13 00:00:00
Gate.iogate_ioall_symbol <br/> btc_usd <br/> btc_usdtThe earliest time in the symbols. <br/> 2020-07-01 00:00:00 <br/> 2020-07-01 00:00:00
HTX Globalhtx_globalall_symbol <br/> btc_usd <br/> btc_usdtThe earliest time in the symbols. <br/> 2020-06-23 00:00:00 <br/> 2021-08-26 04:00:00
Krakenkrakenall_symbol <br/> btc_usdThe earliest time in the symbols. <br/> 2019-03-30 00:00:00
OKXokxall_symbol <br/> btc_usd <br/> btc_usdtThe earliest time in the symbols. <br/> 2019-09-05 23:59:00 <br/> 2020-01-01 00:00:00

(**) Use in cautions due to the deprecation (no data update)

📖 Data Guide: Open Interest — definition, interpretation, and chart examples.

get/btc/market-data/open-interest

Query parameters

exchangestring required

A derivative exchange from the table that we support. See here.

windowstring

Currently we support day, hour, and min.

fromstring

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

tostring

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

limitinteger

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

formatstring

A format type about return message type. Supported formats are json, csv.

Response

Open Interest in USD