> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptoquant.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Open Interest
> This endpoint returns XRP Perpetual Open Interest from derivative exchanges.
| Name | Exchange | Symbol |
|----------------|--------------|----|
| All Exchanges | `all_exchange` | `all_symbol`* |
| Binance | `binance` | `xrp_usdt`
`xrp_usd`
`all_symbol`*|
| Bybit | `bybit` | `xrp_usdt`
`xrp_usd`
`all_symbol`*|
| Bitmex | `bitmex` | `xrp_usd`* |
| HTX Global | `htx_global` | `xrp_usdt`* |
| Kraken | `kraken` | `xrp_usd`* |
| OKX | `okx` | `xrp_usdt`
`xrp_usd`
`all_symbol`* |
| Bitfinex | `bitfinex` | `xrp_usdt`* |
Supported exchanges for Open Interest are available in Discovery section.
Note we unify the unit of return value to USD for each exchange where its contract specification may vary.
**📖 Data Guide:** [Open Interest](/data-guide/market/open-interest) — definition, interpretation, and chart examples.
## OpenAPI
````yaml /openapi/v1.json get /xrp/market-data/open-interest
openapi: 3.0.0
info:
version: 1.3.0
title: CryptoQuant Data API
termsOfService: https://cryptoquant.com/terms-of-service
contact:
name: API Support
email: contact@cryptoquant.com
description: >-
The CryptoQuant Data API provides simple and powerful endpoints to get
information on general transaction data and aggregate on-chain statistics
straight from the blockchain. The API root endpoint URL is
`https://api.cryptoquant.com/v1/`.
servers:
- url: https://api.cryptoquant.com/v1
description: Default server
security: []
tags:
- name: Available Endpoints
description: Discover all available endpoints
- name: Supported Stablecoin List
description: "| Name | Token | Supported Categories | Contract Created Datetime (Block, Datetime) | Deprecated |\n|-----------------------|----------------|-----------------------|---------------------------------------------|------------|\n| All Tokens | `all_token` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data | The earliest time in the tokens below. |\n| Tether USD(Eth) | `usdt_eth` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 4638757, 2017-11-28 16:24:26 |\n| Tether USD(Trx) | `usdt_trx` | - Entity Status
- Exchange Flow
- Network Data
- Market Data | 4638757, 2017-11-28 16:24:26 |\n| Paxos Dollar | `usdp` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 6306166, 2018-09-10 13:03:56 |\n| USD Coin | `usdc` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 6307510, 2018-09-10 18:26:41 |\n| True USD | `tusd` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 5198636, 2018-03-05 03:30:14 |\n| Dai | `dai` | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 8928674, 2019-11-13 21:22:33 |\n| Binance USD | `busd` | - Entity Status
- Exchange Flow
- Market Data | 8493105, 2019-09-05 23:56:17 |\n| Gemini dollar | `gusd` | - Entity Status
- Exchange Flow | 6301780, 2018-09-09 19:36:14 |\n| sUSD | `susd` | - Entity Status
- Exchange Flow | 5751012, 2018-06-08 02:48:10 |\n| ~Tether USD(Omni)~ | ~`usdt_omni`~ | - Network Data
- Market Data | 325157,\t2014-10-13 14:27:52 | 2025-08-28 |\n| ~Sai (Old Dai)~ | ~`sai`~ | - Entity Status
- Exchange Flow
- Flow Indicator
- Network Data
- Market Data | 4755950, 2017-12-18 19:22:10 | 2025-08-28 |\n| ~HTX USD~ | ~`husd`~ | - Entity Status
- Exchange Flow | 8174400, 2019-07-18 11:30:44 | 2025-08-28 |\n| ~USDK~ | ~`usdk`~ | - Entity Status
- Exchange Flow | 7769943, 2019-06-16 07:21:40 | 2025-08-28 |\n| ~TerraUSD~ | ~`ust`~ | - Market Data | | 2025-08-28 |\n\nUntil now, `all_token` is available in Exchange Flow, Network Data, Flow Indicator.
\nSupported tokens for `all_token` varies with categories.
\nExchange Flow: `usdt_eth`, `usdt_trx`, `usdp`, `usdc`, `tusd`, `dai`, `busd`, `gusd`, `susd`
\nNetwork Data: `usdt_eth`, `usdt_trx`, `usdp`, `usdc`, `tusd`, `dai`
\nDeprecated: `usdt_omni`, `sai`, `husd`, `usdk`, `ust`"
- name: Supported ERC20 List
description: >-
| Name | Token | Supported
Categories | Contract Created Datetime
(Block, Datetime)|
|---------------------|----------------|---------------------------------------------------------|------------------------------|
| Chainlink | `link` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4281611, 2017-09-16 21:26:29 |
| Uniswap | `uni` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10861674, 2020-09-14 18:11:26 |
| Sushiswap | `sushi` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10736094, 2020-08-26 12:28:07 |
| Aave | `aave` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10926829, 2020-09-24 18:06:28 |
| Maker | `mkr` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4620855, 2017-11-25 18:24:17 |
| OmiseGO | `omg` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
3978297, 2017-07-05 02:18:58 |
| Uma | `uma` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
9247089, 2020-01-09 14:44:21 |
| Compound | `comp` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
9601359, 2020-03-04 00:08:55 |
| Basic Attention Token | `bat` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
3788558, 2017-05-29 18:45:10 |
| Synthetix | `snx` | - Entity Status
- Exchange
Flow
- Market Data | 5750875, 2018-06-08 02:14:23 |
| Yearn.finance | `yfi` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10475744, 2020-07-17 08:01:25 |
| Decentraland | `mana` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4162059, 2017-08-15 19:18:09 |
| The Sandbox | `sand` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
8835135, 2019-10-29 16:48:43 |
| Axie Infinity | `axs` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12314534, 2021-04-26 07:16:09 |
| Smooth Love Potion | `slp` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12314545, 2021-04-26 07:18:32 |
| Gala | `gala` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10828939, 2020-09-09 17:32:51 |
| Enjin Coin | `enj` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4329040, 2017-10-02 01:02:07 |
| Yield Guild Games | `ygg` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12901564, 2021-07-26 11:30:17 |
| Illuvium | `ilv` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12084124, 2021-03-21 19:43:46 |
| Adventure Gold | `agld` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
13142655, 2021-09-01 23:09:32 |
| Chiliz | `chz` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
6585593, 2021-10-26 07:00:45 |
| Mines of Dalarnia | `dar` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
13454131, 2021-10-20 10:38:06 |
| Aavegotchi | `ghst` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10852634, 2020-09-13 08:48:20 |
| MyNeighborAlice | `alice` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11958870, 2021-03-02 12:43:37 |
| Ethereum Name Service | `ens` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
13533418, 2021-11-01 20:55:17 |
| Dego Finance | `dego` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10835762, 2020-09-10 18:51:00 |
| Origin Protocol | `ogn` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
6436154, 2018-10-01 23:06:11 |
| Ethernity Chain | `ern` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11749003, 2021-01-29 05:48:45 |
| SHIBA INU | `shib` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10569013, 2020-07-31 18:32:43 |
| Storj | `storj` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
3898942, 2017-06-19 16:16:35 |
| Bluzelle | `blz` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4911588, 2018-01-15 08:19:33 |
| Holo | `hot` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
5008746, 2018-02-01 01:21:09 |
| Alchemix | `alcx` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11937199, 2021-02-27 04:28:02 |
| FTX Token | `ftt` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
7611221, 2019-04-21 13:21:27 |
| Curve DAO Token | `crv` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10647806, 2020-08-12 22:17:28 |
| Bancor | `bnt` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
3851136, 2017-06-10 16:02:40 |
| 0x | `zrx` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4145415, 2017-08-11 18:39:16 |
| 1inch Network | `1inch` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11511393, 2020-12-23 18:13:31 |
| Kyber Network Crystal v2 | `knc` | - Entity Status
- Exchange
Flow
- Network Data
- Market Data | 12224343, 2021-04-12
09:04:54 |
| dYdX | `dydx` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12809555, 2021-07-12 01:37:12 |
| DODO | `dodo` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10956992, 2020-09-29 10:58:50 |
| LoopringCoin V2 | `lrc` | - Network Data
- Market Data
| 7544036, 2019-04-11 02:10:37 |
| Ankr | `ankr` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
7246755, 2019-02-21 00:57:45 |
| Polygon | `matic` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
7605604, 2019-04-20 16:34:12 |
| Amp | `amp` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10635417, 2020-08-11 00:27:19 |
| SKALE Network | `skl` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10363171, 2020-06-29 21:44:26 |
| Balancer | `bal` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
10299683, 2020-06-20 01:32:59 |
| Polymath | `poly` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
4994844, 2018-01-29 16:34:21 |
| Fetch.ai | `fet` | - Entity Status
- Exchange
Flow
- Market Data | 10998076, 2020-10-05 21:06:18 |
| The Graph | `grt` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11446769, 2020-12-13 20:17:13 |
| Ocean Protocol | `ocean` | - Entity Status
- Exchange
Flow
- Network Data
- Market Data | 10945544, 2020-09-27
15:54:07 |
| Numeraire | `nmr` | - Entity Status
- Exchange
Flow
- Market Data | 3902326, 2017-06-20 08:10:37 |
| Mask Network | `mask` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
11886238, 2021-02-19 08:26:41 |
| JasmyCoin | `jasmy` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
9164378, 2019-12-26 05:59:52 |
| Gitcoin | `gtc` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12422079, 2021-05-12 21:48:02 |
| Keep Network | `keep` | - Entity Status
- Network
Data
- Market Data | 9958363, 2020-04-28 02:52:46 |
| Quant | `qnt` | - Entity Status
- Exchange
Flow
- Market Data | 5392950, 2018-04-06 19:52:41 |
| Voyager Token | `vgx` | - Entity Status
- Exchange
Flow
- Flow Indicator
- Network Data
- Market Data |
12916697, 2021-07-28 21:11:47 |
| ParaSwap | `psp` | - Network
Data | 13619386, 2021-11-15 08:58:18 |
| Immutable X | `imx` | - Network
Data | 13415141, 2021-10-14 07:59:20 |
| Highstreet Token | `high` | - Network
Data | 13395328, 2021-10-11 05:00:48 |
| Radio Caca V2 | `raca` | - Network
Data | 13369114, 2021-10-07 02:16:48 |
| Temple DAO | `temple` | - Network
Data | 13321581, 2021-09-29 15:52:47 |
| Gods Unchained | `gods` | - Network
Data | 12955434, 2021-08-04 12:08:03 |
| Ribbon Finance | `rbn` | - Network
Data | 12497174, 2021-05-24 13:12:02 |
| dHedge DAO Token | `dht` | - Network
Data | 10833180, 2020-09-10 09:35:31 |
| Cream Finance | `cream` | - Network
Data | 10594024, 2020-08-04 15:06:57 |
| Meta | `mta` | - Network
Data | 10450640, 2020-07-13 10:23:56 |
| Alchemy | `ach` | - Network
Data | 8482162, 2019-09-04 07:00:52 |
| PlayDapp Token | `pla` | - Network
Data | 9921528, 2020-04-22 09:40:15 |
| Efinity Token | `efi` | - Network
Data | 12349290, 2021-05-01 04:06:34 |
| Prometeus Network | `prom` | - Network
Data | 7789253, 2019-05-19 07:49:05 |
| Armor | `armor` | - Network
Data | 11707709, 2021-07-22 21:23:49 |
| Popsicle Finance | `ice` | - Network
Data | 12121350, 2021-03-27 13:30:15 |
| Liquity: LQTY Token | `lqty` | - Network
Data | 12178618, 2021-04-05 08:33:10 |
| Human Token | `hmt` | - Network
Data | 12184475, 2021-04-06 06:22:26 |
| Wrapped BTC | `wbtc` | - Network
Data | 6766284, 2018-11-24 21:45:52 |
| GateChain Token | `gt` | - Network
Data | 7726894, 2019-05-09 14:20:19 |
| Crypto.com Coin | `cro` | - Network
Data | 6702068, 2018-11-14 09:11:48 |
| OKB Token | `okb` | - Network
Data | 7641712, 2019-04-26 07:47:59 |
| 0x (ZRX) | `zrx` | - Network
Data | 4145415, 2017-08-11 18:39:16 |
| Gnosis | `gno` | - Network
Data | 3557596, 2017-04-18 13:45:16 |
| Covalent Query Token| `cqt` | - Network
Data | 12474448, 2021-05-21 12:15:53 |
| Request | `req` | - Network
Data | 4345153, 2017-10-07 15:47:37 |
| Kucoin Token | `kcs` | - Network
Data | 11638804, 2021-01-12 07:29:47 |
| Olympus | `ohm` | - Network
Data | 12084967, 2021-03-21 22:48:40 |
| HTX Token | `ht` | - Network
Data | 5005233, 2018-01-31 10:50:02 |
- name: Supported Alt List
description: >-
| Name | Token | Supported
Categories |
|---------------------|----------------|------------------------------------|
| Cardano | `ada` | - Market
Data |
| Algorand | `algo` | - Market
Data |
| Arweave | `ar` | - Market
Data |
| Cosmos | `atom` | - Market
Data |
| Auto | `auto` | - Market
Data |
| Avalanche | `avax` | - Market
Data |
| BNB | `bnb` | - Market
Data |
| PancakeSwap | `cake` | - Market
Data |
| Celo | `celo` | - Market
Data |
| Dash | `dash` | - Market
Data |
| Decred | `dcr` | - Market
Data |
| Dogecoin | `doge` | - Market
Data |
| Polkadot | `dot` | - Market
Data |
| Elrond | `egld` | - Market
Data |
| Ethereum Classic | `etc` | - Market
Data |
| Filecoin | `fil` | - Market
Data |
| Flow | `flow` | - Market
Data |
| Fantom | `ftm` | - Market
Data |
| Hedera | `hbar` | - Market
Data |
| Helium | `hnt` | - Market
Data |
| Internet Computer | `icp` | - Market
Data |
| IOTA | `iota` | - Market
Data |
| IoTeX | `iotx` | - Market
Data |
| Kusama | `ksm` | - Market
Data |
| Terra | `luna` | - Market
Data |
| Mina | `mina` | - Market
Data |
| NEAR Protocol | `near` | - Market
Data |
| Neo | `neo` | - Market
Data |
| Harmony | `one` | - Market
Data |
| Qtum | `qtum` | - Market
Data |
| Oasis Network | `rose` | - Market
Data |
| THORChain | `rune` | - Market
Data |
| Ravencoin | `rvn` | - Market
Data |
| Solana | `sol` | - Market
Data |
| Stacks | `stx` | - Market
Data |
| Theta Fuel | `tfuel` | - Market
Data |
| Theta Nwetwork | `theta` | - Market
Data |
| TRON | `trx` | - Market
Data |
| VeChain | `vet` | - Market
Data |
| Waves | `waves` | - Market
Data |
| WAX | `waxp` | - Market
Data |
| eCash | `xec` | - Market
Data |
| NEM | `xem` | - Market
Data |
| Stellar | `xlm` | - Market
Data |
| Monero | `xmr` | - Market
Data |
| Tezos | `xtz` | - Market
Data |
| Zcash | `zec` | - Market
Data |
- name: BTC Entity Status
description: Entity List of Bitcoin API with Status
- name: BTC Network Data
description: >-
Bitcoin on-chain network data including but not limited to token
movements, fees, supply, address movements, etc. All metrics have data
entries starting from the genesis block (block height 0, datetime
2009-01-03 18:15:05).
- name: BTC Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to the value
of Bitcoin, including price, open interest, market cap, realized cap, etc.
On top of providing basic market data like price and market cap, we focus
on onchain indicators in order to evaluate the true value of Bitcoin.
These indicators have been commonly used in building long term valuations,
and identifying lows and highs. For more detailed information, please
refer to the description of each metric.
- name: BTC Fund Data
description: >-
This namespace cointains endpoints to retreive metrics related to
regulated funds such as trust, including market price, market volume,
market premium, and digital asset holdings. These metrics are useful to
measure sentiments of investors such as institutions in regulated market.
All Symbol will be updated no later then UTC 12:00, this may be changed
depending on update time of source data. Also the return value may be
changed because of late updated fund.
### Supported Symbols
| Name | Symbol | Status
| Source |
|---------------------------------------
|-------------|-------------|-----------------------|
| All Symbol (BTC) | `all_symbol`| Validated
| All Fund |
| Grayscale Bitcoin Trust (GBTC) | `gbtc` | Validated
| Grayscale Investments |
| Grayscale Bitcoin Mini Trust (BTC) | `btc` | Validated
| Grayscale Investments |
| iShares Bitcoin Trust ETF (IBIT) | `ibit` | Validated
| BlackRock |
| Fidelity Bitcoin Fund ETF (FBTC) | `fbtc` | Validated
| Fidelity |
| Bitwise Bitcoin ETF (BITB) | `bitb` | Validated
| Bitwise |
| ARK 21Shares Bitcoin ETF (ARKB) | `arkb` | Validated
| ARK Investment / 21Shares |
| Invesco Galaxy Bitcoin ETF (BTCO) | `btco` | Validated
| Invesco |
| VanEck Bitcoin Trust (HODL) | `hodl` | Validated
| VanEck |
| Franklin Bitcoin ETF (EZBC) | `ezbc` | Validated
| Franklin Templeton |
| WisdomTree Bitcoin Fund (BTCW) | `btcw` | Validated
| WisdomTree |
| The Coinshares Valkyrie Bitcoin Fund (BRRR) | `brrr` | Validated
| Valkyrie |
| Purpose Bitcoin ETF (BTCC.U) | `btcc_u` | Validated
| Purpose Investments |
| ETC Group Bitcoin ETF (BTCE) | `btce` | Validated
| ETC Group |
- name: BTC Exchange Flows
description: >-
This endpoint returns the flows of BTC into exchange wallets for as far
back as we track.
We constantly keep updating new exchange wallets, which means that there
can be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
Supported exchanges can be found in the `/btc/status/entity-list`
endpoint.
In addition to that, we support the following aggregated exchanges:
### Supported Aggregated Exchanges
| Name | Exchange | Status |
|----------------|--------------|-------------|
| All Exchanges | `all_exchange` | Validated |
| Spot Exchanges | `spot_exchange` | Validated |
| Derivative Exchanges | `derivative_exchange` | Validated |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: BTC Miner Flows
description: >-
This namespace contains endpoints to retrieve data related to Bitcoin
miners(i.e. mining pools and its participants). We provide metrics related
to miner reserves, inflows, outflows, hashrate, revenue, workers, etc.
We constantly keep updating new miner wallets, which means that there can
be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
Supported miners can be found in the `/btc/status/entity-list` endpoint.
In addition to that, we support the following aggregated miners:
### Supported Aggregated Miners
| Name | Miner | Status |
|----------------|--------------|-------------|
| All Miners | `all_miner` | Validated |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new miners wallets are discovered, added, and validated.
- name: BTC Inter Entity Flows
description: >-
This namespace contains endpoints to retrieve inter entity flows data
(e.g. flow between miners and exchanges). Data entries were collected from
the first transaction between two entities.
We constantly keep updating new entity wallets, which means that there can
be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new entity wallets are discovered, added, and validated.
- name: BTC Network Indicator
description: >-
This namespace contains endpoints to retrieve NVT ratio, Stock to Flow
ratio, and etc. We provide certain indicators to avoid any risks, assume
upside or downside potentials, and give insights on the value of bitcoin.
For more detailed information, please refer to the description of each
metric.
- name: BTC Market Indicator
description: >-
This namespace contains endpoints to retrieve
MVRV(Market-Value-to-Realized-Value), Estimated Leverage Ratio, and etc.
We provide certain indicators to avoid any risks, assume upside or
downside potentials, and give insights on the value of bitcoin.
We also provide USD and USDT spot price of BTC from global exchanges and
BTC index price. CryptoQuant's BTC index price is VWAP(Volume Weighted
Average Price) of aggregated price data from all exchanges we provide.
For more detailed information, please refer to the description of each
metric.
- name: BTC Mempool Statistics
description: >-
This namespace contains endpoints to retrieve statistics on Memory Pool in
Bitcoin network. We provide certain metrics such as transaction count,
total transaction size, total transaction fee on memory pool, based on fee
range, including aggregated metrics.
For more detailed information, please refer to the description of each
metric.
- name: BTC Lightning Network Statistics
description: >-
This namespace contains endpoints to retrieve statistics on Lightning
Network. We provide certain metrics such as the number of channel, nodes
and network capacity from lightning network.
For more detailed information, please refer to the description of each
metric.
- name: BTC Flow Indicator
description: >-
This namespace contains endpoints to retrieve Fund Flow ratio, Miners'
Position Index(MPI), and etc. We provide certain indicators to avoid any
risks, assume upside or downside potentials, and give insights on the
value of bitcoin. For more detailed information, please refer to the
description of each metric.
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: BTC Miner Data
description: >-
This namespace contains endpoints to retrieve statistics on Bitcoin
miners. We provide certain metrics such as rewards from coinbase or
miners, the number of production reported from miners, the number of
transaction and the number of address
For more detailed information, please refer to the description of each metric.
- name: ETH Entity Status
description: Entity List of Ethereum API with Status
- name: ETH Network Data
description: >-
Ethereum on-chain network data including but not limited to token
movements, fees, supply, address movements, etc. All metrics have data
entries starting from the genesis block (block height `0`, datetime
`2015-07-30 15:26:13`).
- name: ETH Exchange Flows
description: >-
This endpoint returns the flows of ETH into exchange wallets for as far
back as we track.
We constantly keep updating new exchange wallets, which means that there
can be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
Supported exchanges can be found in the `/eth/status/entity-list`
endpoint.
In addition to that, we support the following aggregated exchanges:
### Supported Aggregated Exchanges
| Name | Exchange | Status |
|----------------|--------------|-------------|
| All Exchanges | `all_exchange` | Validated |
| Spot Exchanges | `spot_exchange` | Validated |
| Derivative Exchanges | `derivative_exchange` | Validated |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: ETH Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to the value
of ETH including price, etc.
We provide USD and USDT spot price of ETH from global exchanges and ETH
index price. CryptoQuant's ETH index price is VWAP(Volume Weighted Average
Price) of aggregated price data from all exchanges we provide.
For more detailed information, please refer to the description of each
metric.
- name: ETH Market Indicator
description: >-
This namespace contains endpoints to retrieve Estimated Leverage Ratio. We
provide certain indicators to avoid any risks, assume upside or downside
potentials, and give insights on the value of ethereum. For more detailed
information, please refer to the description of each metric.
- name: ETH Flow Indicator
description: >-
This namespace contains endpoints to retrieve entity flow based
indicators. We provide certain indicators to avoid any risks, assume
upside or downside potentials, and give insights on the value of bitcoin.
For more detailed information, please refer to the description of each
metric.
- name: ETH Fund Data
description: >-
This namespace cointains endpoints to retreive metrics related to
regulated funds such as trust, including market price, market volume,
market premium, and digital asset holdings. These metrics are useful to
measure sentiments of investors such as institutions in regulated market.
All Symbol will be updated no later then UTC 12:00, this may be changed
depending on update time of source data. Also the return value may be
changed because of late updated fund.
### Supported Symbols
| Name | Symbol | Status |
Source |
|---------------------------------------|-------------|-------------|-----------------------|
| All Symbol (ETH) | `all_symbol`| Validated | All
Fund |
| Grayscale Ethereum Trust (ETHE) | `ethe` | Validated |
Grayscale Investments |
| Grayscale Ethereum Mini Trust (ETH) | `eth` | Validated |
Grayscale Investments |
| iShares Ethereum Trust ETF (ETHA) | `etha` | Validated |
BlackRock |
| Fidelity Ethereum Fund ETF (FETH) | `feth` | Validated |
Fidelity |
| Bitwise Ethereum ETF (ETHW) | `ethw` | Validated |
Bitwise |
| 21Shares Ethereum Core ETP (CETH) | `ceth` | Validated |
21Shares |
| Invesco Galaxy Ethereum ETF (QETH) | `qeth` | Validated |
Invesco |
| VanEck Ethereum ETF (ETHV) | `ethv` | Validated |
VanEck |
| Franklin Ethereum ETF (EZET) | `ezet` | Validated |
Franklin Templeton |
| Purpose Ether ETF (ETHH.U) | `ethh_u` | Validated |
Purpose Investments |
- name: ETH 2.0
description: >-
Genesis event of ETH 2.0 requires at least 16,384 of 32-ETH validator
deposits seven days before Dec 1. If not, the genesis event would postpone
seven days after. We have only valid transactions in the calculations.
Looking at the ETH2 deposit contract, Only from 32 to 1000 deposits are
considered as valid deposits.
When Phase 0 success rate hits 100% and Phase 0 unique validator hits
16,384, the Ethereum genesis event starts.
- name: Stablecoin Entity Status
description: Entity List of Stablecoin API with Status
- name: Stablecoin Exchange Flows
description: >-
This endpoint returns the flows of Stablecoin tokens into exchange wallets
for as far back as we track. Please note that the transfer generally
occurs after a certain amount of time from the contract created time.
We constantly keep updating new exchange wallets, which means that there
can be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
Supported exchanges can be found in the `/stablecoin/status/entity-list`
endpoint.
In addition to that, we support the following aggregated exchanges:
### Supported Aggregated Exchanges
| Name | Exchange | Supported Stablecoins |
|----------------|----------------|-------------------------------|
| All Exchanges| `all_exchange` | All Tokens |
| Spot Exchanges | `spot_exchange` | All Tokens |
| Derivative Exchanges | `derivative_exchange` | All Tokens |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: Stablecoin Network Data
description: >-
This namespace contains endpoint to retrieve on-chain network data for
stablecoins including token transfers, issuance, addresses, etc. The
earliest data point of each token is listed as Contract Created Datetime.
[here](#tag/Stablecoin Status)
### Stablecoin Issuing Mechanism
Each individual Stablecoin is created by an issuing company and each of
these companies operates with a different issue mechanism.
There are many of these but the two most common are as follows.
#### Example 1
Before providing clients with the granting address, the issuing company
holds a treasury address. Through the contract, the tokens are minted and
held in the treasury address. Once the client sends fiat currency, the
clients tokens are moved from the treasury address to the client address
and the tokens are listed as being issued.
Conversely, when redeeming tokens for fiat, the tokens are sent to the
treasury address and redeemed. This won't be reflected in the supply
unless these tokens are burned using a contract by the issuing company.
The circulating supply is calculated as tokens that have been issued to
clients, ignoring the supply held in the issuing company wallets.
#### Example 2
In this method, there is no separate treasury address. After confirming
the deposit of fiat, tokens are minted from the contract address and
delivered directly to the client address. Minting and issuance occur
simultaneously. When clients redeem tokens, the burn and redemption also
are simultaneous.
This means that with this method, total supply and circulating supply will
be the same. There are various methods for Stablecoin issuance, and we
calculated supply and locate significant transactions. based upon these
types of factors. In the future, mint/issue/burn/redeem will be added our
available metrics and will be defined as listed below.
#### Terminology
| Term | Definition |
|----------------|---------------|
| Mint | Mint is a creation of new tokens that add to the
supply. When tokens are minted, the total supply will increase.|
| Issue | Issue is when tokens are delivered to clients after
deposit of fiat has been confirmed. When tokens are issued, the
circulating supply will increase.|
| Burn | Burn is a revocation of currently existing tokens that
results in a decreased supply. The opposite of Mint.|
| Redeem | Redeem is an exchange of tokens for deposited fiat
that results in a decrease in the circulating supply. The opposite of
Issue.|
- name: Stablecoin Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to the value
of tokens, including price, market cap, etc.
- name: Stablecoin Flow Indicator
description: >-
This namespace contains endpoints to retrieve entity flow based
indicators. We provide certain indicators to avoid any risks, assume
upside or downside potentials, and give insights on the value of bitcoin.
For more detailed information, please refer to the description of each
metric.
- name: ERC20 Entity Status
description: Entity List of ERC20 API with Status
- name: ERC20 Exchange Flows
description: >-
This endpoint returns the flows of ERC20 tokens into exchange wallets for
as far back as we track. Please note that the transfer generally occurs
after a certain amount of time from the contract created time.
We constantly keep updating new exchange wallets, which means that there
can be slight modification in values especially for recent data points.
The update is done in periodic and automatic way: Tuesday 00:00 UTC every
week.
Supported exchanges can be found in the `/erc20/status/entity-list`
endpoint.
In addition to that, we support the following aggregated exchanges:
### Supported Aggregated Exchanges
| Name | Exchange | Supported ERC20 Tokens |
|----------------|----------------|-------------------------------|
| All Exchanges | `all_exchange` | All Tokens |
| Spot Exchanges | `spot_exchange` | All Tokens |
| Derivative Exchanges | `derivative_exchange` | All Tokens |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: ERC20 Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to the value
of tokens.
- name: ERC20 Flow Indicator
description: >
This namespace contains endpoints to retrieve entity flow based
indicators.
We provide certain indicators to avoid any risks, assume upside or
downside potentials, and give insights on the value of bitcoin.
For more detailed information, please refer to the description of each
metric.
- name: Alt Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to the value
of tokens.
- name: XRP Entity Flows
description: >-
This namespace contains endpoints to retrieve metrics related to XRP
Entity Flows.
Currently, We only supports Exchanges for available entities
### Supported Exchanges
| Name |
|------------|
| Binance |
| Bitfinex |
| Bitget |
| Bithumb |
| Bitstamp |
| Bybit |
| Gate.io |
| HTX Global |
| Kucoin |
| OKX |
| Upbit |
> **Note:** This endpoint does not support Point-In-Time (PIT) accuracy
due to periodic updates to wallet address clustering. Historical data may
change as new exchange wallets are discovered, added, and validated.
- name: XRP Flow Indicator
description: >-
This namespace contains endpoints to retrieve metrics related to XRP Flow
Indicators.
- name: XRP Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to XRP
Market Data.
- name: XRP Network Data
description: >-
This namespace contains endpoints to retrieve metrics related to XRP
Network Data.
- name: XRP Network Indicator
description: >-
This namespace contains endpoints to retrieve metrics related to XRP
Network Indicators.
- name: XRP Dex Data
description: This namespace contains endpoints to retrieve metrics related to XRP Dex.
- name: XRP AMM Data
description: >-
This namespace contains endpoints to retrieve metrics related to XRP AMM
Data.
### Supported AMM Pairs
| Name | AMM Account | AMM | Status |
|----------------|-------------|--------------|-------------|
| MAG/XRP |`rNZ2ZVF1ZU34kFQvcN4xkFAvdSvve5bXce`| `mag-xrp` |
Validated |
| XGO/XRP |`rLeAEvRQ5RnN6LJnZ29Xw4pboWfKqYut3c`| `xgo-xrp` |
Validated |
| SOLO/XRP |`rMEJo9H5XvTe17UoAJzj8jtKVvTRcxwngo`| `solo-xrp` |
Validated |
| USDC/XRP |`rGHt6LT5v9DVaEAmFzj5ciuxuj41ZjLofs`| `usdc-xrp` |
Validated |
| BTC/XRP |`rQBeAghWHEwWvKShryBSa5yR3VRX9oyQ5T`| `btc-xrp` |
Validated |
| USD/XRP |`rHUpaqUPbwzKZdzQ8ZQCme18FrgW9pB4am`| `usd-xrp` |
Validated |
| XPM/XRP |`rakZprdzwsUJ1rD2ouhYYAVP7tPbhrCbtz`| `xpm-xrp` |
Validated |
| CSC/XRP |`rf7g4JWCxu9oE1MKsWTihL9whY75AphCaV`| `csc-xrp` |
Validated |
| RLT/XRP |`rwzCasMZW2WisfohuMCVWdDD58HK9QtDyC`| `rlt-xrp` |
Validated |
| CORE/XRP |`rBu4LXTxM9cfs3JsFCuDbPMzvGBDR66wpi`| `core-xrp` |
Validated |
- name: TRX Market Data
description: >-
This namespace contains endpoints to retrieve metrics related to TRX
Market Data.
- name: TRX Network Data
description: >-
This namespace contains endpoints to retrieve metrics related to TRX
Network Data.
- name: Latency
description: >-
Data freshness. Append `/latency` to any v1 data endpoint to see how long
after a block its data becomes collectable and fully processed.
paths:
/xrp/market-data/open-interest:
get:
tags:
- XRP Market Data
summary: Open Interest
description: >-
This endpoint returns XRP Perpetual Open Interest from derivative
exchanges.
| Name | Exchange | Symbol |
|----------------|--------------|----|
| All Exchanges | `all_exchange` | `all_symbol`* |
| Binance | `binance` | `xrp_usdt`
`xrp_usd`
`all_symbol`*|
| Bybit | `bybit` | `xrp_usdt`
`xrp_usd`
`all_symbol`*|
| Bitmex | `bitmex` | `xrp_usd`* |
| HTX Global | `htx_global` | `xrp_usdt`* |
| Kraken | `kraken` | `xrp_usd`* |
| OKX | `okx` | `xrp_usdt`
`xrp_usd`
`all_symbol`* |
| Bitfinex | `bitfinex` | `xrp_usdt`* |
Supported exchanges for Open Interest are available in Discovery
section.
Note we unify the unit of return value to USD for each exchange where
its contract specification may vary.
**📖 Data Guide:** [Open Interest](/data-guide/market/open-interest) —
definition, interpretation, and chart examples.
operationId: XRPgetOpenInterest
parameters:
- description: >-
An exchange from the table that we support. [See
here](#tag/BTC-Exchange-Flows).
explode: false
in: query
name: exchange
required: true
schema:
type: string
style: form
example: binance
- description: >-
A pair symbol (ticker) from the table that we support. [See
here](#tag/XRPgetOpenInterest)
explode: false
in: query
name: symbol
required: false
schema:
type: string
default: all_symbol
style: form
example: xrp_usdt
- description: Currently we support `day`, `hour`, and `min`.
explode: false
in: query
name: window
schema:
type: string
default: day
style: form
example: day
- description: >-
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.
explode: false
in: query
name: from
required: false
schema:
type: string
style: form
example: 20191001T100000
- description: >-
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.
explode: false
in: query
name: to
required: false
schema:
type: string
style: form
example: 20191001T103025
- description: >-
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.
explode: false
in: query
name: limit
required: false
schema:
type: integer
default: 100
minimum: 1
maximum: 100000
style: form
example: 100
- description: >-
A format type about return message type. Supported formats are json,
csv.
explode: false
in: query
name: format
required: false
schema:
type: string
default: json
style: form
example: json
responses:
'200':
description: Open Interest in USD
content:
application/json:
schema:
type: object
required:
- status
- result
properties:
status:
type: object
description: >-
The status object is return with most of requests and
indicates if the request was successful. If it is not
successful, error information is included.
properties:
code:
type: integer
format: int32
description: HTTP status code
message:
type: string
description: Text description of the error or success.
required:
- code
- message
result:
type: object
required:
- window
- data
properties:
window:
type: string
description: >-
The size of window. It can be day, hour, or min and it
depends on the user request.
data:
type: array
items:
type: object
required:
- open_interest
properties:
date:
type: string
description: >-
The date in YYYY-DD-MM. This optional field only
appears when window=day is used.
datetime:
type: string
description: >-
The date and time formatted as YYYY-MM-DD
HH:MM:SS (UTC time). This field only appears
when window=block is used.
open_interest:
type: string
description: >-
The amount of open interest in the given period
and exchange. The standard unit can differ from
each exchange.
example:
status:
code: 200
message: success
result:
window: day
data:
- date: '2019-10-02'
open_interest: null
- date: '2019-10-01'
open_interest: null
security:
- AccessToken: []
x-codeSamples:
- lang: Shell
source: >-
curl
"https://api.cryptoquant.com/v1/xrp/market-data/open-interest?window=day&from=20191001&exchange=bitmex"
- lang: JavaScript
source: >-
fetch("https://api.cryptoquant.com/v1/xrp/market-data/open-interest?window=day&from=20191001&exchange=bitmex")
.then(response => response.json())
.then(data => console.log(data))
- lang: NodeJS
source: |-
require('axios')
.get("https://api.cryptoquant.com/v1/xrp/market-data/open-interest?window=day&from=20191001&exchange=bitmex")
.then(response => console.log(response))
- lang: Ruby
source: >-
require 'net/http'
uri =
URI("https://api.cryptoquant.com/v1/xrp/market-data/open-interest?window=day&from=20191001&exchange=bitmex")
puts Net::HTTP.get(uri)
- lang: Python
source: >-
import requests
headers = {'Authorization': 'Bearer ' + access_token}
url =
"https://api.cryptoquant.com/v1/xrp/market-data/open-interest?window=day&from=20191001&exchange=bitmex"
print(requests.get(url, headers=headers).json())
components:
securitySchemes:
AccessToken:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
For each API request, include this HTTP header:
`Authorization` with the `Bearer {access_token}`. Bearer access token is
the type of HTTP Authorization. You have to include access token to the
HTTP header and note that leading bearer is required.
You must include your access token in HTTP header in every request you
make. The token is unique, issued for each client, and regularly
changed(once a year). To obtain an access token, please [upgrade your
plan](https://cryptoquant.com/pricing) to Professional or Premium plan.
You'll be able to see your access token on the [API
tab](https://cryptoquant.com/settings/api) of your profile page after
the subscription.
````