rest-api.md

#  Rest API List for CoinGlass

## Futures - Trading Market

| Name                         | github                                                              | docs                                                                    |
| ---------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| Supported Coins              | [Link](./rest/Futures/Trading-Market/coins.md)                      | [Link](https://docs.coinglass.com/reference/coins)                      |
| Supported Exchanges          | [Link](./rest/Futures/Trading-Market/supported-exchanges.md)        | [Link](https://docs.coinglass.com/reference/supported-exchanges)        |
| Supported Exchange and Pairs | [Link](./rest/Futures/Trading-Market/instruments.md)                | [Link](https://docs.coinglass.com/reference/instruments)                |
| Coins Markets                | [Link](./rest/Futures/Trading-Market/coins-markets.md)              | [Link](https://docs.coinglass.com/reference/coins-markets)              |
| Pairs Markets                | [Link](./rest/Futures/Trading-Market/pairs-markets.md)              | [Link](https://docs.coinglass.com/reference/pairs-markets)              |
| Coins Price Change           | [Link](./rest/Futures/Trading-Market/coins-price-change.md)         | [Link](https://docs.coinglass.com/reference/coins-price-change)         |
| Price History (OHLC)         | [Link](./rest/Futures/Trading-Market/price-ohlc-history.md)         | [Link](https://docs.coinglass.com/reference/price-ohlc-history)         |
| Delisted Pairs               | [Link](./rest/Futures/Trading-Market/delisted-exchange-and-pair.md) | [Link](https://docs.coinglass.com/reference/delisted-exchange-and-pair) |
| Exchange Rank                | [Link](./rest/Futures/Trading-Market/exchange-list.md)              | [Link](https://docs.coinglass.com/reference/exchange-list)              |

## Futures - Open Interest

| Name                                        | github                                                                               | docs                                                                                      |
| ------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| History (OHLC)                              | [Link](./rest/Futures/Open-Interest/oi-ohlc-histroy.md)                              | [Link](https://docs.coinglass.com/reference/oi-ohlc-histroy)                              |
| Aggregated History (OHLC)                   | [Link](./rest/Futures/Open-Interest/oi-ohlc-aggregated-history.md)                   | [Link](https://docs.coinglass.com/reference/oi-ohlc-aggregated-history)                   |
| Aggregated Stablecoin Margin History (OHLC) | [Link](./rest/Futures/Open-Interest/oi-ohlc-aggregated-stablecoin-margin-history.md) | [Link](https://docs.coinglass.com/reference/oi-ohlc-aggregated-stablecoin-margin-history) |
| Aggregated Coin Margin History (OHLC)       | [Link](./rest/Futures/Open-Interest/oi-ohlc-aggregated-coin-margin-history.md)       | [Link](https://docs.coinglass.com/reference/oi-ohlc-aggregated-coin-margin-history)       |
| Exchange List                               | [Link](./rest/Futures/Open-Interest/oi-exchange-list.md)                             | [Link](https://docs.coinglass.com/reference/oi-exchange-list)                             |
| Exchange History Chart                      | [Link](./rest/Futures/Open-Interest/oi-exchange-history-chart.md)                    | [Link](https://docs.coinglass.com/reference/oi-exchange-history-chart)                    |

## Futures - Funding Rate

| Name                      | github                                                          | docs                                                                  |
| ------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------- |
| History (OHLC)            | [Link](./rest/Futures/Funding-Rate/fr-ohlc-histroy.md)          | [Link](https://docs.coinglass.com/reference/fr-ohlc-histroy)          |
| OI Weight History (OHLC)  | [Link](./rest/Futures/Funding-Rate/oi-weight-ohlc-history.md)   | [Link](https://docs.coinglass.com/reference/oi-weight-ohlc-history)   |
| Vol Weight History (OHLC) | [Link](./rest/Futures/Funding-Rate/vol-weight-ohlc-history.md)  | [Link](https://docs.coinglass.com/reference/vol-weight-ohlc-history)  |
| Exchange List             | [Link](./rest/Futures/Funding-Rate/fr-exchange-list.md)         | [Link](https://docs.coinglass.com/reference/fr-exchange-list)         |
| Cumulative Exchange List  | [Link](./rest/Futures/Funding-Rate/cumulative-exchange-list.md) | [Link](https://docs.coinglass.com/reference/cumulative-exchange-list) |
| Arbitrage                 | [Link](./rest/Futures/Funding-Rate/fr-arbitrage.md)             | [Link](https://docs.coinglass.com/reference/fr-arbitrage)             |

## Futures - Long-Short Ratio

| Name                          | github                                                                        | docs                                                                            |
| ----------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| Global Account Ratio          | [Link](./rest/Futures/Long-Short-Ratio/global-longshort-account-ratio.md)     | [Link](https://docs.coinglass.com/reference/global-longshort-account-ratio)     |
| Top Account Ratio History     | [Link](./rest/Futures/Long-Short-Ratio/top-longshort-account-ratio.md)        | [Link](https://docs.coinglass.com/reference/top-longshort-account-ratio)        |
| Top Position Ratio History    | [Link](./rest/Futures/Long-Short-Ratio/top-longshort-position-ratio.md)       | [Link](https://docs.coinglass.com/reference/top-longshort-position-ratio)       |
| Exchange Taker Buy/Sell Ratio | [Link](./rest/Futures/Long-Short-Ratio/taker-buysell-volume-exchange-list.md) | [Link](https://docs.coinglass.com/reference/taker-buysell-volume-exchange-list) |
| Net Position                  | [Link](./rest/Futures/Long-Short-Ratio/net-position.md)                       | [Link](https://docs.coinglass.com/reference/net-position)                       |
| Net Position (v2)             | [Link](./rest/Futures/Long-Short-Ratio/net-position-v2.md)                    | [Link](https://docs.coinglass.com/reference/net-position-v2)                    |

## Futures - Liquidation

| Name                            | github                                                                      | docs                                                                               |
| ------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| Pair Liquidation History        | [Link](./rest/Futures/Liquidation/liquidation-history.md)                   | [Link](https://docs.coinglass.com/reference/liquidation-history)                   |
| Coin Liquidation History        | [Link](./rest/Futures/Liquidation/aggregated-liquidation-history.md)        | [Link](https://docs.coinglass.com/reference/aggregated-liquidation-history)        |
| Liquidation Coin List           | [Link](./rest/Futures/Liquidation/liquidation-coin-list.md)                 | [Link](https://docs.coinglass.com/reference/liquidation-coin-list)                 |
| Liquidation Exchange List       | [Link](./rest/Futures/Liquidation/liquidation-exchange-list.md)             | [Link](https://docs.coinglass.com/reference/liquidation-exchange-list)             |
| Liquidation Order               | [Link](./rest/Futures/Liquidation/liquidation-order.md)                     | [Link](https://docs.coinglass.com/reference/liquidation-order)                     |
| Pair Liquidation Heatmap Model1 | [Link](./rest/Futures/Liquidation/liquidation-heatmap.md)                   | [Link](https://docs.coinglass.com/reference/liquidation-heatmap)                   |
| Pair Liquidation Heatmap Model2 | [Link](./rest/Futures/Liquidation/liquidation-heatmap-model2.md)            | [Link](https://docs.coinglass.com/reference/liquidation-heatmap-model2)            |
| Pair Liquidation Heatmap Model3 | [Link](./rest/Futures/Liquidation/liquidation-heatmap-model3.md)            | [Link](https://docs.coinglass.com/reference/liquidation-heatmap-model3)            |
| Coin Liquidation Heatmap Model1 | [Link](./rest/Futures/Liquidation/liquidation-aggregate-heatmap.md)         | [Link](https://docs.coinglass.com/reference/liquidation-aggregate-heatmap)         |
| Coin Liquidation Heatmap Model2 | [Link](./rest/Futures/Liquidation/liquidation-aggregate-heatmap-model2.md)  | [Link](https://docs.coinglass.com/reference/liquidation-aggregate-heatmap-model2)  |
| Coin Liquidation Heatmap Model3 | [Link](./rest/Futures/Liquidation/liquidation-aggregated-heatmap-model3.md) | [Link](https://docs.coinglass.com/reference/liquidation-aggregated-heatmap-model3) |
| Pair Liquidation Map            | [Link](./rest/Futures/Liquidation/liquidation-map.md)                       | [Link](https://docs.coinglass.com/reference/liquidation-map)                       |
| Coin Liquidation Map            | [Link](./rest/Futures/Liquidation/liquidation-aggregated-map.md)            | [Link](https://docs.coinglass.com/reference/liquidation-aggregated-map)            |
| Liquidation Max Pain            | [Link](./rest/Futures/Liquidation/liquidation-max-pain.md)                  | [Link](https://docs.coinglass.com/reference/liquidation-max-pain)                  |

## Futures - Order Book

| Name                                      | github                                                                    | docs                                                                              |
| ----------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Pair Orderbook Bid&Ask(±range)            | [Link](./rest/Futures/Order-Book/futures-orderbook-history.md)            | [Link](https://docs.coinglass.com/reference/futures-orderbook-history)            |
| Coin Aggregated Orderbook Bid&Ask(±range) | [Link](./rest/Futures/Order-Book/futures-aggregated-orderbook-history.md) | [Link](https://docs.coinglass.com/reference/futures-aggregated-orderbook-history) |
| Orderbook Heatmap                         | [Link](./rest/Futures/Order-Book/orderbook-heatmap.md)                    | [Link](https://docs.coinglass.com/reference/orderbook-heatmap)                    |
| Large Orderbook                           | [Link](./rest/Futures/Order-Book/large-orderbook.md)                      | [Link](https://docs.coinglass.com/reference/large-orderbook)                      |
| Large Orderbook History                   | [Link](./rest/Futures/Order-Book/large-orderbook-history.md)              | [Link](https://docs.coinglass.com/reference/large-orderbook-history)              |

## Futures - Hyperliquid Positions

| Name                                      | github                                                                                   | docs                                                                                  |
| ----------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| Hyperliquid Whale Alert                   | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-whale-alert.md)                  | [Link](https://docs.coinglass.com/reference/hyperliquid-whale-alert)                  |
| Hyperliquid Whale Position                | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-whale-position.md)               | [Link](https://docs.coinglass.com/reference/hyperliquid-whale-position)               |
| Hyperliquid Wallet Positions by Coin      | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-position.md)                     | [Link](https://docs.coinglass.com/reference/hyperliquid-position)                     |
| Hyperliquid Wallet Positions by Address   | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-user-position.md)                | [Link](https://docs.coinglass.com/reference/hyperliquid-user-position)                |
| Hyperliquid Wallet Positions Distribution | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-wallet-position-distribution.md) | [Link](https://docs.coinglass.com/reference/hyperliquid-wallet-position-distribution) |
| Hyperliquid Wallet PNL Distribution       | [Link](./rest/Futures/Hyperliquid-Positions/hyperliquid-wallet-pnl-distribution.md)      | [Link](https://docs.coinglass.com/reference/hyperliquid-wallet-pnl-distribution)      |

## Futures - Taker Buy/Sell

| Name                                     | github                                                                           | docs                                                                                 |
| ---------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| Pair Taker Buy/Sell History              | [Link](./rest/Futures/Taker-Buy/Sell/taker-buysell-volume.md)                    | [Link](https://docs.coinglass.com/reference/taker-buysell-volume)                    |
| Coin Taker Buy/Sell History              | [Link](./rest/Futures/Taker-Buy/Sell/aggregated-taker-buysell-volume-history.md) | [Link](https://docs.coinglass.com/reference/aggregated-taker-buysell-volume-history) |
| Footprint History (90d)                  | [Link](./rest/Futures/Taker-Buy/Sell/futures-footprint.md)                       | [Link](https://docs.coinglass.com/reference/futures-footprint)                       |
| Cumulative Volume Delta (CVD)            | [Link](./rest/Futures/Taker-Buy/Sell/futures-cvd-history.md)                     | [Link](https://docs.coinglass.com/reference/futures-cvd-history)                     |
| Aggregated Cumulative Volume Delta (CVD) | [Link](./rest/Futures/Taker-Buy/Sell/futures-aggregated-cvd-history.md)          | [Link](https://docs.coinglass.com/reference/futures-aggregated-cvd-history)          |

## Spots - Trading market

| Name                        | github                                                              | docs                                                                      |
| --------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| Supported Coins             | [Link](./rest/Spots/Trading-market/spot-supported-coins.md)         | [Link](https://docs.coinglass.com/reference/spot-supported-coins)         |
| Suported Exchange and Pairs | [Link](./rest/Spots/Trading-market/spot-suported-exchange-pairs.md) | [Link](https://docs.coinglass.com/reference/spot-suported-exchange-pairs) |
| Coins Markets               | [Link](./rest/Spots/Trading-market/spot-coins-markets.md)           | [Link](https://docs.coinglass.com/reference/spot-coins-markets)           |
| Pairs Markets               | [Link](./rest/Spots/Trading-market/spot-pairs-markets.md)           | [Link](https://docs.coinglass.com/reference/spot-pairs-markets)           |
| Price OHLC History          | [Link](./rest/Spots/Trading-market/price-history.md)                | [Link](https://docs.coinglass.com/reference/price-history)                |

## Spots - Order book

| Name                           | github                                                       | docs                                                                   |
| ------------------------------ | ------------------------------------------------------------ | ---------------------------------------------------------------------- |
| Pair Orderbook Bid&Ask(±range) | [Link](./rest/Spots/Order-book/spot-orderbook-history.md)    | [Link](https://docs.coinglass.com/reference/spot-orderbook-history)    |
| Coin Orderbook Bid&Ask(±range) | [Link](./rest/Spots/Order-book/spot-aggregated-history.md)   | [Link](https://docs.coinglass.com/reference/spot-aggregated-history)   |
| Orderbook Heatmap              | [Link](./rest/Spots/Order-book/orderbook-history-1.md)       | [Link](https://docs.coinglass.com/reference/orderbook-history-1)       |
| Large Orderbook                | [Link](./rest/Spots/Order-book/large-limit-order-1.md)       | [Link](https://docs.coinglass.com/reference/large-limit-order-1)       |
| Large Orderbook History        | [Link](./rest/Spots/Order-book/large-orderbook-history-2.md) | [Link](https://docs.coinglass.com/reference/large-orderbook-history-2) |

## Spots - Taker Buy/Sell

| Name                                     | github                                                                       | docs                                                                               |
| ---------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| Pair Taker Buy/Sell History              | [Link](./rest/Spots/Taker-Buy/Sell/spot-taker-buysell-ratio-history.md)      | [Link](https://docs.coinglass.com/reference/spot-taker-buysell-ratio-history)      |
| Coin Taker Buy/Sell History              | [Link](./rest/Spots/Taker-Buy/Sell/spot-aggregated-taker-buysell-history.md) | [Link](https://docs.coinglass.com/reference/spot-aggregated-taker-buysell-history) |
| Footprint History (90d)                  | [Link](./rest/Spots/Taker-Buy/Sell/spot-footprint.md)                        | [Link](https://docs.coinglass.com/reference/spot-footprint)                        |
| Cumulative Volume Delta (CVD)            | [Link](./rest/Spots/Taker-Buy/Sell/spot-cvd-history.md)                      | [Link](https://docs.coinglass.com/reference/spot-cvd-history)                      |
| Aggregated Cumulative Volume Delta (CVD) | [Link](./rest/Spots/Taker-Buy/Sell/spot-aggregated-cvd-history.md)           | [Link](https://docs.coinglass.com/reference/spot-aggregated-cvd-history)           |

## Options

| Name                           | github                                                   | docs                                                                        |
| ------------------------------ | -------------------------------------------------------- | --------------------------------------------------------------------------- |
| Option Max Pain                | [Link](./rest/Options/option-max-pain.md)                | [Link](https://docs.coinglass.com/reference/option-max-pain)                |
| Options Info                   | [Link](./rest/Options/info.md)                           | [Link](https://docs.coinglass.com/reference/info)                           |
| Exchange Open Interest History | [Link](./rest/Options/exchange-open-interest-history.md) | [Link](https://docs.coinglass.com/reference/exchange-open-interest-history) |
| Exchange Volume History        | [Link](./rest/Options/exchange-volume-history.md)        | [Link](https://docs.coinglass.com/reference/exchange-volume-history)        |

## On-Chain - Exchange data

| Name                   | github                                                          | docs                                                                |
| ---------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------- |
| Exchange Assets        | [Link](./rest/On-Chain/Exchange-data/exchange-assets.md)        | [Link](https://docs.coinglass.com/reference/exchange-assets)        |
| Exchange Balance List  | [Link](./rest/On-Chain/Exchange-data/exchange-balance-list.md)  | [Link](https://docs.coinglass.com/reference/exchange-balance-list)  |
| Exchange Balance Chart | [Link](./rest/On-Chain/Exchange-data/exchange-balance-chart.md) | [Link](https://docs.coinglass.com/reference/exchange-balance-chart) |

## On-Chain - Transactions

| Name                                 | github                                                             | docs                                                                    |
| ------------------------------------ | ------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| Exchange On-chain Transfers (ERC-20) | [Link](./rest/On-Chain/Transactions/exchange-onchain-transfers.md) | [Link](https://docs.coinglass.com/reference/exchange-onchain-transfers) |
| Whale Transfer                       | [Link](./rest/On-Chain/Transactions/whale-transfer.md)             | [Link](https://docs.coinglass.com/reference/whale-transfer)             |

## On-Chain - Token

| Name              | github                                            | docs                                                          |
| ----------------- | ------------------------------------------------- | ------------------------------------------------------------- |
| Token Unlock List | [Link](./rest/On-Chain/Token/coin-unlock-list.md) | [Link](https://docs.coinglass.com/reference/coin-unlock-list) |
| Token Vesting     | [Link](./rest/On-Chain/Token/token-vesting.md)    | [Link](https://docs.coinglass.com/reference/token-vesting)    |

## ETF - Bitcoin ETF

| Name                         | github                                                                 | docs                                                                              |
| ---------------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Bitcoin ETF List             | [Link](./rest/ETF/Bitcoin-ETF/bitcoin-etfs.md)                         | [Link](https://docs.coinglass.com/reference/bitcoin-etfs)                         |
| Hong Kong ETF Flows History  | [Link](./rest/ETF/Bitcoin-ETF/hong-kong-bitcoin-etf-flow-history.md)   | [Link](https://docs.coinglass.com/reference/hong-kong-bitcoin-etf-flow-history)   |
| ETF NetAssets History        | [Link](./rest/ETF/Bitcoin-ETF/bitcoin-etf-netassets-history.md)        | [Link](https://docs.coinglass.com/reference/bitcoin-etf-netassets-history)        |
| ETF Flows History            | [Link](./rest/ETF/Bitcoin-ETF/etf-flows-history.md)                    | [Link](https://docs.coinglass.com/reference/etf-flows-history)                    |
| ETF Premium/Discount History | [Link](./rest/ETF/Bitcoin-ETF/bitcoin-etf-premium-discount-history.md) | [Link](https://docs.coinglass.com/reference/bitcoin-etf-premium-discount-history) |
| ETF History                  | [Link](./rest/ETF/Bitcoin-ETF/etf-history.md)                          | [Link](https://docs.coinglass.com/reference/etf-history)                          |
| ETF Price History            | [Link](./rest/ETF/Bitcoin-ETF/etf-price-ohlc-history.md)               | [Link](https://docs.coinglass.com/reference/etf-price-ohlc-history)               |
| ETF Detail                   | [Link](./rest/ETF/Bitcoin-ETF/etf-detail.md)                           | [Link](https://docs.coinglass.com/reference/etf-detail)                           |
| ETF AUM                      | [Link](./rest/ETF/Bitcoin-ETF/etf-aum.md)                              | [Link](https://docs.coinglass.com/reference/etf-aum)                              |

## ETF - Ethereum ETF

| Name                  | github                                                            | docs                                                                        |
| --------------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------- |
| ETF NetAssets History | [Link](./rest/ETF/Ethereum-ETF/ethereum-etf-netassets-history.md) | [Link](https://docs.coinglass.com/reference/ethereum-etf-netassets-history) |
| Ethereum ETF List     | [Link](./rest/ETF/Ethereum-ETF/ethereum-etf-list.md)              | [Link](https://docs.coinglass.com/reference/ethereum-etf-list)              |
| ETF Flows History     | [Link](./rest/ETF/Ethereum-ETF/ethereum-etf-flows-history.md)     | [Link](https://docs.coinglass.com/reference/ethereum-etf-flows-history)     |

## ETF - Grayscale

| Name            | github                                                    | docs                                                                   |
| --------------- | --------------------------------------------------------- | ---------------------------------------------------------------------- |
| Holdings List   | [Link](./rest/ETF/Grayscale/grayscale-holding-list.md)    | [Link](https://docs.coinglass.com/reference/grayscale-holding-list)    |
| Premium History | [Link](./rest/ETF/Grayscale/grayscale-premium-history.md) | [Link](https://docs.coinglass.com/reference/grayscale-premium-history) |

## ETF - Solana ETF

| Name              | github                                                    | docs                                                                  |
| ----------------- | --------------------------------------------------------- | --------------------------------------------------------------------- |
| ETF Flows History | [Link](./rest/ETF/Solana-ETF/solana-etf-flows-history.md) | [Link](https://docs.coinglass.com/reference/solana-etf-flows-history) |

## ETF - XRP ETF

| Name              | github                                              | docs                                                               |
| ----------------- | --------------------------------------------------- | ------------------------------------------------------------------ |
| ETF Flows History | [Link](./rest/ETF/XRP-ETF/xrp-etf-flows-history.md) | [Link](https://docs.coinglass.com/reference/xrp-etf-flows-history) |

## Indic - Futures

| Name                                         | github                                                  | docs                                                                 |
| -------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------- |
| Coin RSI List                                | [Link](./rest/Indic/Futures/futures-rsi-list.md)        | [Link](https://docs.coinglass.com/reference/futures-rsi-list)        |
| Pair RSI                                     | [Link](./rest/Indic/Futures/futures-indicators-rsi.md)  | [Link](https://docs.coinglass.com/reference/futures-indicators-rsi)  |
| Moving Average (MA)                          | [Link](./rest/Indic/Futures/futures-indicators-ma.md)   | [Link](https://docs.coinglass.com/reference/futures-indicators-ma)   |
| Exponential Moving Average (EMA)             | [Link](./rest/Indic/Futures/futures-indicators-ema.md)  | [Link](https://docs.coinglass.com/reference/futures-indicators-ema)  |
| Bollinger Bands (BOLL)                       | [Link](./rest/Indic/Futures/futures-indicators-boll.md) | [Link](https://docs.coinglass.com/reference/futures-indicators-boll) |
| Moving Average Convergence Divergence (MACD) | [Link](./rest/Indic/Futures/futures-indicators-macd.md) | [Link](https://docs.coinglass.com/reference/futures-indicators-macd) |
| Futures Basis                                | [Link](./rest/Indic/Futures/basis.md)                   | [Link](https://docs.coinglass.com/reference/basis)                   |
| Whale Index                                  | [Link](./rest/Indic/Futures/whale-index.md)             | [Link](https://docs.coinglass.com/reference/whale-index)             |
| CGDI Index                                   | [Link](./rest/Indic/Futures/cgdi-index.md)              | [Link](https://docs.coinglass.com/reference/cgdi-index)              |
| CDRI Index                                   | [Link](./rest/Indic/Futures/cdri-index.md)              | [Link](https://docs.coinglass.com/reference/cdri-index)              |

## Indic - Spots

| Name                       | github                                                   | docs                                                                    |
| -------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------- |
| Coinbase Premium Index     | [Link](./rest/Indic/Spots/coinbase-premium-index.md)     | [Link](https://docs.coinglass.com/reference/coinbase-premium-index)     |
| Bitfinex Margin Long/Short | [Link](./rest/Indic/Spots/bitfinex-margin-long-short.md) | [Link](https://docs.coinglass.com/reference/bitfinex-margin-long-short) |
| Borrow Interest Rate       | [Link](./rest/Indic/Spots/borrow-interest-rate.md)       | [Link](https://docs.coinglass.com/reference/borrow-interest-rate)       |

## Indic - Other

| Name                                     | github                                                                 | docs                                                                                  |
| ---------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| AHR999                                   | [Link](./rest/Indic/Other/ahr999.md)                                   | [Link](https://docs.coinglass.com/reference/ahr999)                                   |
| Bull Market Peak Indicators              | [Link](./rest/Indic/Other/bull-market-peak-indicator.md)               | [Link](https://docs.coinglass.com/reference/bull-market-peak-indicator)               |
| Puell-Multiple                           | [Link](./rest/Indic/Other/puell-multiple.md)                           | [Link](https://docs.coinglass.com/reference/puell-multiple)                           |
| Stock-to-Flow Model                      | [Link](./rest/Indic/Other/stock-flow.md)                               | [Link](https://docs.coinglass.com/reference/stock-flow)                               |
| Pi Cycle Top Indicator                   | [Link](./rest/Indic/Other/pi.md)                                       | [Link](https://docs.coinglass.com/reference/pi)                                       |
| Golden-Ratio-Multiplier                  | [Link](./rest/Indic/Other/golden-ratio-multiplier.md)                  | [Link](https://docs.coinglass.com/reference/golden-ratio-multiplier)                  |
| Bitcoin Profitable Days                  | [Link](./rest/Indic/Other/bitcoin-profitable-days.md)                  | [Link](https://docs.coinglass.com/reference/bitcoin-profitable-days)                  |
| Bitcoin-Rainbow-Chart                    | [Link](./rest/Indic/Other/bitcoin-rainbow-chart.md)                    | [Link](https://docs.coinglass.com/reference/bitcoin-rainbow-chart)                    |
| Crypto Fear & Greed Index                | [Link](./rest/Indic/Other/cryptofear-greedindex.md)                    | [Link](https://docs.coinglass.com/reference/cryptofear-greedindex)                    |
| StableCoin MarketCap History             | [Link](./rest/Indic/Other/stablecoin-marketcap-history.md)             | [Link](https://docs.coinglass.com/reference/stablecoin-marketcap-history)             |
| Bitcoin Bubble Index                     | [Link](./rest/Indic/Other/bitcoin-bubble-index.md)                     | [Link](https://docs.coinglass.com/reference/bitcoin-bubble-index)                     |
| Tow Year Ma Multiplier                   | [Link](./rest/Indic/Other/tow-year-ma-multiplier.md)                   | [Link](https://docs.coinglass.com/reference/tow-year-ma-multiplier)                   |
| 200-Week Moving Avg Heatmap              | [Link](./rest/Indic/Other/tow-hundred-week-moving-avg-heatmap.md)      | [Link](https://docs.coinglass.com/reference/tow-hundred-week-moving-avg-heatmap)      |
| Altcoin Season Index                     | [Link](./rest/Indic/Other/altcoin-season-index.md)                     | [Link](https://docs.coinglass.com/reference/altcoin-season-index)                     |
| Bitcoin Short Term Holder SOPR           | [Link](./rest/Indic/Other/bitcoin-short-term-holder-sopr.md)           | [Link](https://docs.coinglass.com/reference/bitcoin-short-term-holder-sopr)           |
| Bitcoin Long Term Holder SOPR            | [Link](./rest/Indic/Other/bitcoin-long-term-holder-sopr.md)            | [Link](https://docs.coinglass.com/reference/bitcoin-long-term-holder-sopr)            |
| Bitcoin Short Term Holder Realized Price | [Link](./rest/Indic/Other/bitcoin-short-term-holder-realized-price.md) | [Link](https://docs.coinglass.com/reference/bitcoin-short-term-holder-realized-price) |
| Bitcoin Long Term Holder Realized Price  | [Link](./rest/Indic/Other/bitcoin-long-term-holder-realized-price.md)  | [Link](https://docs.coinglass.com/reference/bitcoin-long-term-holder-realized-price)  |
| Bitcoin Short Term Holder Supply         | [Link](./rest/Indic/Other/bitcoin-short-term-holder-supply.md)         | [Link](https://docs.coinglass.com/reference/bitcoin-short-term-holder-supply)         |
| Bitcoin Long Term Holder Supply          | [Link](./rest/Indic/Other/bitcoin-long-term-holder-supply.md)          | [Link](https://docs.coinglass.com/reference/bitcoin-long-term-holder-supply)          |
| Bitcoin RHODL Ratio                      | [Link](./rest/Indic/Other/bitcoin-rhodl-ratio.md)                      | [Link](https://docs.coinglass.com/reference/bitcoin-rhodl-ratio)                      |
| Bitcoin Reserve Risk                     | [Link](./rest/Indic/Other/bitcoin-reserve-risk.md)                     | [Link](https://docs.coinglass.com/reference/bitcoin-reserve-risk)                     |
| Bitcoin Active Addresses                 | [Link](./rest/Indic/Other/bitcoin-active-addresses.md)                 | [Link](https://docs.coinglass.com/reference/bitcoin-active-addresses)                 |
| Bitcoin New Addresses                    | [Link](./rest/Indic/Other/bitcoin-new-addresses.md)                    | [Link](https://docs.coinglass.com/reference/bitcoin-new-addresses)                    |
| Bitcoin Net Unrealized PNL               | [Link](./rest/Indic/Other/bitcoin-net-unrealized-profitloss-nupl.md)   | [Link](https://docs.coinglass.com/reference/bitcoin-net-unrealized-profitloss-nupl)   |
| Bitcoin Correlations                     | [Link](./rest/Indic/Other/btc-correlations-gld-iwm-qqq-spy-tlt.md)     | [Link](https://docs.coinglass.com/reference/btc-correlations-gld-iwm-qqq-spy-tlt)     |
| Bitcoin Macro Oscillator (BMO)           | [Link](./rest/Indic/Other/bitcoin-macro-oscillator-bmo.md)             | [Link](https://docs.coinglass.com/reference/bitcoin-macro-oscillator-bmo)             |
| Options/Futures OI Ratio                 | [Link](./rest/Indic/Other/optionsfutures-oi-ratio.md)                  | [Link](https://docs.coinglass.com/reference/optionsfutures-oi-ratio)                  |
| Bitcoin vs Global M2 Supply & Growth     | [Link](./rest/Indic/Other/bitcoin-vs-global-m2-supply-growth.md)       | [Link](https://docs.coinglass.com/reference/bitcoin-vs-global-m2-supply-growth)       |
| Bitcoin vs US M2 Supply & Growth         | [Link](./rest/Indic/Other/bitcoin-vs-us-m2-supply-growth.md)           | [Link](https://docs.coinglass.com/reference/bitcoin-vs-us-m2-supply-growth)           |
| Bitcoin Dominance                        | [Link](./rest/Indic/Other/bitcoin-dominance.md)                        | [Link](https://docs.coinglass.com/reference/bitcoin-dominance)                        |
| Exchanges Assets Transparency            | [Link](./rest/Indic/Other/exchanges-assets-transparency.md)            | [Link](https://docs.coinglass.com/reference/exchanges-assets-transparency)            |
| Futures vs Spot Volume Ratio             | [Link](./rest/Indic/Other/futures-spot-volume-ratio.md)                | [Link](https://docs.coinglass.com/reference/futures-spot-volume-ratio)                |

## Other - Financial Calendar

| Name          | github                                                   | docs                                                       |
| ------------- | -------------------------------------------------------- | ---------------------------------------------------------- |
| Economic Data | [Link](./rest/Other/Financial-Calendar/economic-data.md) | [Link](https://docs.coinglass.com/reference/economic-data) |

## Other - News

| Name | github                                    | docs                                                      |
| ---- | ----------------------------------------- | --------------------------------------------------------- |
| News | [Link](./rest/Other/News/article-list.md) | [Link](https://docs.coinglass.com/reference/article-list) |

# Rest API for CoinGass
# Futures - Trading Market - Supported Coins


```
GET /api/futures/supported-coins
```


This endpoint allows you to query all the supported coins on CoinGlass

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

##

**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
      "BTC",
      "ETH",
      "SOL",
      "XRP",
      ...
  ]
}
```


# Futures - Trading Market - Supported Exchanges


```
GET /api/futures/supported-exchanges
```


This endpoint allows you to query all the supported exchanges on CoinGlass

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

##

**Response Data:**

```json
{
  "code": "0",
  "data": [
    "OKX",
    "Binance",
    "HTX",
    "Bitmex",
    "Bitfinex",
    "Bybit",
    "Deribit",
    "Gate",
    "Kraken",
    "KuCoin",
    "CME",
    "Bitget",
    "dYdX",
    "CoinEx",
    "BingX",
    "Coinbase",
    "Gemini",
    "Crypto.com",
    "Hyperliquid",
    "Bitunix",
    "MEXC",
    "WhiteBIT",
    "Aster",
    "Lighter",
    "EdgeX",
    "Drift",
    "Paradex",
    "Extended",
    "ApeX Omni"
  ]
}
```


# Futures - Trading Market - Supported Exchange and Pairs


```
GET /api/futures/supported-exchange-pairs
```


Check the supported exchange and trading pairs in the API documentation

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "Binance": [ // exchange name
      {
        "instrument_id": "BTCUSD_PERP",// futures pair
        "base_asset": "BTC",// base asset
        "quote_asset": "USD"// quote asset
      },
      {
        "instrument_id": "BTCUSD_250627",
        "base_asset": "BTC",
        "quote_asset": "USD"
      },
      ....
      ],
    "Bitget": [
      {
        "instrument_id": "BTCUSDT_UMCBL",
        "base_asset": "BTC",
        "quote_asset": "USDT"
      },
      {
        "instrument_id": "ETHUSDT_UMCBL",
        "base_asset": "ETH",
        "quote_asset": "USDT"
      },
      ...
      ]
      ...
   }
}
```

 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                   |
| -------- | ------ | --------- | ----------------------------------------------------------------------------- |
| exchange | string | NO        | Filters the results to return only trading pairs from the specified exchange. |


# Futures - Trading Market - Coins Markets


```
GET /api/futures/coins-markets
```


This endpoint provides performance-related metrics for all available futures coins

<TitleSetter title="Get Futures Coins Markets Data | CoinGlass API" />

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                                        |
| ------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | NO        | Comma-separated exchange names (e.g., "binance, okx, bybit"). Retrieve supported exchanges via the 'supported-exchange-pairs' API. |
| per_page      | integer | NO        | Number of results per page.                                                                                                        |
| page          | integer | NO        | Page number for pagination, default: 1.                                                                                            |


**Response Data:**

```json
{
  "code": "0",  
  "msg": "success",  
  "data": [
    {
      "symbol": "BTC",  // Cryptocurrency symbol
      "current_price": 84773.6,  // Current price (in USD)
      "avg_funding_rate_by_oi": 0.00196,  // Average funding rate weighted by open interest
      "avg_funding_rate_by_vol": 0.002647,  // Average funding rate weighted by volume
      "market_cap_usd": 1683310500117.051,  // Market capitalization (in USD)
      "open_interest_market_cap_ratio": 0.0327,  // Ratio of open interest to market capitalization
      "open_interest_usd": 55002072334.9376,  // Open interest (in USD)
      "open_interest_quantity": 648525.0328,  // Open interest quantity (number of contracts)
      "open_interest_volume_ratio": 0.7936,  // Ratio of open interest to volume
      "price_change_percent_5m": -0.02,  // Price change percentage in the last 5 minutes
      "price_change_percent_15m": 0.06,  // Price change percentage in the last 15 minutes
      "price_change_percent_30m": 0.03,  // Price change percentage in the last 30 minutes
      "price_change_percent_1h": -0.1,  // Price change percentage in the last 1 hour
      "price_change_percent_4h": -0.15,  // Price change percentage in the last 4 hours
      "price_change_percent_12h": 0.15,  // Price change percentage in the last 12 hours
      "price_change_percent_24h": 1.06,  // Price change percentage in the last 24 hours
      "open_interest_change_percent_5m": 0,  // Open interest change percentage in the last 5 minutes
      "open_interest_change_percent_15m": 0.04,  // Open interest change percentage in the last 15 minutes
      "open_interest_change_percent_30m": 0,  // Open interest change percentage in the last 30 minutes
      "open_interest_change_percent_1h": -0.01,  // Open interest change percentage in the last 1 hour
      "open_interest_change_percent_4h": 0.17,  // Open interest change percentage in the last 4 hours
      "open_interest_change_percent_24h": 4.58,  // Open interest change percentage in the last 24 hours
      "volume_change_percent_5m": -0.03,  // Volume change percentage in the last 5 minutes
      "volume_change_percent_15m": -0.73,  // Volume change percentage in the last 15 minutes
      "volume_change_percent_30m": -1.13,  // Volume change percentage in the last 30 minutes
      "volume_change_percent_1h": -2.33,  // Volume change percentage in the last 1 hour
      "volume_change_percent_4h": -5.83,  // Volume change percentage in the last 4 hours
      "volume_change_percent_24h": -26.38,  // Volume change percentage in the last 24 hours
      "volume_change_usd_1h": 69310404660.3795,  // Volume change in USD in the last 1 hour
      "volume_change_usd_4h": -4290959532.4414644,  // Volume change in USD in the last 4 hours
      "volume_change_usd_24h": -24835757605.82467,  // Volume change in USD in the last 24 hours
      "long_short_ratio_5m": 1.2523,  // Long/short ratio in the last 5 minutes
      "long_short_ratio_15m": 0.9928,  // Long/short ratio in the last 15 minutes
      "long_short_ratio_30m": 1.0695,  // Long/short ratio in the last 30 minutes
      "long_short_ratio_1h": 1.0068,  // Long/short ratio in the last 1 hour
      "long_short_ratio_4h": 1.0504,  // Long/short ratio in the last 4 hours
      "long_short_ratio_12h": 1.0317,  // Long/short ratio in the last 12 hours
      "long_short_ratio_24h": 1.0313,  // Long/short ratio in the last 24 hours
      "liquidation_usd_1h": 33621.85192,  // Total liquidation amount in USD in the last 1 hour
      "long_liquidation_usd_1h": 22178.4681,  // Long liquidation amount in USD in the last 1 hour
      "short_liquidation_usd_1h": 11443.38382,  // Short liquidation amount in USD in the last 1 hour
      "liquidation_usd_4h": 222210.47117,  // Total liquidation amount in USD in the last 4 hours
      "long_liquidation_usd_4h": 179415.77249,  // Long liquidation amount in USD in the last 4 hours
      "short_liquidation_usd_4h": 42794.69868,  // Short liquidation amount in USD in the last 4 hours
      "liquidation_usd_12h": 11895453.392145,  // Total liquidation amount in USD in the last 12 hours
      "long_liquidation_usd_12h": 10223351.23772,  // Long liquidation amount in USD in the last 12 hours
      "short_liquidation_usd_12h": 1672102.154425,  // Short liquidation amount in USD in the last 12 hours
      "liquidation_usd_24h": 27519292.973646,  // Total liquidation amount in USD in the last 24 hours
      "long_liquidation_usd_24h": 17793322.595016,  // Long liquidation amount in USD in the last 24 hours
      "short_liquidation_usd_24h": 9725970.37863  // Short liquidation amount in USD in the last 24 hours
    },
    {
      "symbol": "ETH",  // Cryptocurrency symbol
      "current_price": 1582.55,  // Current price (in USD)
      "avg_funding_rate_by_oi": 0.001631,  // Average funding rate weighted by open interest
      "avg_funding_rate_by_vol": -0.000601,  // Average funding rate weighted by volume
      "market_cap_usd": 190821695398.62064,  // Market capitalization (in USD)
      "open_interest_market_cap_ratio": 0.0925,  // Ratio of open interest to market capitalization
      "open_interest_usd": 17657693967.0459,  // Open interest (in USD)
      "open_interest_quantity": 11160428.5065,  // Open interest quantity (number of contracts)
      "open_interest_volume_ratio": 0.5398,  // Ratio of open interest to volume
      "price_change_percent_5m": 0.07,  // Price change percentage in the last 5 minutes
      "price_change_percent_15m": 0.25,  // Price change percentage in the last 15 minutes
      "price_change_percent_30m": 0.07,  // Price change percentage in the last 30 minutes
      "price_change_percent_1h": -0.11,  // Price change percentage in the last 1 hour
      "price_change_percent_4h": -0.05,  // Price change percentage in the last 4 hours
      "price_change_percent_12h": -0.02,  // Price change percentage in the last 12 hours
      "price_change_percent_24h": 0.16  // Price change percentage in the last 24 hours
      // ... subsequent fields follow in a similar manner
    }
  ]
}

```


# Futures - Trading Market - Pairs Markets


```
GET /api/futures/pairs-markets
```


This endpoint provides performance-related metrics for all available futures trading pairs

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                      |
| ------ | ------ | --------- | -------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC).Retrieve supported coins via the 'supported-coins' API. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "instrument_id": "BTCUSDT", // Futures trading pair
      "exchange_name": "Binance", // Exchange name
      "symbol": "BTC/USDT", // Trading pair symbol

      "current_price": 84604.3, // Current price
      "index_price": 84646.66222222, // Index price
      "price_change_percent_24h": 0.67, // 24h price change (%)

      "volume_usd": 11317580109.5041, // 24h trading volume (USD)
      "volume_usd_change_percent_24h": -32.13, // 24h volume change (%)

      "long_volume_usd": 5800829746.047, // Long trade volume (USD)
      "short_volume_usd": 5516750363.4571, // Short trade volume (USD)
      "long_volume_quantity": 1130850, // Number of long trades
      "short_volume_quantity": 1162710, // Number of short trades

      "open_interest_quantity": 77881.234, // Open interest quantity (contracts)
      "open_interest_usd": 6589095073.8296, // Open interest value (USD)
      "open_interest_change_percent_24h": 1.9, // 24h open interest change (%)

      "long_liquidation_usd_24h": 3654182.12, // Long liquidations in past 24h (USD)
      "short_liquidation_usd_24h": 4099047.79, // Short liquidations in past 24h (USD)

      "funding_rate": 0.002007, // Current funding rate
      "next_funding_time": 1744963200000, // Next funding time (timestamp)

      "open_interest_volume_radio": 0.5822, // Open interest to volume ratio
      "oi_vol_ratio_change_percent_24h": 50.13 // 24h ratio change (%)
    },
    {
      "instrument_id": "BTC_USDT", // Futures trading pair
      "exchange_name": "Gate.io", // Exchange name
      "symbol": "BTC/USDT", // Trading pair symbol

      "current_price": 84616.3, // Current price
      "index_price": 84643.36, // Index price
      "price_change_percent_24h": 0.69, // 24h price change (%)

      "volume_usd": 1711484049.255, // 24h trading volume (USD)
      "volume_usd_change_percent_24h": -67.03, // 24h volume change (%)

      "long_volume_usd": 870432407.5966, // Long trade volume (USD)
      "short_volume_usd": 841051641.6584, // Short trade volume (USD)
      "long_volume_quantity": 210027, // Number of long trades
      "short_volume_quantity": 218777, // Number of short trades

      "open_interest_quantity": 69477.278, // Open interest quantity (contracts)
      "open_interest_usd": 5878785139.331, // Open interest value (USD)
      "open_interest_change_percent_24h": 3.82, // 24h open interest change (%)

      "long_liquidation_usd_24h": 1502896.68, // Long liquidations in past 24h (USD)
      "short_liquidation_usd_24h": 1037959.7, // Short liquidations in past 24h (USD)

      "funding_rate": 0.0022, // Current funding rate

      "open_interest_volume_radio": 3.4349, // Open interest to volume ratio
      "oi_vol_ratio_change_percent_24h": 214.93 // 24h ratio change (%)
    }
  ]
}

```


# Futures - Trading Market - Coins Price Change


```
GET /api/futures/coins-price-change
```


This endpoint provides percentage price changes and amplitude data for all supported coins across multiple timeframes.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "BTC", // Symbol
      "current_price": 84518.4, // Current price

      "price_change_percent_5m": -0.04, // 5m change (%)
      "price_change_percent_15m": -0.09, // 15m change (%)
      "price_change_percent_30m": -0.11, // 30m change (%)
      "price_change_percent_1h": -0.17, // 1h change (%)
      "price_change_percent_4h": -0.54, // 4h change (%)
      "price_change_percent_12h": -0.6, // 12h change (%)
      "price_change_percent_24h": 0.24, // 24h change (%)

      "price_amplitude_percent_5m": 0.07, // 5m amplitude (%)
      "price_amplitude_percent_15m": 0.16, // 15m amplitude (%)
      "price_amplitude_percent_30m": 0.18, // 30m amplitude (%)
      "price_amplitude_percent_1h": 0.26, // 1h amplitude (%)
      "price_amplitude_percent_4h": 0.63, // 4h amplitude (%)
      "price_amplitude_percent_12h": 1.17, // 12h amplitude (%)
      "price_amplitude_percent_24h": 2.06 // 24h amplitude (%)
    },
    {
      "symbol": "ETH", // Symbol
      "current_price": 1573.45, // Current price

      "price_change_percent_5m": -0.04, // 5m change (%)
      "price_change_percent_15m": -0.34, // 15m change (%)
      "price_change_percent_30m": -0.38, // 30m change (%)
      "price_change_percent_1h": -0.54, // 1h change (%)
      "price_change_percent_4h": -0.77, // 4h change (%)
      "price_change_percent_12h": -1.99, // 12h change (%)
      "price_change_percent_24h": -1.41, // 24h change (%)

      "price_amplitude_percent_5m": 0.13, // 5m amplitude (%)
      "price_amplitude_percent_15m": 0.4, // 15m amplitude (%)
      "price_amplitude_percent_30m": 0.47, // 30m amplitude (%)
      "price_amplitude_percent_1h": 0.66, // 1h amplitude (%)
      "price_amplitude_percent_4h": 0.9, // 4h amplitude (%)
      "price_amplitude_percent_12h": 2.74, // 12h amplitude (%)
      "price_amplitude_percent_24h": 3.47 // 24h amplitude (%)
    }
  ]
}

```


# Futures - Trading Market - Price History (OHLC)


```
GET /api/futures/price/history
```


This endpoint provides historical open, high, low, and close (OHLC) price data for cryptocurrencies over specified timeframes.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                       |
| ---------- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       |  Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Check supported pairs through the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w.              |
| limit      | integer | YES       | Number of results per request. Default: 1000, Maximum: 1000.                                                      |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                            |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                              |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1745366400000,
      "open": "93404.9",
      "high": "93864.9",
      "low": "92730",
      "close": "92858.2",
      "volume_usd": "1166471854.3026"
    },
    {
      "time": 1745370000000,
      "open": "92858.2",
      "high": "93464.8",
      "low": "92552",
      "close": "92603.8",
      "volume_usd": "871812560.3437"
    },
    ...
 ]
}    
    
    
```


# Futures - Trading Market - Delisted Pairs


```
GET /api/futures/delisted-exchange-pairs
```


This endpoint allows you to query all delisted trading pairs.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "Binance": [ // exchange name
      {
        "instrument_id": "BTCUSD_PERP",// futures pair
        "base_asset": "BTC",// base asset
        "quote_asset": "USD"// quote asset
      },
      {
        "instrument_id": "BTCUSD_250627",
        "base_asset": "BTC",
        "quote_asset": "USD"
      },
      ....
      ],
    "Bitget": [
      {
        "instrument_id": "BTCUSDT_UMCBL",
        "base_asset": "BTC",
        "quote_asset": "USDT"
      },
      {
        "instrument_id": "ETHUSDT_UMCBL",
        "base_asset": "ETH",
        "quote_asset": "USDT"
      },
      ...
      ]
      ...
   }
}
```


# Futures - Trading Market - Exchange Rank


```
GET /api/futures/indicators/rsi
```


This endpoint provides a ranking list of futures exchanges on CoinGlass.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "exchange": "Binance",
      "open_interest_usd": 27564494330,
      "volume_usd": 54150896832,
      "liquidation_usd_24h": 58774453.06516198
    },
    {
      "exchange": "OKX",
      "open_interest_usd": 8586569027,
      "volume_usd": 22670494849,
      "liquidation_usd_24h": 19276388.77685
    },
  ]
}

```

 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 14 for RSI).             |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |


# Futures - Open Interest - History (OHLC)


```
GET /api/futures/open-interest/history
```


This endpoint provides open interest data in OHLC (open, high, low, close) candlestick format for futures trading pairs.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                       |
| ---------- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       |  Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT).  Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w          |
| limit      | integer | NO        | Number of results per request.  Default 1000, Max 1000                                                            |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                            |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                              |
| unit       | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.                                                       |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 2644845344000, // Timestamp (ms)
      "open": "2644845344",   // Open interest at interval start
      "high": "2692643311",   // Highest open interest during interval
      "low": "2576975597",    // Lowest open interest during interval
      "close": "2608846475"   // Open interest at interval end
    },
    {
      "time": 2608846475000, // Timestamp (ms)
      "open": "2608846475",  // Open interest at interval start
      "high": "2620807645",  // Highest open interest during interval
      "low": "2327236202",   // Lowest open interest during interval
      "close": "2340177420"  // Open interest at interval end
    },
    ....
  ]
}

```


# Futures - Open Interest - Aggregated History (OHLC)


```
GET /api/futures/open-interest/aggregated-history
```


This endpoint provides aggregated open interest data across exchanges in OHLC (open, high, low, close) candlestick format.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                              |
| ---------- | ------- | --------- | -------------------------------------------------------------------------------------------------------- |
| symbol     | string  | YES       | Trading coin (e.g., BTC).  Retrieve supported coins via the 'supported-coins' API.                       |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                   |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                     |
| unit       | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.                                              |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 2644845344000, // Timestamp (ms)
      "open": "2644845344",   // Open interest at interval start
      "high": "2692643311",   // Highest open interest during interval
      "low": "2576975597",    // Lowest open interest during interval
      "close": "2608846475"   // Open interest at interval end
    },
    {
      "time": 2608846475000, // Timestamp (ms)
      "open": "2608846475",  // Open interest at interval start
      "high": "2620807645",  // Highest open interest during interval
      "low": "2327236202",   // Lowest open interest during interval
      "close": "2340177420"  // Open interest at interval end
    },
    ....
  ]
}

```


# Futures - Open Interest - Aggregated Stablecoin Margin History (OHLC)


```
GET /api/futures/open-interest/aggregated-stablecoin-history
```


This endpoint provides aggregated stablecoin-margined open interest data in OHLC (open, high, low, close) candlestick format.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                                     |
| ------------- | ------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | Comma-separated exchange names (e.g., "Binance,OKX,Bybit"). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol        | string  | YES       | Trading coin (e.g., BTC).Retrieve supported coins via the 'supported-coins' API.                                                |
| interval      | string  | YES       | Time interval for data aggregation.Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w                          |
| limit         | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                                                     |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                                          |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 2644845344000, // Timestamp (ms)
      "open": "2644845344",   // Open interest at interval start
      "high": "2692643311",   // Highest open interest during interval
      "low": "2576975597",    // Lowest open interest during interval
      "close": "2608846475"   // Open interest at interval end
    },
    {
      "time": 2608846475000, // Timestamp (ms)
      "open": "2608846475",  // Open interest at interval start
      "high": "2620807645",  // Highest open interest during interval
      "low": "2327236202",   // Lowest open interest during interval
      "close": "2340177420"  // Open interest at interval end
    },
    ....
  ]
}

```


# Futures - Open Interest - Aggregated Coin Margin History (OHLC)


```
GET /api/futures/open-interest/aggregated-coin-margin-history
```


This endpoint provides aggregated coin-margined open interest data in OHLC (open, high, low, close) candlestick format.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                                     |
| ------------- | ------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | Comma-separated exchange names (e.g., "Binance,OKX,Bybit"). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol        | string  | YES       | Trading coin (e.g., BTC).Retrieve supported coins via the 'supported-coins' API.                                                |
| interval      | string  | YES       | Time interval for data aggregation.Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w                          |
| limit         | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                                    |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                                          |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 2644845344000, // Timestamp (ms)
      "open": "2644845344",   // Open interest at interval start
      "high": "2692643311",   // Highest open interest during interval
      "low": "2576975597",    // Lowest open interest during interval
      "close": "2608846475"   // Open interest at interval end
    },
    {
      "time": 2608846475000, // Timestamp (ms)
      "open": "2608846475",  // Open interest at interval start
      "high": "2620807645",  // Highest open interest during interval
      "low": "2327236202",   // Lowest open interest during interval
      "close": "2340177420"  // Open interest at interval end
    },
    ....
  ]
}

```


# Futures - Open Interest - Exchange List


```
GET /api/futures/open-interest/exchange-list
```


This endpoint provides open interest data for a specific coin across multiple exchanges.

***Cache / Update Frequency:*** 10 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                      |
| ------ | ------ | --------- | -------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC).Retrieve supported coins via the 'supported-coins' API. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "exchange": "All", // Exchange name; "All" means aggregated across all exchanges
      "symbol": "BTC", // Token symbol

      "open_interest_usd": 57437891724.5572, // Total open interest value in USD
      "open_interest_quantity": 659557.3064, // Total open interest quantity

      "open_interest_by_stable_coin_margin": 48920274435.15, // Open interest value in USD for stablecoin-margined futures
      "open_interest_quantity_by_coin_margin": 97551.2547, // Open interest quantity for coin-margined futures
      "open_interest_quantity_by_stable_coin_margin": 562006.0517, // Open interest quantity for stablecoin-margined futures

      "open_interest_change_percent_5m": 0.34, // Open interest change (%) in the last 5 minutes
      "open_interest_change_percent_15m": 0.59, // Open interest change (%) in the last 15 minutes
      "open_interest_change_percent_30m": 1.42, // Open interest change (%) in the last 30 minutes
      "open_interest_change_percent_1h": 2.27, // Open interest change (%) in the last 1 hour
      "open_interest_change_percent_4h": 2.95, // Open interest change (%) in the last 4 hours
      "open_interest_change_percent_24h": 0.9 // Open interest change (%) in the last 24 hours
    },
    {
      "exchange": "CME", // Exchange name
      "symbol": "BTC", // Token symbol

      "open_interest_usd": 12294999402.5, // Total open interest value in USD
      "open_interest_quantity": 141275.5, // Total open interest quantity

      "open_interest_by_stable_coin_margin": 12294999402.5, // Open interest value in USD for stablecoin-margined futures
      "open_interest_quantity_by_coin_margin": 0, // Open interest quantity for coin-margined futures
      "open_interest_quantity_by_stable_coin_margin": 141275.5, // Open interest quantity for stablecoin-margined futures

      "open_interest_change_percent_5m": 0.08, // Open interest change (%) in the last 5 minutes
      "open_interest_change_percent_15m": 0.14, // Open interest change (%) in the last 15 minutes
      "open_interest_change_percent_30m": 0.49, // Open interest change (%) in the last 30 minutes
      "open_interest_change_percent_1h": 1.13, // Open interest change (%) in the last 1 hour
      "open_interest_change_percent_4h": 2.4, // Open interest change (%) in the last 4 hours
      "open_interest_change_percent_24h": 2.08 // Open interest change (%) in the last 24 hours
    }
    ....
  ]
}

```


# Futures - Open Interest - Exchange History Chart


```
GET /api/futures/open-interest/exchange-history-chart
```


This endpoint retrieves historical open interest data for a specific cryptocurrency across exchanges, formatted for chart display.

***Cache / Update Frequency:*** 10 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                         |
| ------ | ------ | --------- | ----------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC).  Check supported coins through the 'supported-coins' API. |
| range  | string | YES       | Time range for the data (e.g., all, 1m, 15m, 1h, 4h, 12h).                          |
| unit   | string | NO        | Unit for the returned data, choose between 'usd' or 'coin'.                         |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "time_list": [1721649600000, ...], // List of timestamps (in milliseconds)
    "price_list": [67490.3, ...], // List of prices corresponding to each timestamp

    "data_map": { // Open interest data of futures from each exchange
      "Binance": [8018229234, ...], // Binance open interest (corresponds to time_list)
      "Bitmex": [395160842, ...] // BitMEX open interest (corresponds to time_list)
      // ...
    }
  }
}

```


# Futures - Funding Rate - History (OHLC)


```
GET /api/futures/funding-rate/history
```


This endpoint provides funding rate data in OHLC (open, high, low, close) candlestick format for futures trading pairs.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000000, // Timestamp (milliseconds)
      "open": "0.004603",     // Opening funding rate
      "high": "0.009388",     // Highest funding rate
      "low": "-0.005063",     // Lowest funding rate
      "close": "0.009229"     // Closing funding rate
    },
    {
      "time": 1658966400000, // Timestamp (milliseconds)
      "open": "0.009229",     // Opening funding rate
      "high": "0.01",         // Highest funding rate
      "low": "0.007794",      // Lowest funding rate
      "close": "0.01"         // Closing funding rate
    }
  ]
}

```


# Futures - Funding Rate - OI Weight History (OHLC)


```
GET /api/futures/funding-rate/oi-weight-history
```


This endpoint provides open interest-weighted funding rate data in OHLC (open, high, low, close) candlestick format for futures cryptocurrencies.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| symbol     | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                       |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in seconds (e.g., 1641522717000).                                                       |
| end_time   | integer | NO        | End timestamp in seconds (e.g., 1641522717000).                                                         |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000000, // Timestamp (milliseconds)
      "open": "0.004603",     // Opening funding rate
      "high": "0.009388",     // Highest funding rate
      "low": "-0.005063",     // Lowest funding rate
      "close": "0.009229"     // Closing funding rate
    },
    {
      "time": 1658966400000, // Timestamp (milliseconds)
      "open": "0.009229",     // Opening funding rate
      "high": "0.01",         // Highest funding rate
      "low": "0.007794",      // Lowest funding rate
      "close": "0.01"         // Closing funding rate
    }
  ]
}
```


# Futures - Funding Rate - Vol Weight History (OHLC)


```
GET /api/futures/funding-rate/vol-weight-history
```


This endpoint provides volume-weighted funding rate data in OHLC (open, high, low, close) candlestick format for futures cryptocurrencies.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| symbol     | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                       |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000000, // Timestamp (milliseconds)
      "open": "0.004603",     // Opening funding rate
      "high": "0.009388",     // Highest funding rate
      "low": "-0.005063",     // Lowest funding rate
      "close": "0.009229"     // Closing funding rate
    },
    {
      "time": 1658966400000, // Timestamp (milliseconds)
      "open": "0.009229",     // Opening funding rate
      "high": "0.01",         // Highest funding rate
      "low": "0.007794",      // Lowest funding rate
      "close": "0.01"         // Closing funding rate
    }
  ]
}
```


# Futures - Funding Rate - Exchange List


```
GET /api/futures/funding-rate/exchange-list
```


This endpoint provides funding rate data from exchanges.

***Cache / Update Frequency:*** 20 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "BTC", // Symbol
      "stablecoin_margin_list": [ // USDT/USD margin mode
        {
          "exchange": "Binance", // Exchange
          "funding_rate_interval": 8, // Funding rate interval (hours)
          "funding_rate": 0.007343, // Current funding rate
          "next_funding_time": 1745222400000 // Next funding time (milliseconds)
        },
        {
          "exchange": "OKX", // Exchange
          "funding_rate_interval": 8, // Funding rate interval (hours)
          "funding_rate": 0.00736901950628, // Current funding rate
          "next_funding_time": 1745222400000 // Next funding time (milliseconds)
        }
      ],
      "token_margin_list": [ // Coin-margined mode
        {
          "exchange": "Binance", // Exchange
          "funding_rate_interval": 8, // Funding rate interval (hours)
          "funding_rate": -0.001829, // Current funding rate
          "next_funding_time": 1745222400000 // Next funding time (milliseconds)
        }
      ]
    }
  ]
}

```


# Futures - Funding Rate - Cumulative Exchange List


```
GET /api/futures/funding-rate/accumulated-exchange-list
```


This endpoint provides cumulative funding rate data from exchanges.

***Cache / Update Frequency:*** 1 hour for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name  | Type   | Mandatory | Description                                       |
| ----- | ------ | --------- | ------------------------------------------------- |
| range | string | YES       | Time range for the data (e.g.,1d, 7d, 30d, 365d). |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "BTC", // Symbol
      "stablecoin_margin_list": [ // Accumulated funding rate for USDT/USD margin mode
        {
          "exchange": "BINANCE", // Exchange name
          "funding_rate": 0.001873 // Accumulated funding rate
        },
        {
          "exchange": "OKX", // Exchange name
          "funding_rate": 0.00775484 // Accumulated funding rate
        }
      ],

      "token_margin_list": [ // Accumulated funding rate for coin-margined mode
        {
          "exchange": "BINANCE", // Exchange name
          "funding_rate": -0.003149 // Accumulated funding rate
        }
      ]
    }
  ]
}

```


# Futures - Funding Rate - Arbitrage


```
GET /api/futures/funding-rate/arbitrage
```


This endpoint provides funding rate arbitrage data across exchanges for futures cryptocurrencies.

***Cache / Update Frequency:*** 20 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                               |
| ------------- | ------- | --------- | ------------------------------------------------------------------------- |
| usd           | integer | YES       | Investment principal for arbitrage (e.g., 10000).                         |
| exchange_list | string  | NO        | List of exchange names to retrieve data from (e.g.,  'Binance,OKX,Bybit') |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "SUPRA", // Token symbol
      "buy": { //  (lower funding rate)
        "exchange": "MEXC", // Exchange name
        "open_interest_usd": 848218.2833, // Open interest in USD on the exchange
        "funding_rate_interval": 4, // Funding rate interval (hours)
        "funding_rate": -0.994 // Current funding rate (%)
      },
      "sell": { //  (higher funding rate)
        "exchange": "Gate.io", // Exchange name
        "open_interest_usd": 448263.5072, // Open interest in USD on the exchange
        "funding_rate_interval": 4, // Funding rate interval (hours)
        "funding_rate": 0.005 // Current funding rate (%)
      },
      "apr": 2187.81, // Annual Percentage Rate (APR, %)
      "funding": 0.999, // Funding rate difference (between long and short)
      "fee": 0.03, // Total trading fee (both sides)
      "spread": -0.09, // Price spread between platforms (%)
      "next_funding_time": 1745222400000 // Next funding settlement time (timestamp in milliseconds)
    }
  ]
}

```


# Futures - Long-Short Ratio - Global Account Ratio


```
GET /api/futures/global-long-short-account-ratio/history
```


This endpoint provides the long/short account ratio history for trading pairs on a specific exchange.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741604400000, // Timestamp (in milliseconds)
      "global_account_long_percent": 73.88, // Long position percentage of accounts (%)
      "global_account_short_percent": 26.12, // Short position percentage of accounts (%)
      "global_account_long_short_ratio": 2.83 // Long/Short ratio of accounts
    },
    {
      "time": 1741608000000, // Timestamp (in milliseconds)
      "global_account_long_percent": 73.24, // Long position percentage of accounts (%)
      "global_account_short_percent": 26.76, // Short position percentage of accounts (%)
      "global_account_long_short_ratio": 2.74 // Long/Short ratio of accounts
    }
  ]
}

```


# Futures - Long-Short Ratio - Top Account Ratio History


```
GET /api/futures/top-long-short-account-ratio/history
```


This endpoint provides historical data for the long/short account ratio of top traders.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741615200000, // Timestamp (in milliseconds)
      "top_account_long_percent": 73.3, // Long position percentage of top accounts (%)
      "top_account_short_percent": 26.7, // Short position percentage of top accounts (%)
      "top_account_long_short_ratio": 2.75 // Long/Short ratio of top accounts
    },
    {
      "time": 1741618800000, // Timestamp (in milliseconds)
      "top_account_long_percent": 74.18, // Long position percentage of top accounts (%)
      "top_account_short_percent": 25.82, // Short position percentage of top accounts (%)
      "top_account_long_short_ratio": 2.87 // Long/Short ratio of top accounts
    }
  ]
}

```


# Futures - Long-Short Ratio - Top Position Ratio History


```
GET /api/futures/top-long-short-position-ratio/history
```


This endpoint provides historical data for the long/short position ratio of top traders.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741615200000, // Timestamp (in milliseconds)
      "top_position_long_percent": 64.99, // Long position percentage of top positions (%)
      "top_position_short_percent": 35.01, // Short position percentage of top positions (%)
      "top_position_long_short_ratio": 1.86 // Long/Short ratio of top positions
    },
    {
      "time": 1741618800000, // Timestamp (in milliseconds)
      "top_position_long_percent": 64.99, // Long position percentage of top positions (%)
      "top_position_short_percent": 35.01, // Short position percentage of top positions (%)
      "top_position_long_short_ratio": 1.86 // Long/Short ratio of top positions
    }
  ]
}

```


# Futures - Long-Short Ratio - Exchange Taker Buy/Sell Ratio


```
GET /api/futures/taker-buy-sell-volume/exchange-list
```


This endpoint provides the long/short ratio of aggregated taker buy/sell volumes across exchanges.

***Cache / Update Frequency:*** 1 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                        |
| ------ | ------ | --------- | ---------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC).  Retrieve supported coins via the 'supported-coins' API. |
| range  | string | YES       | Time range for the data (e.g., 5m, 15m, 30m, 1h, 4h,12h, 24h).                     |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "symbol": "BTC", // Token symbol
    "buy_ratio": 51.01, // Buy ratio (%)
    "sell_ratio": 48.99, // Sell ratio (%)
    "buy_vol_usd": 1112108532.1688, // Total buy volume (USD)
    "sell_vol_usd": 1068220541.0417, // Total sell volume (USD)
    "exchange_list": [ // Buy/sell data per exchange
      {
        "exchange": "Binance", // Exchange name
        "buy_ratio": 49.22, // Buy ratio (%)
        "sell_ratio": 50.78, // Sell ratio (%)
        "buy_vol_usd": 240077939.5811, // Buy volume (USD)
        "sell_vol_usd": 247674925.1653 // Sell volume (USD)
      },
      {
        "exchange": "OKX", // Exchange name
        "buy_ratio": 50.84, // Buy ratio (%)
        "sell_ratio": 49.16, // Sell ratio (%)
        "buy_vol_usd": 108435724.6214, // Buy volume (USD)
        "sell_vol_usd": 104834502.5904 // Sell volume (USD)
      }
    ]
  }
}

```


# Futures - Long-Short Ratio - Net Position


```
GET /api/spot/volume/footprint-history
```


This endpoint provides the historical net position data for futures, including the net_long_change and net_short_change values.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Spot exchange names (Supported Binance, OKX,Bybit,Hyperliquid)                                          |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.             |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "net_long_change": -478.43,
      "net_short_change": 0,
      "time": 1751652000000
    },
    {
      "net_long_change": -776.79,
      "net_short_change": 0,
      "time": 1751655600000
    },
}
```


# Futures - Long-Short Ratio - Net Position (v2)


```
GET /api/futures/v2/net-position/history
```


This endpoint provides the historical net position data for futures, including the net_long_change and net_short_change values.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Currently available for Binance exchange only.                                                          |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.           |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "net_long_change": -478.43,
      "net_short_change": 0,
      "time": 1751652000000
    },
    {
      "net_long_change": -776.79,
      "net_short_change": 0,
      "time": 1751655600000
    },
}
```


# Futures - Liquidation - Pair Liquidation History


```
GET /api/futures/liquidation/history
```


This endpoint provides historical data for long and short liquidations of a trading pair on the exchange.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000000, // Timestamp (milliseconds)
      "long_liquidation_usd": "2369935.19562", // Long position liquidation amount (USD)
      "short_liquidation_usd": "6947459.43674" // Short position liquidation amount (USD)
    },
    {
      "time": 1658966400000, // Timestamp (milliseconds)
      "long_liquidation_usd": "5118407.85124", // Long position liquidation amount (USD)
      "short_liquidation_usd": "8517330.44192" // Short position liquidation amount (USD)
    }
  ]
}

```


# Futures - Liquidation - Coin Liquidation History


```
GET /api/futures/liquidation/aggregated-history
```


This endpoint provides aggregated historical data for both long and short liquidations of a coin across multiple exchanges.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

<br />


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                              |
| ------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | List of exchange names to retrieve data from (e.g.,  'Binance, OKX, Bybit')                              |
| symbol        | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                        |
| interval      | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit         | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                             |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                   |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                     |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658966400000, // Timestamp (milliseconds) 
      "aggregated_long_liquidation_usd": 5916885.14234,//aggregated Long position liquidation amount (USD)
      "aggregated_short_liquidation_usd": 12969583.87632 //aggregated Short position liquidation amount (USD)
    },
    {
      "time": 1659052800000,  // Timestamp (milliseconds)
      "aggregated_long_liquidation_usd": 5345708.23191, //aggregated Long position liquidation amount (USD)
      "aggregated_short_liquidation_usd": 6454875.54909 //aggregated Short position liquidation amount (USD)
    },
  ]
}


```


# Futures - Liquidation - Liquidation Coin List


```
GET /api/futures/liquidation/coin-list
```


This endpoint provides liquidation data for all coins on a specific exchange.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                                      |
| -------- | ------ | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "BTC", // Token symbol
      "liquidation_usd_24h": 82280481.50425325, // Total liquidation amount in the past 24 hours (USD)
      "long_liquidation_usd_24h": 68437447.33734027, // Long position liquidation in the past 24 hours (USD)
      "short_liquidation_usd_24h": 13843034.16691298, // Short position liquidation in the past 24 hours (USD)

      "liquidation_usd_12h": 68331844.36224127, // Total liquidation in the past 12 hours
      "long_liquidation_usd_12h": 66614158.47451427, // Long liquidation (12h)
      "short_liquidation_usd_12h": 1717685.887727, // Short liquidation (12h)

      "liquidation_usd_4h": 11381137.080643, // Total liquidation in the past 4 hours
      "long_liquidation_usd_4h": 10921633.272973, // Long liquidation (4h)
      "short_liquidation_usd_4h": 459503.80767, // Short liquidation (4h)

      "liquidation_usd_1h": 3283635.95309, // Total liquidation in the past 1 hour
      "long_liquidation_usd_1h": 3182915.16289, // Long liquidation (1h)
      "short_liquidation_usd_1h": 100720.7902 // Short liquidation (1h)
    }
  ]
}

```


# Futures - Liquidation - Liquidation Exchange List


```
GET /api/futures/liquidation/exchange-list
```


This endpoint provides liquidation data for a specific coin across all exchanges.

***Cache / Update Frequency:*** 10 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                        |
| ------ | ------ | --------- | ---------------------------------------------------------------------------------- |
| symbol | string | NO        | Trading coin (e.g., BTC).  Retrieve supported coins via the 'supported-coins' API. |
| range  | string | YES       | Time range for data aggregation.  Supported values: 1h, 4h, 12h, 24h.              |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "exchange": "All", // Total data from all exchanges
      "liquidation_usd": 14673519.81739075, // Total liquidation amount (USD)
      "long_liquidation_usd": 451394.17404598, // Long position liquidation amount (USD)
      "short_liquidation_usd": 14222125.64334477 // Short position liquidation amount (USD)
    },
    {
      "exchange": "Bybit", // Exchange name
      "liquidation_usd": 4585290.13404, // Total liquidation amount (USD)
      "long_liquidation_usd": 104560.13885, // Long position liquidation (USD)
      "short_liquidation_usd": 4480729.99519 // Short position liquidation (USD)
    }
  ]
}

```


# Futures - Liquidation - Liquidation Order


```
GET /api/futures/liquidation/order
```


This endpoint provides liquidation order data from the past 7 days, including exchange, trading pair, and liquidation amount details.

***Cache / Update Frequency:*** 1 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name                   | Type    | Mandatory | Description                                                                                             |
| ---------------------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange               | string  | YES       | Exchange name (e.g., Binance, OKX). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol                 | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                       |
| min_liquidation_amount | string  | YES       | Minimum threshold for liquidation events.  Max 200 records per request.                                 |
| start_time             | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time               | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "exchange_name": "BINANCE", // Exchange name
      "symbol": "BTCUSDT", // Trading pair symbol
      "base_asset": "BTC", // Base asset
      "price": 87535.9, // Liquidation price
      "usd_value": 205534.2932, // Transaction amount (USD)
      "side": 2, // Order direction (1: Buy, 2: Sell)
      "time": 1745216319263 // Timestamp
    },
    {
      "exchange_name": "BINANCE", // Exchange name
      "symbol": "BTCUSDT", // Trading pair symbol
      "base_asset": "BTC", // Base asset
      "price": 87465.2, // Liquidation price
      "usd_value": 15918.6664, // Transaction amount (USD)
      "side": 2, // Order direction (1: Buy, 2: Sell)
      "time": 1745215647165 // Timestamp
    }
  ]
}

```


# Futures - Liquidation - Pair Liquidation Heatmap Model1


```
GET /api/futures/liquidation/heatmap/model1
```


This endpoint provides liquidation levels on a heatmap chart for trading pairs, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                             |
| -------- | ------ | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance, OKX). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol   | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.           |
| range    | string | YES       | Time range for data aggregation. Supported values: 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y.                |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage ]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}

```


# Futures - Liquidation - Pair Liquidation Heatmap Model2


```
GET /api/futures/liquidation/heatmap/model2
```


This endpoint provides liquidation levels on a heatmap chart for trading pairs, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                             |
| -------- | ------ | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name  eg. Binance ，OKX （ Check supported exchanges through the 'supported-exchange-pair' API.） |
| symbol   | string | YES       | Trading pair eg. BTCUSDT   （ Check supported pair through the 'supported-exchange-pair' API.）           |
| range    | string | YES       | 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y                                                                    |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}

```


# Futures - Liquidation - Pair Liquidation Heatmap Model3


```
GET /api/futures/liquidation/heatmap/model3
```


This endpoint provides liquidation levels on a heatmap chart for trading pairs, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                             |
| -------- | ------ | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance, OKX). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol   | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.           |
| range    | string | YES       | Time range for data aggregation. Supported values: 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y.                |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}

```


# Futures - Liquidation - Coin Liquidation Heatmap Model1


```
GET /api/futures/liquidation/aggregated-heatmap/model1
```


This endpoint provides aggregated liquidation levels on a heatmap chart, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                              |
| ------ | ------ | --------- | ---------------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.        |
| range  | string | YES       | Time range for data aggregation. Supported values: 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}
```


# Futures - Liquidation - Coin Liquidation Heatmap Model2


```
GET /api/futures/liquidation/aggregated-heatmap/model2
```


This endpoint provides aggregated liquidation levels on a heatmap chart, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                              |
| ------ | ------ | --------- | ---------------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.        |
| range  | string | YES       | Time range for data aggregation. Supported values: 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}
```


# Futures - Liquidation - Coin Liquidation Heatmap Model3


```
GET /api/futures/liquidation/aggregated-heatmap/model3
```


This endpoint provides aggregated liquidation levels on a heatmap chart, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                              |
| ------ | ------ | --------- | ---------------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.        |
| range  | string | YES       | Time range for data aggregation. Supported values: 12h, 24h, 3d, 7d, 30d, 90d, 180d, 1y. |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "y_axis": [47968.54, 48000.00, 48031.46], // Y-axis price levels
    "liquidation_leverage_data": [
      [5, 124, 2288867.26], // Each array: [X-axis index, Y-axis index, liquidation leverage]
      [6, 123, 318624.82],
      [7, 122, 1527940.12]
    ],
    "price_candlesticks": [
      [
        1722676500, // Timestamp (seconds)
        "61486",    // Open price
        "61596.4",  // High price
        "61434.4",  // Low price
        "61539.9",  // Close price
        "63753192.1129" // Trading volume (USD)
      ],
      [
        1722676800,
        "61539.9",
        "61610.0",
        "61480.0",
        "61590.5",
        "42311820.8720"
      ]
    ]
  }
}
```


# Futures - Liquidation - Pair Liquidation Map


```
GET /api/futures/liquidation/map
```


This endpoint provides a mapped visualization of liquidation events for trading pairs, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                        |
| -------- | ------ | --------- | -------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol   | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.      |
| range    | string | YES       | Time range for data aggregation. Supported values: 1d, 7d, 30d.                                    |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": 
  {
    "data": 
    {
      "48935": //liquidation price
      [
        [
          48935,//liquidation price
          1579370.77,//Liquidation Level
          25,//Leverage Ratio
          null
        ]
      ],
      ...  
    }
  }
}
```


# Futures - Liquidation - Coin Liquidation Map


```
GET /api/futures/liquidation/aggregated-map
```


This endpoint provides a mapped visualization of aggregated liquidation events for coins, calculated based on market data and liquidation leverage levels.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                       |
| ------ | ------ | --------- | --------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API. |
| range  | string | YES       | Time range for data aggregation. Supported values: 1d, 7d, 30d.                   |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": 
  {
    "data": 
    {
      "48935": //liquidation price
      [
        [
          48935,//liquidation price
          1579370.77,//Liquidation Level
          null,
          null
        ]
      ],
      ...  
    }
  }
}
```


# Futures - Liquidation - Liquidation Max Pain


```
GET /api/futures/liquidation/max-pain
```


This endpoint provides key liquidation “max-pain” price for major cryptocurrencies, indicating potential pressure zones between current and liquidation prices.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name  | Type   | Mandatory | Description                                                                           |
| ----- | ------ | --------- | ------------------------------------------------------------------------------------- |
| range | string | NO        | Time interval for data aggregation. Supported values: 12h, 24h, 48h, 3d, 7d, 14d, 30d |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "symbol": "BTC",
      "price": 110625.1, //symbol price
      "long_max_pain_liq_level": 75677278.26,//long max pain liquidation level
      "long_max_pain_liq_price": 113046.71, //long max pain luquidation price
      "short_max_pain_liq_level": 44617473.19,
      "short_max_pain_liq_price": 109748.37
    
    {
      "symbol": "ETH",
      "price": 3914.14,
      "long_max_pain_liq_level": 34406421.23,
      "long_max_pain_liq_price": 3955.722,
      "short_max_pain_liq_level": 44375943.61,
      "short_max_pain_liq_price": 3820.002
    },
    {
      "symbol": "SOL",
      "price": 195.1,
      "long_max_pain_liq_level": 12467317.12,
      "long_max_pain_liq_price": 199.468,
      "short_max_pain_liq_level": 12927647.29,
      "short_max_pain_liq_price": 190.186
    },
    ....
  ]
}

```


# Futures - Order Book - Pair Orderbook Bid&Ask(±range)


```
GET /api/futures/orderbook/ask-bids-history
```


This endpoint provides historical data of the order book for futures trading, including total bid/ask volumes within a specific price range.

***Cache / Update Frequency:*** every 5 seconds for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                          |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API.   |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Check supported pairs through the 'supported-exchange-pair' API.       |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |
| range      | string  | NO        | Depth percentage (e.g., 0.25, 0.5, 0.75, 1, 2, 3, 5, 10).                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "bids_usd": 81639959.9338,        // Total long position amount (USD)
      "bids_quantity": 1276.645,        // Total long quantity
      "asks_usd": 78533053.6862,        // Total short position amount (USD)
      "asks_quantity": 1217.125,        // Total short quantity
      "time": 1714003200000             // Timestamp (in milliseconds)
    },
    {
      "bids_usd": 62345879.8821,
      "bids_quantity": 980.473,
      "asks_usd": 65918423.4715,
      "asks_quantity": 1021.644,
      "time": 1714089600000
    }
  ]
}

```


# Futures - Order Book - Coin Aggregated Orderbook Bid&Ask(±range)


```
GET /api/futures/orderbook/aggregated-ask-bids-history
```


This endpoint provides historical data of the aggregated order book for futures trading, including total bid/ask volumes within a specific price range.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                          |
| ------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | List of exchange names to retrieve data from (e.g., 'ALL', or 'Binance, OKX, Bybit')                 |
| symbol        | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                    |
| interval      | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit         | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |
| range         | string  | NO        | Depth percentage (e.g., 0.25, 0.5, 0.75, 1, 2, 3, 5, 10).                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "aggregated_bids_usd": 12679537.0806,         // Aggregated long amount (USD)
      "aggregated_bids_quantity": 197.99861,        // Aggregated long quantity
      "aggregated_asks_usd": 10985519.9268,         // Aggregated short amount (USD)
      "aggregated_asks_quantity": 170.382,          // Aggregated short quantity
      "time": 1714003200000                         // Timestamp (milliseconds)
    },
    {
      "aggregated_bids_usd": 18423845.1947,
      "aggregated_bids_quantity": 265.483,
      "aggregated_asks_usd": 17384271.5521,
      "aggregated_asks_quantity": 240.785,
      "time": 1714089600000
    }
  ]
}

```


# Futures - Order Book - Orderbook Heatmap


```
GET /api/futures/orderbook/history
```


This endpoint provides historical order book depth data for futures trading, supporting heatmap visualization.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                                |
| ---------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API.                         |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                              |
| interval   | string  | YES       | Time intervals for data aggregation. Supported values: 1m、3m、5m、15m、30m、1h、4h、6h、8h、12h、1d.                                |
| limit      | integer | YES       | Number of results per request. Default: 100, Maximum: 100.   Historical range – 1m: 3 days, 5m: 15 days, others: 150 days. |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1723625037000).                                                                     |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1723626037000).                                                                       |


**Response Data:**

```json
{
    "code": "0",
    "msg": "success",
    "data": [
        [
            1723611600,
            [
                [
                    56420, //Price
                    4.777 //Quantity
                ],
                [
                    40300,
                    2.191
                ]
            ],
            [
                [
                    56420,
                    4.777
                ],
                [
                    40300,
                    2.191
                ]
            ]
        ]
    ],
    "success": true
}
```


# Futures - Order Book - Large Orderbook


```
GET /api/futures/orderbook/large-limit-order
```


This endpoint provides large open limit orders from the current order book for futures trading.(thresholds: BTC ≥ 1M, ETH ≥ 500K, Other ≥ 50K)

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                        |
| -------- | ------ | --------- | -------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol   | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pair via the 'supported-exchange-pair' API.       |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data":[
  {
    "id": 2868159989,
    "exchange_name": "Binance",            // Exchange name
    "symbol": "BTCUSDT",                   // Trading pair
    "base_asset": "BTC",                   // Base asset
    "quote_asset": "USDT",                 // Quote asset

    "price": 56932,                  // Order price
    "start_time": 1722964242000,           // Order start time (ms)
    "start_quantity": 28.39774,            // Initial order quantity
    "start_usd_value": 1616740.1337,       // Initial USD value

    "current_quantity": 18.77405,          // Current remaining quantity
    "current_usd_value": 1068844.21,       // Current USD value
    "current_time": 1722964272000,         // Current time (ms)

    "executed_volume": 0,                  // Executed volume
    "executed_usd_value": 0,               // Executed USD value
    "trade_count": 0,                      // Number of trades

    "order_side": 2,                       // Order side: 1 - Sell, 2 - Buy
    "order_state": 1                       // Order state: 1 - Open, 2 - Filled, 3      - Canceled
    }
   ]
}
```


# Futures - Order Book - Large Orderbook History


```
GET /api/futures/orderbook/large-limit-order-history
```


This endpoint provides completed historical large limit orders from the order book for futures trading (thresholds: BTC ≥ 1M, ETH ≥ 500K, Other ≥ 50K)

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                        |
| ---------- | ------- | --------- | -------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Check supported pairs through the 'supported-exchange-pair' API.     |
| start_time | integer | YES       | Start timestamp in milliseconds (e.g., 1723625037000).                                             |
| end_time   | integer | YES       | End timestamp in milliseconds (e.g., 1723626037000).                                               |
| state      | integer | YES       | Status of the order —  1for ''In Progress''  2 for "Finish"  3 for "Revoke"                        |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "id": 2895605135,
      "exchange_name": "Binance",               // Exchange name
      "symbol": "BTCUSDT",                      // Trading pair
      "base_asset": "BTC",                      // Base asset
      "quote_asset": "USDT",                    // Quote asset
      "price": 89205.9,                         // Order price
      "start_time": 1745287309000,              // Order start time (milliseconds)
      "start_quantity": 25.779,                 // Initial order quantity
      "start_usd_value": 2299638.8961,          // Initial order value (USD)
      "current_quantity": 25.779,               // Remaining quantity
      "current_usd_value": 2299638.8961,        // Remaining value (USD)
      "current_time": 1745287309000,            // Current timestamp (milliseconds)
      "executed_volume": 0,                     // Executed volume
      "executed_usd_value": 0,                  // Executed value (USD)
      "trade_count": 0,                         // Number of trades executed
      "order_side": 1,                          // Order side: 1 = Sell, 2 = Buy
      "order_state": 2,                         // Order state: 0 = Not started, 1 = Open, 2 = Filled, 3 = Cancelled
      "order_end_time": 1745287328000           // Order end time (milliseconds)
    }
    ....
  ]
}

```


# Futures - Hyperliquid Positions - Hyperliquid Whale Alert


```
GET /api/hyperliquid/whale-alert
```


This endpoint provides real-time whale alerts on Hyperliquid, highlighting positions with a notional value over $1 million.(Returns up to approximately 200 most recent records)

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

<br />

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "user": "0x3fd4444154242720c0d0c61c74a240d90c127d33", // User address
      "symbol": "ETH",                                     // Symbol
      "position_size": 12700,                              // Position size (positive: long, negative: short)
      "entry_price": 1611.62,                              // Entry price
      "liq_price": 527.2521,                               // Liquidation price
      "position_value_usd": 21003260,                      // Position value (USD)
      "position_action": 2,                                // Position action type (1: open, 2: close)
      "create_time": 1745219517000                         // Entry time (timestamp in milliseconds)
    },
    {
      "user": "0x1cadadf0e884ac5527ae596a4fc1017a4ffd4e2c",
      "symbol": "BTC",
      "position_size": 33.54032,
      "entry_price": 87486.2,
      "liq_price": 44836.8126,
      "position_value_usd": 2936421.4757,
      "position_action": 2,
      "create_time": 1745219477000
    }
  ]
}

```


# Futures - Hyperliquid Positions - Hyperliquid Whale Position


```
GET /api/hyperliquid/whale-position
```


This endpoint provides whale positions on Hyperliquid with a notional value exceeding $1 million.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "user": "0x20c2d95a3dfdca9e9ad12794d5fa6fad99da44f5", // User address
      "symbol": "ETH",                                   // Token symbol
      "position_size": -44727.1273,                      // Position size (positive: long, negative: short)
      "entry_price": 2249.7,                             // Entry price
      "mark_price": 1645.8,                              // Current mark price
      "liq_price": 2358.2766,                            // Liquidation price
      "leverage": 25,                                    // Leverage
      "margin_balance": 2943581.7019,                    // Margin balance (USD)
      "position_value_usd": 73589542.5467,               // Position value (USD)
      "unrealized_pnl": 27033236.424,                    // Unrealized PnL (USD)
      "funding_fee": -3107520.7373,                      // Funding fee (USD)
      "margin_mode": "cross",                            // Margin mode (e.g., cross / isolated)
      "create_time": 1741680802000,                      // Entry time (timestamp in ms)
      "update_time": 1745219966000                       // Last updated time (timestamp in ms)
    },
    {
      "user": "0xf967239debef10dbc78e9bbbb2d8a16b72a614eb",
      "symbol": "BTC",
      "position_size": -800,
      "entry_price": 84931.3,
      "mark_price": 87427,
      "liq_price": 92263.798,
      "leverage": 15,
      "margin_balance": 4812076.3896,
      "position_value_usd": 69921600,
      "unrealized_pnl": -1976493.6819,
      "funding_fee": 14390.0346,
      "margin_mode": "isolated",
      "create_time": 1743982804000,
      "update_time": 1745219969000
    }
  ]
}

```


# Futures - Hyperliquid Positions - Hyperliquid Wallet Positions by Coin


```
GET /api/hyperliquid/position
```


This endpoint provides real-time wallet position data by coin on Hyperliquid, including user addresses, position size, margin balance, and unrealized PnL for each account.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name         | Type   | Mandatory | Description                                                                       |
| ------------ | ------ | --------- | --------------------------------------------------------------------------------- |
| symbol       | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API. |
| current_page | string | NO        | Current page number being returned                                                |


**Response Data:**

```json
{
  "code": "0",                     // Status code (0 = success)
  "data": {
    "total_pages": 10,          // Total pages of position data
    "current_page":1,   // Current page number being returned
    "list": [
      {
        "user": "0x5b5d51203a0f9079f8aeb098a6523a13f298c060",           //User Wallet address
        "symbol": "BTC",           // Symbol
        "position_size": -2683.14, // Position size (positive = long, negative = short)
        "entry_price": 111459.6,   // Entry price
        "mark_price": 116638,      // Current price
        "liq_price": 150629.52,    // Liquidation price
        "leverage": 10,            // Leverage
        "margin_balance": 31263482.07,        // Margin balance (USD)
        "position_value_usd": 312634820.77,   // Position value (USD)
        "unrealized_pnl": -13572345.06,       // Unrealized profit/loss (USD)
        "funding_fee": -12534553.66,          // Funding fee (USD)
        "margin_mode": "cross",               // Margin mode ("cross" or "isolated")
        "create_time": 1752152867098,         // Open time (timestamp)
        "update_time": 1758162698266          // Last update (timestamp)
      }
    ]
  }
}
```


# Futures - Hyperliquid Positions - Hyperliquid Wallet Positions by Address


```
GET /api/hyperliquid/user-position
```


This endpoint provides Hyperliquid user position data, including margin summaries, withdrawable balance, and open asset positions.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name         | Type   | Mandatory | Description  |
| ------------ | ------ | --------- | ------------ |
| user_address | string | YES       | User Address |


**Response Data:**

```json
{
  "code": "0",
  "data": {
    "margin_summary": {
      "account_value": 179250588.896754,
      "total_ntl_pos": 679947383.29435,
      "total_raw_usd": -500696794.397596,
      "total_margin_used": 131236726.65887
    },
    "cross_margin_summary": {
      "account_value": 179250588.896754,
      "total_ntl_pos": 679947383.29435,
      "total_raw_usd": -500696794.397596,
      "total_margin_used": 131236726.65887
    },
    "cross_maintenance_margin_used": 19278725.276478,
    "withdrawable": 46429612.237884,
    "asset_positions": [
      {
        "type": "oneWay",
        "position": {
          "coin": "BTC",
          "szi": 1000,
          "leverage": {
            "type": "cross",
            "value": 5
          },
          "entry_px": 91506.7,
          "position_value": 86265000,
          "unrealized_pnl": -5643767.29312,
          "return_on_equity": -0.3083797767,
          "max_leverage": 5,
          "cum_funding": {
            "all_time": -104732.177706,
            "since_open": 87958.233078,
            "since_change": 84811.539668
          }
        }
      },
      }
    ]
  }
}
```


# Futures - Hyperliquid Positions - Hyperliquid Wallet Positions Distribution


```
GET /api/hyperliquid/wallet/position-distribution
```


This endpoint provides real-time Hyperliquid wallet position distribution data, grouped by position size tiers, including address counts, long/short position values, sentiment indicators, and profit/loss distribution.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "data": [
  {
    "group_name": "Shrimp", // position tier label
    // shrimp | fish | dolphin | apex_predator | small_whale | whale | tidal_whale | leviathan

    "all_address_count": 260180, // total addresses
    "position_address_count": 20966, // addresses with positions
    "position_address_percent": 8.06, // position address %

    "bias_score": 0.99, // long/short bias score

    "bias_remark": "very_bullish", // sentiment label
    // bearish | slightly_bearish | indecisive | bullish | very_bullish

    "minimum_amount": 0, // min position range
    "maximum_amount": 250, // max position range

    "long_position_usd": 6270051.698175, // long position value
    "short_position_usd": 2382603.196539, // short position value
    "long_position_usd_percent": 72.46, // long value %
    "short_position_usd_percent": 27.54, // short value %

    "position_usd": 8652654.894714, // total position value

    "profit_address_count": 6680, // profitable addresses
    "loss_address_count": 14276, // losing addresses
    "profit_address_percent": 31.88, // profit %
    "loss_address_percent": 68.12 // loss %
   }
  ]
}
```

<br />


# Futures - Hyperliquid Positions - Hyperliquid Wallet PNL Distribution


```
GET /api/hyperliquid/wallet/pnl-distribution
```


This endpoint provides real-time Hyperliquid wallet PNL distribution data, grouped by PNL size tiers, including address counts, long/short position values, sentiment indicators, and profit/loss distribution.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "data": [
  {
    "group_name": "Money_Printer", // PnL tier label
    // money_printer | smart_money | grinder | humble_earner
    // exit_liquidity | semi_rekt | full_rekt | giga_rekt

    "all_address_count": 518, // total addresses
    "position_address_count": 286, // addresses with positions
    "position_address_percent": 55.22, // position address %

    "bias_score": -0.42, // long/short bias score

    "bias_remark": "bearish", // sentiment label
    // bearish | slightly_bearish | indecisive | bullish | very_bullish

    "minimum_amount": 100000, // min PnL range
    "maximum_amount": 1000000, // max PnL range

    "long_position_usd": 1624390818.866083999, // long position value
    "short_position_usd": 2374121810.5067759868, // short position value
    "long_position_usd_percent": 40.62, // long value %
    "short_position_usd_percent": 59.38, // short value %

    "position_usd": 3998512629.3728599858, // total position value

    "profit_address_count": 211, // profitable addresses
    "loss_address_count": 75, // losing addresses
    "profit_address_percent": 73.78, // profit %
    "loss_address_percent": 26.22 // loss %
    }
  ]

}
```


# Futures - Taker Buy/Sell - Pair Taker Buy/Sell History


```
GET /api/futures/v2/taker-buy-sell-volume/history
```


This endpoint provides historical data for the long/short ratio of taker buy and sell volumes in futures markets.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w         |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                                     |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1750183200000,
      "taker_buy_volume_usd": "414120141.0714",
      "taker_sell_volume_usd": "350417509.655"
    },
    {
      "time": 1750186800000,
      "taker_buy_volume_usd": "882509979.6914",
      "taker_sell_volume_usd": "808715578.4428"
    },
    {
      "time": 1750190400000,
      "taker_buy_volume_usd": "572589140.5759",
      "taker_sell_volume_usd": "571005164.3247"
    },
}

```


# Futures - Taker Buy/Sell - Coin Taker Buy/Sell History


```
GET /api/futures/aggregated-taker-buy-sell-volume/history
```


This endpoint provides historical data for the long/short ratio of aggregated taker buy and sell volumes for futures cryptocurrencies.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

&#x20;


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                              |
| ------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | exchange_list: List of exchange names to retrieve data from (e.g., 'Binance,OKX,Bybit')                  |
| symbol        | string  | YES       | Trading pair (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                        |
| interval      | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit         | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                             |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                   |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                     |
| unit          | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.                                              |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741622400000, // Timestamp in milliseconds
      "aggregated_buy_volume_usd": 968834542.3787, // Aggregated buy volume (USD)
      "aggregated_sell_volume_usd": 1054582654.8138 // Aggregated sell volume (USD)
    },
    {
      "time": 1741626000000,
      "aggregated_buy_volume_usd": 1430620763.2041,
      "aggregated_sell_volume_usd": 1559166911.2821
    },
    {
      "time": 1741629600000,
      "aggregated_buy_volume_usd": 1897261721.0129,
      "aggregated_sell_volume_usd": 2003812276.7812
    }
  ]
}

```


# Futures - Taker Buy/Sell - Footprint History (90d)


```
GET /api/futures/volume/footprint-history
```


This endpoint provides historical footprint chart data for futures markets, including buy and sell volumes at each price level.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (Supported Binance, OKX,Bybit,Hyperliquid)                                       |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.             |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",  // code (0 = success)
  "data": [
    [
      1757808000,  // Timestamp (seconds)
      [
        [
          115765,        // Price start
          115770,        // Price end
          3.223,         // Taker buy volume 
          9.906,         // Taker sell volume 
          373118.1958,   // Taker buy volume (quote currency)
          1146773.5391,  // Taker sell volume (quote currency)
          373118.1958,   // Taker buy volume (USDT)
          1146773.5391,  // Taker sell volume (USDT)
          193,           // Taker buy trade count
          153            // Taker sell trade count
        ],
        [
          115770,
          115775,
          3.315,         // Taker buy volume
          0.528,         // Taker sell volume
          383782.5569,   // Taker buy volume (quote currency)
          61127.0686,    // Taker sell volume (quote currency)
          383782.5569,   // Taker buy volume (USDT)
          61127.0686,    // Taker sell volume (USDT)
          40,            // Taker buy trade count
          64             // Taker sell trade count
        ]
      ]
    ]
  ]
}
```


# Futures - Taker Buy/Sell - Cumulative Volume Delta (CVD)


```
GET /api/futures/cvd/history
```


This endpoint provides historical Cumulative Volume Delta (CVD) data for a single futures exchange trading pair, including taker buy and sell volumes over time.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                       |
| ---------- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API.  |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                     |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w           |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                                       |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).  The starting timestamp from which CVD calculation begins. |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                              |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1762254000000,
      "taker_buy_vol": 350281007.0211,
      "taker_sell_vol": 325339470.9493,
      "cum_vol_delta": 24941536.0718
    },
    {
      "time": 1762257600,
      "taker_buy_vol": 286399814.1275,
      "taker_sell_vol": 347409544.4937,
      "cum_vol_delta": -36068194.2944
    },
    {
      "time": 1762261200,
      "taker_buy_vol": 299952362.4807,
      "taker_sell_vol": 323978642.5934,
      "cum_vol_delta": -60094474.4071
    },
  ]
}
```


# Futures - Taker Buy/Sell - Aggregated Cumulative Volume Delta (CVD)


```
GET /api/futures/aggregated-cvd/history
```


This endpoint provides historical CVD data for a single cryptocurrency within one futures exchange, aggregated across multiple trading pairs.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                                        |
| ------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | Comma-separated exchange names (e.g., "binance, okx, bybit"). Retrieve supported exchanges via the 'supported-exchange-pairs' API. |
| symbol        | string  | YES       | Trading pair (e.g., BTC). Retrieve supported coins via the 'support-coins' API.                                                    |
| interval      | string  | YES       | Time interval for data aggregation.Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w                             |
| limit         | integer | NO        | Number of results per request.Default: 1000, Maximum: 4500                                                                         |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).   The starting timestamp from which CVD calculation begins.                 |
| end_time      | string  | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                                               |
| unit          | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.  Default: 'usd'                                                        |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1762254000000,
      "agg_taker_buy_vol": 461937243.0899,
      "agg_taker_sell_vol": 415687343.2719,
      "cum_vol_delta": 46249899.818
    },
    {
      "time": 1762257600,
      "agg_taker_buy_vol": 390296231.4588,
      "agg_taker_sell_vol": 469137635.9107,
      "cum_vol_delta": -32591504.6339
    },
    {
      "time": 1762261200,
      "agg_taker_buy_vol": 461378798.1884,
      "agg_taker_sell_vol": 450407935.7885,
      "cum_vol_delta": -21620642.234
    },
  ]
}
```


# Spots - Trading market - Supported Coins


```
GET /api/spot/supported-coins
```


This endpoint allows you to query all the supported spot coins on CoinGlass.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    "BTC",
    "ETH",
    "USDT",
    "BNB",
    "SOL",
    "USDC",
    ...
  ]
}
```


# Spots - Trading market - Suported Exchange and Pairs


```
GET /api/spot/supported-exchange-pairs
```


This endpoint allows you to query all supported spot trading exchanges and their corresponding trading pairs on CoinGlass.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "Binance": [ // exchange name
      {
        "instrument_id": "BTCUSD_USDT",// Spot pair
        "base_asset": "BTC",// base asset
        "quote_asset": "USDT"// quote asset
      },
      {
        "instrument_id": "ETHUSD_USDT",
        "base_asset": "ETH",
        "quote_asset": "USDT"
      },
      ....
      ],
    "Bitget": [
      {
        "instrument_id": "AAVE:USD",
        "base_asset": "AAVE",
        "quote_asset": "USD"
      },
      {
        "instrument_id": "ADAUSD",
        "base_asset": "ADA",
        "quote_asset": "USD"
      },
      ...
      ]
      ...
   }
}
```


# Spots - Trading market - Coins Markets


```
GET /api/spot/coins-markets
```


This endpoint provides performance-related metrics for all available spot coins

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name     | Type    | Mandatory | Description                             |
| -------- | ------- | --------- | --------------------------------------- |
| per_page | integer | NO        |  Number of results per page.            |
| page     | integer | NO        | Page number for pagination, default: 1. |


**Response Data:**

```json
{
  "code": "0", 
  "msg": "success", 
  "data": [
    {
      "symbol": "BTC", // Token symbol, e.g., BTC for Bitcoin
      "current_price": 87500, // Current price in USD

      "market_cap": 1735007745495.3037, // Market capitalization in USD

      // Price changes in USD over various time intervals
      "price_change_5m": 101.5, // Price change in last 5 minutes
      "price_change_15m": 46.18, // Price change in last 15 minutes
      "price_change_30m": -77.22, // Price change in last 30 minutes
      "price_change_1h": 12.56, // Price change in last 1 hour
      "price_change_4h": 147.75, // Price change in last 4 hours
      "price_change_12h": 147.75, // Price change in last 12 hours
      "price_change_24h": 2799.99, // Price change in last 24 hours
      "price_change_1w": 2989.69, // Price change in last 1 week

      // Price changes in percentage over various time intervals
      "price_change_percent_5m": 0.12, // % change in last 5 minutes
      "price_change_percent_15m": 0.05, // % change in last 15 minutes
      "price_change_percent_30m": -0.09, // % change in last 30 minutes
      "price_change_percent_1h": 0.01, // % change in last 1 hour
      "price_change_percent_4h": 0.17, // % change in last 4 hours
      "price_change_percent_12h": 0.17, // % change in last 12 hours
      "price_change_percent_24h": 3.31, // % change in last 24 hours
      "price_change_percent_1w": 3.54, // % change in last 1 week

      // Total trading volume in USD over various time intervals
      "volume_usd_1h": 129491564.6994, // Total volume in last 1 hour
      "volume_usd_5m": 11056683.8336, // Total volume in last 5 minutes
      "volume_usd_15m": 50625331.2542, // Total volume in last 15 minutes
      "volume_usd_30m": 80070296.0794, // Total volume in last 30 minutes
      "volume_usd_4h": 580775143.5162, // Total volume in last 4 hours
      "volume_usd_12h": 2663308247.353, // Total volume in last 12 hours
      "volume_usd_24h": 3719093876.3834, // Total volume in last 24 hours
      "volume_usd_1w": 16801739001.0272, // Total volume in last 1 week

      // Trading volume change in USD compared to the previous same interval
      "volume_change_usd_1h": -35317032.6336,
      "volume_change_usd_5m": -110911976.2243,
      "volume_change_usd_15m": -59017725.7105,
      "volume_change_usd_30m": -39864985.2519,
      "volume_change_usd_4h": -1084757627.3629,
      "volume_change_usd_12h": 1624238611.116,
      "volume_change_usd_24h": 1967797576.5416,
      "volume_change_usd_1w": -23396586539.5365,

      // Percentage change in trading volume over various time intervals
      "volume_change_percent_1h": -21.43,
      "volume_change_percent_5m": -90.93,
      "volume_change_percent_15m": -53.83,
      "volume_change_percent_30m": -33.24,
      "volume_change_percent_4h": -65.13,
      "volume_change_percent_12h": 156.32,
      "volume_change_percent_24h": 112.36,
      "volume_change_percent_1w": 3.54,

      // Buy-side trading volume in USD (aggressive buy orders)
      "buy_volume_usd_1h": 55687151.2164,
      "buy_volume_usd_5m": 4634327.6087,
      "buy_volume_usd_15m": 20222399.059,
      "buy_volume_usd_30m": 33140975.4441,
      "buy_volume_usd_4h": 278174843.6339,
      "buy_volume_usd_12h": 1410854413.4688,
      "buy_volume_usd_24h": 1923920264.0666,
      "buy_volume_usd_1w": 8116673333.4846,

      // Sell-side trading volume in USD (aggressive sell orders)
      "sell_volume_usd_1h": 73804413.4829,
      "sell_volume_usd_5m": 6422356.2248,
      "sell_volume_usd_15m": 30402932.1951,
      "sell_volume_usd_30m": 46929320.6352,
      "sell_volume_usd_4h": 302600299.8822,
      "sell_volume_usd_12h": 1252453833.8841,
      "sell_volume_usd_24h": 1795173612.3167,
      "sell_volume_usd_1w": 8685065667.5425,

      // Net flow (buy volume - sell volume), representing market sentiment
      "volume_flow_usd_1h": -18117262.2665,
      "volume_flow_usd_5m": -1788028.6161,
      "volume_flow_usd_15m": -10180533.1361,
      "volume_flow_usd_30m": -13788345.1911,
      "volume_flow_usd_4h": -24425456.2483,
      "volume_flow_usd_12h": 158400579.5847,
      "volume_flow_usd_24h": 128746651.7499,
      "volume_flow_usd_1w": -568392334.0579
    }
  ]
}

```


# Spots - Trading market - Pairs Markets


```
GET /api/spot/pairs-markets
```


This endpoint provides performance-related metrics for all available spot trading pairs

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                       |
| ------ | ------ | --------- | --------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API. |


**Response Data:**

```json
{
  "code": "0",                        
  "msg": "success",                      
  "data": [
    {
      "symbol": "BTC/USDT",                // Trading pair
      "exchange_name": "Binance",          // Exchange name
      "current_price": 87503.55,           // Current price

      "price_change_1h": 99.55,            // Price change in the past 1 hour
      "price_change_percent_1h": 0.11,     // Price change percentage in the past 1 hour
      "volume_usd_1h": 54425251.2426,      // Trading volume in the past 1 hour (USD)
      "buy_volume_usd_1h": 29304086.0661,  // Buy volume in the past 1 hour (USD)
      "sell_volume_usd_1h": 25121165.1759, // Sell volume in the past 1 hour (USD)
      "volume_change_usd_1h": -24851651.918,   // Volume change in the past 1 hour (USD)
      "volume_change_percent_1h": -31.35,  // Volume change percentage in the past 1 hour
      "net_flows_usd_1h": 4182920.8902,    // Net inflow in the past 1 hour (USD)

      "price_change_4h": 209.56,           // Price change in the past 4 hours
      "price_change_percent_4h": 0.24,     // Price change percentage in the past 4 hours
      "volume_usd_4h": 264625587.5144,     // Trading volume in the past 4 hours (USD)
      "buy_volume_usd_4h": 137768056.2376, // Buy volume in the past 4 hours (USD)
      "sell_volume_usd_4h": 126857531.2762, // Sell volume in the past 4 hours (USD)
      "volume_change_4h": -526166190.0218, // Volume change in the past 4 hours (USD)
      "volume_change_percent_4h": -66.54,  // Volume change percentage in the past 4 hours
      "net_flows_usd_4h": 10910524.9614,   // Net inflow in the past 4 hours (USD)

      "price_change_12h": 2925.55,         // Price change in the past 12 hours
      "price_change_percent_12h": 3.46,    // Price change percentage in the past 12 hours
      "volume_usd_12h": 1212930000.2011,   // Trading volume in the past 12 hours (USD)
      "buy_volume_usd_12h": 662857153.6506, // Buy volume in the past 12 hours (USD)
      "sell_volume_usd_12h": 550072846.5499, // Sell volume in the past 12 hours (USD)
      "volume_change_12h": 842092388.1946, // Volume change in the past 12 hours (USD)
      "volume_change_percent_12h": 227.08, // Volume change percentage in the past 12 hours
      "net_flows_usd_12h": 112784307.1007, // Net inflow in the past 12 hours (USD)

      "price_change_24h": 2735.79,         // Price change in the past 24 hours
      "price_change_percent_24h": 3.23,    // Price change percentage in the past 24 hours
      "volume_usd_24h": 1585522232.603,    // Trading volume in the past 24 hours (USD)
      "buy_volume_usd_24h": 843617569.7248, // Buy volume in the past 24 hours (USD)
      "sell_volume_usd_24h": 741904662.8776, // Sell volume in the past 24 hours (USD)
      "volume_change_24h": 873336140.8197, // Volume change in the past 24 hours (USD)
      "volume_change_percent_24h": 122.63, // Volume change percentage in the past 24 hours
      "net_flows_usd_24h": 101712906.8472, // Net inflow in the past 24 hours (USD)

      "price_change_1w": 3057.83,          // Price change in the past 1 week
      "price_change_percent_1w": 3.62,     // Price change percentage in the past 1 week
      "volume_usd_1w": 6808077059.7062,    // Trading volume in the past 1 week (USD)
      "buy_volume_usd_1w": 3374037733.8429, // Buy volume in the past 1 week (USD)
      "sell_volume_usd_1w": 3434039325.8627, // Sell volume in the past 1 week (USD)
      "volume_change_usd_1w": -11208235126.1193, // Volume change in the past 1 week (USD)
      "volume_change_percent_1w": -62.21,  // Volume change percentage in the past 1 week
      "net_flows_usd_1w": -60001592.0198   // Net inflow in the past 1 week (USD)
    }
  ]
}

```


# Spots - Trading market - Price OHLC History


```
GET /api/spot/price/history
```


This endpoint provides historical open, high, low, and close (OHLC) price data for cryptocurrencies over specified timeframes.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type   | Mandatory | Description                                                                                                   |
| ---------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------- |
| exchange   | string | YES       | spot exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                 |
| interval   | string | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w.          |
| limit      | string | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                                  |
| start_time | string | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                        |
| end_time   | string | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                          |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741690800000,
      "open": 81808.25,//open price
      "high": 82092.34, //high price
      "low": 81400,//low price
      "close": 81720.34,//close price
      "volume_usd": 96823535.5724
    },
    {
      "time": 1741694400000,
      "open": 81720.33,
      "high": 81909.69,
      "low": 81017,
      "close": 81225.5,
      "volume_usd": 150660424.1863
    },
```


# Spots - Order book - Pair Orderbook Bid&Ask(±range)


```
GET /api/spot/orderbook/ask-bids-history
```


This endpoint provides historical data of the order book for spot trading, including total bid/ask volumes within a specific price range.

***Cache / Update Frequency:*** every 5 seconds for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                          |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API.   |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Check supported pairs through the 'supported-exchange-pair' API.       |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time   | integer | NO        |  End timestamp in milliseconds (e.g., 1641522717000).                                                |
| range      | string  | NO        | Depth percentage (e.g., 0.25, 0.5, 0.75, 1, 2, 3, 5, 10).                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "bids_usd": 81639959.9338,        // Total long position amount (USD)
      "bids_quantity": 1276.645,        // Total long quantity
      "asks_usd": 78533053.6862,        // Total short position amount (USD)
      "asks_quantity": 1217.125,        // Total short quantity
      "time": 1714003200000             // Timestamp (in milliseconds)
    },
    {
      "bids_usd": 62345879.8821,
      "bids_quantity": 980.473,
      "asks_usd": 65918423.4715,
      "asks_quantity": 1021.644,
      "time": 1714089600000
    }
  ]
}

```


# Spots - Order book - Coin Orderbook Bid&Ask(±range)


```
GET /api/spot/orderbook/aggregated-ask-bids-history
```


This endpoint provides historical data of the aggregated order book for spot trading, including total bid/ask volumes within a specific price range.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                          |
| ------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | List of exchange names to retrieve data from (e.g., 'ALL', or 'Binance, OKX, Bybit')                 |
| symbol        | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                    |
| interval      | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit         | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |
| range         | string  | NO        | Depth percentage (e.g., 0.25, 0.5, 0.75, 1, 2, 3, 5, 10).                                            |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "aggregated_bids_usd": 12679537.0806,         // Aggregated long amount (USD)
      "aggregated_bids_quantity": 197.99861,        // Aggregated long quantity
      "aggregated_asks_usd": 10985519.9268,         // Aggregated short amount (USD)
      "aggregated_asks_quantity": 170.382,          // Aggregated short quantity
      "time": 1714003200000                         // Timestamp (milliseconds)
    },
    {
      "aggregated_bids_usd": 18423845.1947,
      "aggregated_bids_quantity": 265.483,
      "aggregated_asks_usd": 17384271.5521,
      "aggregated_asks_quantity": 240.785,
      "time": 1714089600000
    }
  ]
}

```


# Spots - Order book - Orderbook Heatmap


```
GET /api/spot/orderbook/history
```


This endpoint provides historical order book depth data for spot trading, supporting heatmap visualization.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type   | Mandatory | Description                                                                                                               |
| ---------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------------------- |
| exchange   | string | YES       | Spot exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API.             |
| symbol     | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                             |
| interval   | string | YES       | Time intervals for data aggregation. Supported values: 1m、3m、5m、15m、30m、1h、4h、6h、8h、12h、1d.                               |
| limit      | string | NO        | Number of results per request. Default: 100, Maximum: 100.  Historical range – 1m: 3 days, 5m: 15 days, others: 150 days. |
| start_time | string | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                                    |
| end_time   | string | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                                      |


**Response Data:**

```json
{
    "code": "0",
    "msg": "success",
    "data": [
        [
            1723611600,
            [
                [
                    56420, //Price
                    4.777 //Quantity
                ],
                [
                    40300,
                    2.191
                ]
            ],
            [
                [
                    56420,
                    4.777
                ],
                [
                    40300,
                    2.191
                ]
            ]
        ]
    ],
    "success": true
}
```


# Spots - Order book - Large Orderbook


```
GET /api/spot/orderbook/large-limit-order
```


This endpoint provides large open limit orders from the current order book for spot trading.(thresholds: BTC ≥ 350K, ETH ≥ 250K, Other ≥ 10K)

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                        |
| -------- | ------ | --------- | -------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol   | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.      |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "id": 2536823422,
      "exchange_name": "Binance",                // Exchange name
      "symbol": "BTCUSDT",                       // Trading pair
      "base_asset": "BTC",                       // Base asset
      "quote_asset": "USDT",                     // Quote asset
      "price": 20000,                            // Order price
      "start_time": 1742615617000,               // Order start time (timestamp)
      "start_quantity": 109.42454,               // Initial quantity
      "start_usd_value": 2188490.8,              // Initial order value in USD
      "current_quantity": 104.00705,             // Current remaining quantity
      "current_usd_value": 2080141,              // Current remaining value in USD
      "current_time": 1745287267958,             // Current update time (timestamp)
      "executed_volume": 0,                      // Executed volume
      "executed_usd_value": 0,                   // Executed value in USD
      "trade_count": 0,                          // Number of executed trades
      "order_side": 2,                           // Order side: 1 = Buy, 2 = Sell
      "order_state": 1                           // Order state: 1 = Active, 2 = Completed
    }
  ]
}

```


# Spots - Order book - Large Orderbook History


```
GET /api/spot/orderbook/large-limit-order-history
```


This endpoint provides completed historical large limit orders from the order book for futures trading.(thresholds: BTC ≥ 350K, ETH ≥ 250K, Other ≥ 10K)

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type   | Mandatory | Description                                                                                        |
| ---------- | ------ | --------- | -------------------------------------------------------------------------------------------------- |
| exchange   | string | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string | YES       | Trading pair (e.g., BTCUSDT). Check supported pairs through the 'supported-exchange-pair' API.     |
| start_time | string | YES       | Start timestamp in milliseconds (e.g., 1723625037000).                                             |
| end_time   | string | YES       | End timestamp in milliseconds (e.g., 1723626037000).                                               |
| state      | string | YES       | Status of the order — 1for ''In Progress'' 2 for "Finish" 3 for "Revoke"                           |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "id": 2895605135,
      "exchange_name": "Binance",               // Exchange name
      "symbol": "BTCUSDT",                      // Trading pair
      "base_asset": "BTC",                      // Base asset
      "quote_asset": "USDT",                    // Quote asset
      "price": 89205.9,                         // Order price
      "start_time": 1745287309000,              // Order start time (milliseconds)
      "start_quantity": 25.779,                 // Initial order quantity
      "start_usd_value": 2299638.8961,          // Initial order value (USD)
      "current_quantity": 25.779,               // Remaining quantity
      "current_usd_value": 2299638.8961,        // Remaining value (USD)
      "current_time": 1745287309000,            // Current timestamp (milliseconds)
      "executed_volume": 0,                     // Executed volume
      "executed_usd_value": 0,                  // Executed value (USD)
      "trade_count": 0,                         // Number of trades executed
      "order_side": 1,                          // Order side: 1 = Sell, 2 = Buy
      "order_state": 2,                         // Order state: 0 = Not started, 1 = Open, 2 = Filled, 3 = Cancelled
      "order_end_time": 1745287328000           // Order end time (milliseconds)
    }
    ....
  ]
}
```


# Spots - Taker Buy/Sell - Pair Taker Buy/Sell History


```
GET /api/spot/taker-buy-sell-volume/history
```


This endpoint provides historical data for the long/short ratio of taker buy and sell volumes in spot markets.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup | Standard | Professional | Enterprise |
| :------------- | :------- | :------ | :------- | :----------- | :--------- |
| Available      | ✅        | ✅       | ✅        | ✅            | ✅          |
| interval Limit | `>=4h`   | `>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                              |
| ---------- | ------- | --------- | -------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API.       |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.            |
| interval   | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                   |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                     |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741622400000, // Timestamp in milliseconds
      "taker_buy_volume_usd": "10551.033", // Taker buy volume (USD)
      "taker_sell_volume_usd": "11308" // Taker sell volume (USD)
    },
    {
      "time": 1741626000000,
      "taker_buy_volume_usd": "15484.245",
      "taker_sell_volume_usd": "16316.118"
    },
    {
      "time": 1741629600000,
      "taker_buy_volume_usd": "20340.501",
      "taker_sell_volume_usd": "18977.660"
    }
  ]
}

```


# Spots - Taker Buy/Sell - Coin Taker Buy/Sell History


```
GET /api/spot/aggregated-taker-buy-sell-volume/history
```


This endpoint provides historical data for the long/short ratio of aggregated taker buy and sell volumes for spot cryptocurrencies.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup | Standard | Professional | Enterprise |
| :------------- | :------- | :------ | :------- | :----------- | :--------- |
| Available      | ✅        | ✅       | ✅        | ✅            | ✅          |
| interval Limit | `>=4h`   | `>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                              |
| ------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | exchange_list: List of exchange names to retrieve data from (e.g., 'Binance, OKX, Bybit')                |
| symbol        | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                        |
| interval      | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit         | integer | NO        | Number of results per request.  Default: 1000, Maximum: 1000                                             |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                   |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                     |
| unit          | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.                                              |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741622400000, // Timestamp in milliseconds
      "aggregated_buy_volume_usd": 968834542.3787, // Aggregated buy volume (USD)
      "aggregated_sell_volume_usd": 1054582654.8138 // Aggregated sell volume (USD)
    },
    {
      "time": 1741626000000,
      "aggregated_buy_volume_usd": 1430620763.2041,
      "aggregated_sell_volume_usd": 1559166911.2821
    },
    {
      "time": 1741629600000,
      "aggregated_buy_volume_usd": 1897261721.0129,
      "aggregated_sell_volume_usd": 2003812276.7812
    }
  ]
}

```


# Spots - Taker Buy/Sell - Footprint History (90d)


```
GET /api/spot/volume/footprint-history
```


This endpoint provides historical footprint chart data for spot markets, including buy and sell volumes at each price level.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ❌        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                             |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Spot exchange names (Supported Binance, OKX,Bybit,Hyperliquid)                                          |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.             |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                             |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",  // code (0 = success)
  "data": [
    [
      1757808000,  // Timestamp (seconds)
      [
        [
          115765,        // Price start
          115770,        // Price end
          3.223,         // Taker buy volume 
          9.906,         // Taker sell volume 
          373118.1958,   // Taker buy volume (quote currency)
          1146773.5391,  // Taker sell volume (quote currency)
          373118.1958,   // Taker buy volume (USDT)
          1146773.5391,  // Taker sell volume (USDT)
          193,           // Taker buy trade count
          153            // Taker sell trade count
        ],
        [
          115770,
          115775,
          3.315,         // Taker buy volume
          0.528,         // Taker sell volume
          383782.5569,   // Taker buy volume (quote currency)
          61127.0686,    // Taker sell volume (quote currency)
          383782.5569,   // Taker buy volume (USDT)
          61127.0686,    // Taker sell volume (USDT)
          40,            // Taker buy trade count
          64             // Taker sell trade count
        ]
      ]
    ]
  ]
}
```


# Spots - Taker Buy/Sell - Cumulative Volume Delta (CVD)


```
GET /api/spot/cvd/history
```


This endpoint provides historical Cumulative Volume Delta (CVD) data for a single spot exchange trading pair, including taker buy and sell volumes over time.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                       |
| ---------- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API.                |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                     |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w           |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000                                                       |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).  The starting timestamp from which CVD calculation begins. |
| end_time   | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                            |
| unit       | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.   Default: 'usd'                                      |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1762254000000,
      "taker_buy_vol": 350281007.0211,
      "taker_sell_vol": 325339470.9493,
      "cum_vol_delta": 24941536.0718
    },
    {
      "time": 1762257600,
      "taker_buy_vol": 286399814.1275,
      "taker_sell_vol": 347409544.4937,
      "cum_vol_delta": -36068194.2944
    },
    {
      "time": 1762261200,
      "taker_buy_vol": 299952362.4807,
      "taker_sell_vol": 323978642.5934,
      "cum_vol_delta": -60094474.4071
    },
  ]
}
```


# Spots - Taker Buy/Sell - Aggregated Cumulative Volume Delta (CVD)


```
GET /api/spot/aggregated-cvd/history
```


This endpoint provides historical CVD data for a single cryptocurrency within one spot exchange, aggregated across multiple trading pairs.

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                                        |
| ------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | Comma-separated exchange names (e.g., "binance, okx, bybit"). Retrieve supported exchanges via the 'supported-exchange-pairs' API. |
| symbol        | string  | YES       | Trading pair (e.g., BTC). Retrieve supported coins via the 'support-coins' API.                                                    |
| interval      | string  | YES       | Time interval for data aggregation.
Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w
                           |
| limit         | integer | NO        | Number of results per request. Default: 1000, Maximum: 4500                                                                        |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).  The starting timestamp from which CVD calculation begins.                  |
| end_time      | integer | NO        | 
End timestamp in milliseconds (e.g., 1641522717000).                                                                              |
| unit          | string  | NO        | Unit for the returned data, choose between 'usd' or 'coin'.  Default: 'usd'                                                        |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1762254000000,
      "agg_taker_buy_vol": 461937243.0899,
      "agg_taker_sell_vol": 415687343.2719,
      "cum_vol_delta": 46249899.818
    },
    {
      "time": 1762257600,
      "agg_taker_buy_vol": 390296231.4588,
      "agg_taker_sell_vol": 469137635.9107,
      "cum_vol_delta": -32591504.6339
    },
    {
      "time": 1762261200,
      "agg_taker_buy_vol": 461378798.1884,
      "agg_taker_sell_vol": 450407935.7885,
      "cum_vol_delta": -21620642.234
    },
  ]
}
```


# Options - Option Max Pain


```
GET /api/option/max-pain
```


This endpoint provides the max pain price for options.

***Cache / Update Frequency:*** every 1 minute for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

&#x20;


 **Parameters:**
| Name     | Type   | Mandatory | Description                                   |
| -------- | ------ | --------- | --------------------------------------------- |
| symbol   | string | YES       | Trading coin (e.g., BTC,ETH).                 |
| exchange | string | YES       | Exchange name (e.g., Deribit, Binance, OKX).  |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "date": "250422",                                   // Date (YYMMDD format)
      "call_open_interest_market_value": 1616749.22,      // Call option market value (USD)
      "put_open_interest": 512.5,                         // Put option open interest (contracts)
      "put_open_interest_market_value": 49687.62,         // Put option market value (USD)
      "max_pain_price": "84000",                          // Max pain price
      "call_open_interest": 953.7,                        // Call option open interest (contracts)
      "call_open_interest_notional": 83519113.56,         // Call option notional value (USD)
      "put_open_interest_notional": 44881569.13           // Put option notional value (USD)
    },
    {
      "date": "250423",                                   // Date (YYMMDD format)
      "call_open_interest_market_value": 2274700.52,      // Call option market value (USD)
      "put_open_interest": 1204.3,                        // Put option open interest (contracts)
      "put_open_interest_market_value": 374536.01,        // Put option market value (USD)
      "max_pain_price": "85000",                          // Max pain price
      "call_open_interest": 1302.2,                       // Call option open interest (contracts)
      "call_open_interest_notional": 114040373.53,        // Call option notional value (USD)
      "put_open_interest_notional": 105465691.73          // Put option notional value (USD)
    }
  ]
}

```


# Options - Options Info


```
GET /api/option/info
```


This endpoint provides detailed information about open interest and trading volume for options across different exchanges

***Cache / Update Frequency:*** every 30 seconds for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />


 **Parameters:**
| Name   | Type   | Mandatory | Description                    |
| ------ | ------ | --------- | ------------------------------ |
| symbol | string | YES       | Trading coin (e.g., BTC,ETH).  |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "exchange_name": "All",                           // Exchange name
      "open_interest": 361038.78,                       // Open interest (contracts)
      "oi_market_share": 100,                           // Market share (%)
      "open_interest_change_24h": 2.72,                 // 24h open interest change (%)
      "open_interest_usd": 31623069708.138245,          // Open interest value (USD)
      "volume_usd_24h": 2764676957.0569425,             // 24h trading volume (USD)
      "volume_change_percent_24h": 303.1                // 24h volume change (%)
    },
    {
      "exchange_name": "Deribit",                       // Exchange name
      "open_interest": 262641.9,                        // Open interest (contracts)
      "oi_market_share": 72.74,                         // Market share (%)
      "open_interest_change_24h": 2.57,                 // 24h open interest change (%)
      "open_interest_usd": 23005403973.349,             // Open interest value (USD)
      "volume_usd_24h": 2080336672.709                  // 24h trading volume (USD)
    }
  ]
}

```


# Options - Exchange Open Interest History


```
GET /api/option/exchange-oi-history
```


This endpoint provides historical open interest data for options across different exchanges

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                                                                                                     |
| ------ | ------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC,ETH).                                                                                                                                   |
| unit   | string | YES       | Specify the unit for the returned data. Supported values depend on the symbol. If symbol is BTC, choose between USD or BTC. For ETH, choose between USD or ETH. |
| range  | string | YES       | Time range for the data. Supported values: 1h, 4h, 12h, all.                                                                                                    |


**Response Data:**

```json
{
  "code": "0",                                 
  "msg": "success",                            
  "data": [
    {
      "time_list": [1691460000000, ...],       // Array of timestamps (in milliseconds)
      "price_list": [29140.9, ...],            // Array of prices corresponding to each timestamp
      "data_map": {                            // Open Interest (OI) data by exchange
        "huobi": [15167.03527, ...],           // OI data from Huobi exchange
        "gate": [23412.723, ...],              // OI data from Gate exchange
        ...
      }
    }
  ]
}

```


# Options - Exchange Volume History


```
GET /api/option/exchange-vol-history
```


This endpoint provides historical trading volume data for options across different exchanges

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                                                                                                     |
| ------ | ------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | string | YES       | Trading coin (e.g., BTC,ETH).                                                                                                                                   |
| unit   | string | YES       | Specify the unit for the returned data. Supported values depend on the symbol. If symbol is BTC, choose between USD or BTC. For ETH, choose between USD or ETH. |


**Response Data:**

```json
{
  "code": "0",                                
  "msg": "success",                            
  "data": [
    {
      "time_list": [1691460000000, ...],       // Array of timestamps (in milliseconds)
      "price_list": [29140.9, ...],            // Array of prices corresponding to each timestamp
      "data_map": {                            // Volume data by exchange
        "huobi": [15167.03527, ...],           // Volume data from Huobi exchange
        "gate": [23412.723, ...],              // Volume data from Gate exchange
        ...
      }
    }
  ]
}

```


# On-Chain - Exchange data - Exchange Assets


```
GET /api/exchange/assets
```


This endpoint provides asset holdings data for exchange wallets, including wallet address, asset balance, USD value, and real-time price information for each asset.

***Cache / Update Frequency:*** every 1 hour for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

# Respones Data

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "wallet_address": "34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo",
      "balance": 248597.54,
      "balance_usd": 21757721869.92,
      "symbol": "BTC",
      "assets_name": "Bitcoin",
      "price": 87521.87117346626
    },
    {
      "wallet_address": "3M219KR5vEneNb47ewrPfWyb5jQ2DjxRP6",
      "balance": 139456.08,
      "balance_usd": 12205457068.12,
      "symbol": "BTC",
      "assets_name": "Bitcoin",
      "price": 87521.87117346626
    },
```

 **Parameters:**
| Name     | Type   | Mandatory | Description                                                                                        |
| -------- | ------ | --------- | -------------------------------------------------------------------------------------------------- |
| exchange | string | YES       | Exchange name (e.g., Binance). Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| per_page | string | NO        | Number of results per page.                                                                        |
| page     | string | NO        | Page number for pagination, default: 1                                                             |


# On-Chain - Exchange data - Exchange Balance List


```
GET /api/exchange/balance/list
```


This endpoint provides exchange-level asset balance data, including total holdings and percentage changes over 1-day, 7-day, and 30-day periods.

***Cache / Update Frequency:*** every 1 hour for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                            |
| ------ | ------ | --------- | -------------------------------------- |
| symbol | string | YES       | Trading coin eg. BTC , ETH , USDT(ETH) |


**Response Data:**

```json
{
  "code": "0",                                  
  "msg": "success",                            
  "data": [
    {
      "exchange_name": "Coinbase",               // Exchange name
      "total_balance": 716590.351233,            // Total balance
      "balance_change_1d": 638.797302,           // Balance change in 24 hours
      "balance_change_percent_1d": 0.09,         // Balance change percentage in 24 hours (%)
      "balance_change_7d": 799.967408,           // Balance change in 7 days
      "balance_change_percent_7d": 0.11,         // Balance change percentage in 7 days (%)
      "balance_change_30d": -29121.977486,       // Balance change in 30 days
      "balance_change_percent_30d": -3.91        // Balance change percentage in 30 days (%)
    },
    {
      "exchange_name": "Binance",                // Exchange name
      "total_balance": 582344.497738,            // Total balance
      "balance_change_1d": 505.682778,           // Balance change in 24 hours
      "balance_change_percent_1d": 0.09,         // Balance change percentage in 24 hours (%)
      "balance_change_7d": -3784.88544,          // Balance change in 7 days
      "balance_change_percent_7d": -0.65,        // Balance change percentage in 7 days (%)
      "balance_change_30d": 3753.870055,         // Balance change in 30 days
      "balance_change_percent_30d": 0.65         // Balance change percentage in 30 days (%)
    }
  ]
}

```


# On-Chain - Exchange data - Exchange Balance Chart


```
GET /api/exchange/balance/chart
```


This endpoint provides historical chart data of exchange asset balances over time, along with corresponding price data.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description               |
| ------ | ------ | --------- | ------------------------- |
| symbol | string | YES       | Trading coin eg. BTC, ETH |


**Response Data:**

```json
{
  "code": "0",                                 
  "msg": "success",                            
  "data": [
    {
      "time_list": [1691460000000, ...],       // Array of timestamps (in milliseconds)
      "price_list": [29140.9, ...],            // Array of prices corresponding to each timestamp
      "data_map": {                            // Balance data by exchange
        "huobi": [15167.03527, ...],           // Balance data from Huobi exchange
        "gate": [23412.723, ...],              // Balance data from Gate exchange
        ...
      }
    }
  ]
}

```


# On-Chain - Transactions - Exchange On-chain Transfers (ERC-20)


```
GET /api/exchange/chain/tx/list
```


This endpoint provides on-chain transfer records (ERC-20) for exchanges.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                            |
| ---------- | ------- | --------- | -------------------------------------------------------------------------------------- |
| symbol     | string  | NO        | Must be a token symbol supported by the ERC-20 protocol on the Ethereum (ETH) network. |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1706089927315).                                 |
| min_usd    | number  | NO        | Minimum transfer amount filter, specified in USD.                                      |
| per_page   | integer | NO        | Number of results per page.  Max:100                                                   |
| page       | integer | NO        | Page number for pagination, default: 1.                                                |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "transaction_hash": "0xb8d08182d2de176ac42dceba9ff82a7a5fe650c1e56285d6810daac9561ff9dc", // Transaction hash
      "asset_symbol": "USDT",                       // Asset symbol
      "amount_usd": 9998.5,                         // Amount in USD
      "asset_quantity": 9998.5,                     // Quantity
      "exchange_name": "Coinbase",                 // Exchange name
      "transfer_type": 1,                           // Transfer type: 1 = Inflow, 2 = Outflow, 3 = Internal transfer
      "from_address": "0x16c6897438c4f0c7894862d884549e8564c4025f", // From address
      "to_address": "0xa9d1e08c7793af67e9d92fe308d5697fb81d3e43",   // To address
      "transaction_time": 1745224211                // Transaction time (timestamp in seconds)
    },
    {
      "transaction_hash": "0x033c56cb05654f2c360235eff99c84f0eee9c6330fc7012930adfe0a88789c0f", // Transaction hash
      "asset_symbol": "MANA",                       // Asset symbol
      "amount_usd": 6368.95196834,                  // Amount in USD
      "asset_quantity": 20091.33113044,             // Quantity
      "exchange_name": "Binance",                  // Exchange name
      "transfer_type": 1,                           // Transfer type: 1 = Inflow, 2 = Outflow, 3 = Internal transfer
      "from_address": "0x06fd4ba7973a0d39a91734bbc35bc2bcaa99e3b0", // From address
      "to_address": "0x28c6c06298d514db089934071355e5743bf21d60",   // To address
      "transaction_time": 1745224211                // Transaction time (timestamp in seconds)
    }
  ]
}

```


# On-Chain - Transactions - Whale Transfer


```
GET /api/chain/v2/whale-transfer
```


This endpoint provides large on-chain transfers (minimum $10M) within the past six months across major blockchains, including Bitcoin, Ethereum, Tron, Ripple, Dogecoin, Litecoin, Polygon, Algorand, Bitcoin Cash, and Solana.

Cache / Update Frequency: Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type   | Mandatory | Description                                                                       |
| ---------- | ------ | --------- | --------------------------------------------------------------------------------- |
| symbol     | string | NO        | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API. |
| start_time | string | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                            |
| end_time   | string | NO        | End timestamp in milliseconds (e.g., 1641522717000).                              |


**Response Data:**

```json
{
  "code": "0", // status: "0" = success
  "data": [
    {
      "transaction_hash": "0x910ade7323eae57017c1894078ff1ce319fe908709ba185d81147588ceb06dcc",//transaction hash
      "amount_usd": "18403606.873493258", // transfer value in USD
      "asset_quantity": "10081.791421235566", // transferred amount
      "asset_symbol": "WETH", // asset symbol
      "from": "unknown wallet", // sender 
      "to": "unknown wallet", // receiver 
      "blockchain_name": "ethereum", // blockchain name
      "block_height": 22402402, // block number
      "block_timestamp": 1746265043 // block time (unix)
    },
    {
      "transaction_hash": "7b1fa0327a1e68fbcc397eee0a75ae8ced8c19c08d32f5cfd2ec5d3ba04e59fe",//transaction hash
      "amount_usd": "18413630.94247512", // transfer value in USD
      "asset_quantity": "10087.28276721801", // transferred amount
      "asset_symbol": "WETH", // asset symbol
      "from": "unknown wallet", // sender 
      "to": "unknown wallet", // receiver 
      "blockchain_name": "ethereum", // blockchain name
      "block_height": 22402402, // block number
      "block_timestamp": 1746265043 // block time (unix)
    }
    ....
  ]
}
```


# On-Chain - Token - Token Unlock List


```
GET /api/coin/unlock-list
```


This endpoint returns token unlock data and upcoming unlock schedules.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

```json
{
  "code": "0", // response code
  "data": [ // token list
    {
      "symbol": "GT", // token symbol
      "name": "GateToken", // token name
      "symbol_logo_url": "https://cdn.coinglasscdn.com/static/img/coins/gt.jpg", // logo url
      "price": 10.377, // last price
      "price_change_percent_24h": 2.67, // 24h change %
      "market_cap": 1217683606.698, // market cap
      "total_supply": 300000000, // total supply
      "fully_diluted_valuation": 3115642754.097, // FDV
      "total_locked": 74868300, // locked tokens
      "circulating_supply": 117344474, // circulating supply
      "total_unlocked": 162691500, // unlocked tokens
      "next_unlock_date": 1765152000000, // next unlock time
      "next_unlock_tokens": 48600, // next unlock amount
      "next_unlock_of_circulating": 0.041416522093745974, // % of circulating
      "next_unlock_of_supply": 0.0162 // % of total supply
    },
    ....
  ]
}

```

 **Parameters:**
| Name     | Type    | Mandatory | Description                             |
| -------- | ------- | --------- | --------------------------------------- |
| per_page | integer | NO        | Number of results per page.             |
| page     | integer | NO        | Page number for pagination, default: 1. |


# On-Chain - Token - Token Vesting


```
GET /api/coin/vesting
```


This endpoint returns detailed vesting data and upcoming unlock schedules for a specific token.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

<br />

```json
{
  "code": "0",
  "data": {
 {
  "market_cap": 9366969675.066894, // market cap
  "symbol": "HYPE", // token symbol
  "total_untracked": 451880000, // untracked supply
  "listing_date": 1732838400000, // listing time
  "vesting_start_date": 1732838400000, // vesting start
  "total_supply": 999835210, // total supply
  "total_locked": 236721940, // total locked
  "total_unlocked": 310986320, // total unlocked
  "vesting_end_date": 1859068800000, // vesting end
  "next_unlock": { // next unlock info
    "date": 1764720000000, // unlock time
    "next_unlock_token_amount": "216580" // unlock amount
  },
  "circulating_supply": 270772999, // circulating supply
  "total_untracked_percent": 45.188, // untracked percent
  "allocations": [ // allocation list
    {
      "is_untracked": true, // untracked flag
      "allocation_of_supply": 38.888, // supply percent
      "name": "Future Emissions & Community Rewards", // allocation name
      "token_amount": "388880000" // token amount
    },
    {
      "is_untracked": false, // untracked flag
      "allocation_of_supply": 31, // supply percent
      "name": "Genesis Distribution", // allocation name
      "unlock_type": "nonlinear", // unlock type
      "token_amount": "310000000", // token amount
      "tge_unlocked_token_amount": "310000000", // TGE unlocked
      "unlocked_token_amount": "310000000", // total unlocked
      "tge_unlock_percent": 100 // TGE percent
    },
    {
      "is_untracked": false, // untracked flag
      "vesting_start_date": 1764374400000, // vesting start
      "locked_token_amount": "236721940", // locked amount
      "vesting_end_date": 1859068800000, // vesting end
      "tge_unlocked_token_amount": "0", // TGE unlocked
      "next_unlock": { // next unlock info
        "date": 1764720000000, // unlock time
        "next_unlock_token_amount": "216580" // unlock amount
      },
      "unlocked_token_amount": "866320", // unlocked amount
      "tge_unlock_percent": 0, // TGE percent
      "vesting_duration_value": 3, // duration value
      "vesting_duration_type": "year", // duration type
      "allocation_of_supply": 23.8, // supply percent
      "unlock_frequency_type": "day", // unlock unit
      "name": "Core Contributors", // allocation name
      "unlock_type": "linear", // unlock type
      "token_amount": "238000000", // token amount
      "unlock_frequency_value": 1 // unlock interval
    },
    {
      "is_untracked": true, // untracked flag
      "allocation_of_supply": 6, // supply percent
      "name": "Hyper Foundation", // allocation name
      "token_amount": "60000000" // token amount
    },
    {
      "is_untracked": true, // untracked flag
      "allocation_of_supply": 0.3, // supply percent
      "name": "Community Grants", // allocation name
      "token_amount": "3000000" // token amount
    },
    {
      "is_untracked": false, // untracked flag
      "allocation_of_supply": 0.012, // supply percent
      "name": "HIP-2", // allocation name
      "unlock_type": "nonlinear", // unlock type
      "token_amount": "120000", // token amount
      "tge_unlocked_token_amount": "120000", // TGE unlocked
      "unlocked_token_amount": "120000", // total unlocked
      "tge_unlock_percent": 100 // TGE percent
    }
  ],
  "fully_diluted_valuation": 34587740013.671524, // FDV
  "name": "Hyperliquid", // project name
  "max_supply": 1000000000, // max supply
  "chart": [ // chart data
    {
      "date": 1732838400000, // chart time
      "allocations": [ // chart allocations
        {
          "name": "Genesis Distribution", // name
          "unlocked_percent": 31, // unlocked percent
          "token_amount": "310000000", // token amount
          "unlocked_token_amount": "310000000" // unlocked amount
        },
        {
          "name": "Core Contributors", // name
          "unlocked_percent": 0, // unlocked percent
          "token_amount": "238000000", // token amount
          "unlocked_token_amount": "0" // unlocked amount
        },
        {
          "name": "HIP-2", // name
          "unlocked_percent": 0.012, // unlocked percent
          "token_amount": "120000", // token amount
          "unlocked_token_amount": "120000" // unlocked amount
        }
      ],
      "is_tge": true, // is TGE flag
      "unlocked_percent": 31.012, // total percent
      "unlocked_token_amount": "310120000" // total unlocked
    }
    ],
    "untracked_allocation_names": [
      "Community Grants",
      "Future Emissions & Community Rewards",
      "Hyper Foundation"
    ]
  }
}
```

 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                          |
| ------ | ------ | --------- | ------------------------------------------------------------------------------------ |
| symbol | string | YES       | Trading coin (e.g., HYPE). Retrieve supported coins via the 'token-unlock-list' API. |


# ETF - Bitcoin ETF - Bitcoin ETF List


```
GET /api/etf/bitcoin/list
```


This endpoint provides a list of key status information for Bitcoin Exchange-Traded Funds (ETFs).

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "ticker": "GBTC",                                // ETF identifier
      "fund_name": "Grayscale Bitcoin Trust ETF",      // Fund name
      "region": "us",                                  // Region
      "market_status": "early_trading",                // Market status (open/closed/early_trading, etc.)
      "primary_exchange": "ARCX",                      // Primary exchange
      "cik_code": "0001588489",                        // CIK code (unique identifier)
      "fund_type": "Spot",                             // Fund type (Spot/ETF/Futures, etc.)
      "list_date": 1424822400000,                      // Listing date (timestamp in milliseconds)
      "shares_outstanding": "240750100",               // Shares outstanding
      "aum_usd": "16137543152.34",                     // Assets under management (USD)
      "management_fee_percent": "1.5",                 // Management fee (%)
      "last_trade_time": 1745225312958,                // Last trade time (timestamp in milliseconds)
      "last_quote_time": 1745225389483,                // Last quote time (timestamp in milliseconds)
      "volume_quantity": 1068092,                      // Volume quantity
      "volume_usd": 71485902.2312,                     // Volume in USD
      "price_change_usd": 0.47,                        // Price change (USD)
      "price_change_percent": 0.71,                    // Price change (%)
      "asset_details": {
        "net_asset_value_usd": 67.03,                  // Net asset value (USD)
        "premium_discount_percent": 0.09,              // Premium/discount rate (%)
        "btc_holding": 190124.5441,                    // BTC balance
        "btc_change_percent_24h": 0,                   // 24h BTC change (%)
        "btc_change_24h": -7.8136,                     // 24h BTC change amount
        "btc_change_percent_7d": -0.32,                // 7d BTC change (%)
        "btc_change_7d": -615.563,                     // 7d BTC change amount
        "update_date": "2025-04-17"                    // Update date
      },
      "update_timestamp": 1745224505000                // Data update timestamp (milliseconds)
    }
  ]
}

```


# ETF - Bitcoin ETF - Hong Kong ETF Flows History


```
GET /api/hk-etf/bitcoin/flow-history
```


This endpoint provides historical data on ETF flow activity for Bitcoin ETFs in the Hong Kong market.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "timestamp": 1714435200000,                     // Date (timestamp in milliseconds)
      "flow_usd": 247866000,                          // Total capital inflow (USD)
      "price_usd": 63842.4,                           // BTC price on that date (USD)
      "etf_flows": [                                  // ETF capital flow details
        {
          "etf_ticker": "CHINAAMC",                   // ETF ticker
          "flow_usd": 123610690                       // Capital inflow for this ETF (USD)
        },
        {
          "etf_ticker": "HARVEST",                    // ETF ticker
          "flow_usd": 63138000                        // Capital inflow for this ETF (USD)
        },
        {
          "etf_ticker": "BOSERA&HASHKEY",             // ETF ticker
          "flow_usd": 61117310                        // Capital inflow for this ETF (USD)
        }
      ]
    }
  ]
}

```


# ETF - Bitcoin ETF - ETF NetAssets History


```
GET /api/etf/bitcoin/net-assets/history
```


This endpoint provides historical data on the net assets of Bitcoin Exchange-Traded Funds (ETFs).

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                           |
| ------ | ------ | --------- | ------------------------------------- |
| ticker | string | NO        | ETF ticker symbol (e.g., GBTC, IBIT). |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "net_assets_usd": 51671409241.39,         // Net asset value (USD)
      "change_usd": 655300000,                  // Daily capital change (USD)
      "timestamp": 1704931200000,               // Date (timestamp in milliseconds)
      "price_usd": 46337.8                      // BTC price on that date (USD)
    },
    {
      "net_assets_usd": 51874409241.39,         // Net asset value (USD)
      "change_usd": 203000000,                  // Daily capital change (USD)
      "timestamp": 1705017600000,               // Date (timestamp in milliseconds)
      "price_usd": 42788.9                      // BTC price on that date (USD)
    }
  ]
}

```


# ETF - Bitcoin ETF - ETF Flows History


```
GET /api/etf/bitcoin/flow-history
```


This endpoint provides historical flow data for Bitcoin Exchange-Traded Funds (ETFs), including daily net inflows and outflows in USD, closing prices, and flow breakdowns by individual ETF tickers.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "timestamp": 1704931200000,                   // Date (timestamp in milliseconds)
      "flow_usd": 655300000,                         // Total daily capital flow (USD)
      "price_usd": 46663,                            // BTC current price (USD)
      "etf_flows": [                                 // ETF capital flow breakdown
        {
          "etf_ticker": "GBTC",                      // ETF ticker
          "flow_usd": -95100000                      // Capital outflow (USD)
        },
        {
          "etf_ticker": "IBIT",                      // ETF ticker
          "flow_usd": 111700000                      // Capital inflow (USD)
        },
        {
          "etf_ticker": "FBTC",                      // ETF ticker
          "flow_usd": 227000000                      // Capital inflow (USD)
        }
      ]
    }
  ]
}

```


# ETF - Bitcoin ETF - ETF Premium/Discount History


```
GET /api/etf/bitcoin/premium-discount/history
```


This endpoint provides historical data on the premium or discount rates of Bitcoin Exchange-Traded Funds (ETFs), including Net Asset Value (NAV), market price, and premium/discount percentages for each ETF ticker.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                           |
| ------ | ------ | --------- | ------------------------------------- |
| ticker | string | NO        | ETF ticker symbol (e.g., GBTC, IBIT). |


**Response Data:**

```json
{
  "code": "0",                                    
  "msg": "success",                               
  "data": [
    {
      "timestamp": 1706227200000,                 // Date (timestamp in milliseconds)
      "list": [
        {
          "ticker": "GBTC",                       // ETF ticker
          "nav_usd": 37.51,                        // Net Asset Value (USD)
          "market_price_usd": 37.51,               // Market price (USD)
          "premium_discount_details": 0            // Premium/Discount percentage
        },
        {
          "ticker": "IBIT",                       // ETF ticker
          "nav_usd": 23.94,                        // Net Asset Value (USD)
          "market_price_usd": 23.99,               // Market price (USD)
          "premium_discount_details": 0.22         // Premium/Discount percentage
        },
        {
          "ticker": "FBTC",                       // ETF ticker
          "nav_usd": 36.720807,                    // Net Asset Value (USD)
          "market_price_usd": 36.75,               // Market price (USD)
          "premium_discount_details": 0.0795       // Premium/Discount percentage
        }
      ]
    }
  ]
}

```


# ETF - Bitcoin ETF - ETF History


```
GET /api/etf/bitcoin/history
```


This endpoint provides historical data for Bitcoin Exchange-Traded Funds (ETFs), including key information such as market price, Net Asset Value (NAV), premium/discount percentage, shares outstanding, and net assets for each ETF ticker.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                           |
| ------ | ------ | --------- | ------------------------------------- |
| ticker | string | YES       | ETF ticker symbol (e.g., GBTC, IBIT). |


**Response Data:**

```json
{
  "code": "0",                                
  "msg": "success",                          
  "data": [
    {
      "assets_date": 1706486400000,           // Net asset date (timestamp in milliseconds)
      "btc_holdings": 496573.8166,            // BTC holdings
      "market_date": 1706486400000,           // Market price date (timestamp in milliseconds)
      "market_price": 38.51,                  // Market price (USD)
      "name": "Grayscale Bitcoin Trust",      // ETF name
      "nav": 38.57,                           // Net Asset Value per share (USD)
      "net_assets": 21431132778.35,           // Total net assets (USD)
      "premium_discount": -0.16,              // Premium/discount percentage
      "shares_outstanding": 555700100,        // Total shares outstanding
      "ticker": "GBTC"                        // ETF ticker
    }
  ]
}

```


# ETF - Bitcoin ETF - ETF Price History


```
GET /api/etf/bitcoin/price/history
```


This endpoint provides historical price data for Bitcoin Exchange-Traded Funds (ETFs), including open, high, low, and close (OHLC) prices, along with trading volume for each data point.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                                |
| ------ | ------ | --------- | ------------------------------------------ |
| ticker | string | YES       | ETF ticker symbol (e.g., GBTC, IBIT).      |
| range  | string | YES       | Time range for the data (e.g., 1d,7d,all). |


**Response Data:**

```json
{
  "code": "0",
  "message": "success",
  "data": [
    {
      "time": 1731056460000,   // timestamp in milliseconds
      "open": 60.47,                // Opening price
      "high": 60.47,                // Highest price
      "low": 60.47,                 // Lowest price
      "close": 60.47,               // Closing price
      "volume": 100                // Trading volume
    },
    ...
  ]
}

```


# ETF - Bitcoin ETF - ETF Detail


```
GET /api/etf/bitcoin/detail
```


This endpoint provides detailed information on a Bitcoin Exchange-Traded Fund (ETF), including its key attributes and status.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name   | Type   | Mandatory | Description                           |
| ------ | ------ | --------- | ------------------------------------- |
| ticker | string | YES       | ETF ticker symbol (e.g., GBTC, IBIT). |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": {
    "ticker_info": {
      "id": 1,                                         // ETF ID
      "ticker": "GBTC",                                // ETF ticker symbol
      "name": "Grayscale Bitcoin Trust ETF",           // ETF name
      "market": "stocks",                              // Market type
      "region": "us",                                  // Region
      "primary_exchange": "ARCX",                      // Primary exchange
      "fund_type": "ETV",                              // Fund type
      "active": "true",                                // Whether the ETF is active
      "currency_name": "usd",                          // Currency name
      "cik_code": "0001588489",                        // CIK code
      "composite_figi": "BBG008748J88",                // Composite FIGI
      "share_class_figi": "BBG008748J97",              // Share class FIGI
      "phone_number": "212-668-1427",                  // Contact phone number
      "tag": "BTC",                                    // Asset tag
      "type2": "Spot",                                 // Additional product type
      "address": {
        "address_1": "{\"address2\":\"4TH FLOOR\",\"city\":\"STAMFORD\",\"address1\":\"290 HARBOR DRIVE\",\"state\":\"CT\",\"postal_code\":\"06902\"}"
      },                                               // Company address (as a JSON string)
      "sic_code": "6221",                              // SIC code
      "sic_description": "COMMODITY CONTRACTS BROKERS & DEALERS", // Industry description
      "ticker_root": "GBTC",                           // Ticker root
      "list_date": 1424822400000,                      // Listing date (timestamp in ms)
      "share_class_shares_outstanding": "240750100",   // Shares outstanding
      "round_lot": "100",                              // Round lot size
      "status": 1,                                     // Status
      "update_time": 1745224505000                     // Last update time (timestamp in ms)
    },
    "market_status": "early_trading",                  // Market status
    "name": "Grayscale Bitcoin Trust ETF",             // ETF name
    "ticker": "GBTC",                                  // ETF ticker
    "type": "stocks",                                  // Market type
    "session": {
      "change": 2.22,                                  // Price change
      "change_percent": 3.309,                         // Change percentage (%)
      "early_trading_change": 2.22,                    // Pre-market change
      "early_trading_change_percent": 3.309,           // Pre-market change percentage (%)
      "close": 67.09,                                  // Previous closing price
      "high": 67.56,                                   // Highest price
      "low": 66.15,                                    // Lowest price
      "open": 66.86,                                   // Opening price
      "volume": 1068092,                               // Trading volume
      "previous_close": 67.09,                         // Previous close
      "price": 69.31                                   // Latest price
    },
    "last_quote": {
      "last_updated": 1745226801708029700,             // Last update time (timestamp in nanoseconds)
      "timeframe": "REAL-TIME",                        // Timeframe type
      "ask": 69.29,                                    // Ask price
      "ask_size": 34,                                  // Ask size
      "ask_exchange": 8,                               // Ask exchange code
      "bid": 69.18,                                    // Bid price
      "bid_size": 3,                                   // Bid size
      "bid_exchange": 11                               // Bid exchange code
    },
    "last_trade": {
      "last_updated": 1745226730467043600,             // Last trade update time (timestamp in nanoseconds)
      "timeframe": "REAL-TIME",                        // Timeframe type
      "id": "62879131651684",                          // Trade ID
      "price": 69.31,                                  // Trade price
      "size": 30,                                      // Trade volume
      "exchange": 12,                                  // Exchange code
      "conditions": [12, 37]                           // Trade condition codes
    },
    "performance": {
      "low_price_52week": 39.56,                       // 52-week low
      "high_price_52week": 86.11,                      // 52-week high
      "high_price_52week_date": 1734238800000,         // 52-week high date (timestamp)
      "low_price_52week_date": 1722744000000,          // 52-week low date (timestamp)
      "ydt_change_percent": -12.23,                    // Year-to-date change (%)
      "year_change_percent": 13.98,                    // 1-year change (%)
      "avg_vol_usd_10d": 518227                        // 10-day average trading value (USD)
    }
  }
}

```


# ETF - Bitcoin ETF - ETF AUM


```
GET /api/futures/indicators/rsi
```


This endpoint provides historical Assets Under Management (AUM) data for Bitcoin ETFs

***Cache / Update Frequency:*** every 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 14 for RSI).             |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1704153600000,
      "aum_usd": 0
    },
    {
      "time": 1704240000000,
      "aum_usd": 0
    },
    ....
  ]
}

```


# ETF - Ethereum ETF - ETF NetAssets History


```
GET /api/etf/ethereum/net-assets/history
```


This endpoint provides historical net assets data for Ethereum-based Exchange-Traded Funds (ETFs).

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "net_assets_usd": 51671409241.39,         // Net asset value (USD)
      "change_usd": 655300000,                  // Daily capital change (USD)
      "timestamp": 1704931200000,               // Date (timestamp in milliseconds)
      "price_usd": 1637.8                      // ETH price on that date (USD)
    },
    {
      "net_assets_usd": 51874409241.39,         // Net asset value (USD)
      "change_usd": 203000000,                  // Daily capital change (USD)
      "timestamp": 1705017600000,               // Date (timestamp in milliseconds)
      "price_usd": 1637.8                      // ETH price on that date (USD)
    }
  ]
}

```


# ETF - Ethereum ETF - Ethereum ETF List


```
GET /api/etf/ethereum/list
```


This endpoint provides a list of key status information for Ethereum Exchange-Traded Funds (ETFs).

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "ticker": "ETHA",                                  // ETF ticker
      "name": "iShares Ethereum Trust ETF",              // ETF name
      "region": "us",                                    // Region
      "market_status": "closed",                         // Market status
      "primary_exchange": "XNAS",                        // Primary exchange
      "cik_code": "0002000638",                          // CIK code
      "type": "Spot",                                    // Type
      "market_cap": "544896000.00",                      // Market capitalization
      "list_date": 1721692800000,                        // Listing date
      "shares_outstanding": "28800000",                  // Shares outstanding
      "aum": "",                                         // Assets under management
      "management_fee_percent": "0.25",                  // Management fee percentage
      "last_trade_time": 1722988779939,                  // Last trade time
      "last_quote_time": 1722988799379,                  // Last quote time
      "volume_quantity": 5592645,                        // Volume quantity
      "volume_usd": 106447049.343,                       // Volume in USD
      "price": 18.92,                                    // Market price
      "price_change": 0.67,                              // Price change
      "price_change_percent": 3.67,                      // Price change percentage
      "asset_info": {
        "nav": 18.11,                                  // Net asset value
        "premium_discount": 0.77,                      // Premium/discount
        "holding_quantity": 237882.8821,                 // Holding quantity
        "change_percent_1d": 0,                        // 1-day change percentage
        "change_quantity_1d": 0,                         // 1-day change quantity
        "change_percent_7d": 56.69,                    // 7-day change percentage
        "change_quantity_7d": 86060.9115,                // 7-day change quantity
        "date": "2024-08-05"                           // Data date
      },
      "update_time": 1722995656637                       // Update time
    }
  ]
}

```


# ETF - Ethereum ETF - ETF Flows History


```
GET /api/etf/ethereum/flow-history
```


This endpoint provides a list of key status information regarding the history of ETF flows.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1721692800000,
      "flow_usd": 106600000,
      "price_usd": 3438.09,
      "etf_flows": [
        {
          "etf_ticker": "ETHA",
          "flow_usd": 266500000
        },
        {
          "etf_ticker": "FETH",
          "flow_usd": 71300000
        },
      ]
    }
  ]
}

```


# ETF - Grayscale - Holdings List


```
GET /api/grayscale/holdings-list
```


This endpoint provides a list of holdings managed by Grayscale Investments.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "ETH",                                  // Token symbol, 
      "primary_market_price": 29.89,                    // Price in the primary market 
      "secondary_market_price": 29.71,                  // Price in the secondary market 
      "premium_rate": -0.6,                             // Premium rate (%),
      "holdings_amount": 2630007.61026,                 // Current holding amount (in tokens)
      "holdings_usd": 4290752215.8347797,               // Total market value of holdings in USD
      "holdings_amount_change_30d": 0,                  // Change in holding amount over the past 30 days (in tokens)
      "holdings_amount_change_7d": 0,                   // Change in holding amount over the past 7 days (in tokens)
      "holdings_amount_change1d": 0,                    // Change in holding amount over the past 1 day (in tokens)
      "close_time": 1721422800000,                      // Market close timestamp (milliseconds)
      "update_time": 1745203812007                      // Data update timestamp (milliseconds)
    },
    {
      "symbol": "ETC",                                  // Token symbol, e.g., ETC = Ethereum Classic
      "primary_market_price": 11.99,                    // Price in the primary market
      "secondary_market_price": 6.63,                   // Price in the secondary market
      "premium_rate": -44.7,                            // Premium rate, currently at a significant discount
      "holdings_amount": 11181376.733556,               // Current holding amount (in tokens)
      "holdings_usd": 181440200.2554132,                // Total market value of holdings in USD
      "holdings_amount_change_30d": -20697.669828,      // Change in holding amount over the past 30 days
      "holdings_amount_change_7d": -4596.123672,        // Change in holding amount over the past 7 days
      "holdings_amount_change1d": 0,                    // Change in holding amount over the past 1 day
      "close_time": 1744923600000,                      // Market close timestamp
      "update_time": 1745203812168                      // Data update timestamp
    }
  ]
}

```


# ETF - Grayscale - Premium History


```
GET /api/grayscale/premium-history
```


This endpoint provides historical premium/discount data for Grayscale Investment Trusts relative to their NAV.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

# Respones Data

```json
{
  "code": "0",
  "msg": "success",
  "data": [
     {
      "primary_market_price": [     // Primary market price list
        0.14,
        0.14
        // ...
      ],
      "date_list": [                // Date list (timestamps)
        1380171600000,
        1380258000000
        // ...
      ],
      "secondary_market_price_list": [  // Secondary market price list
        0.57,
        0.53
        // ...
      ],
      "premium_rate_list": [          // Premium rate list
        19.37,
        15.59
        // ...
      ]
    },
      ....
  ]
}

```

 **Parameters:**
| Name   | Type   | Mandatory | Description                                                                    |
| ------ | ------ | --------- | ------------------------------------------------------------------------------ |
| symbol | string | YES       | Supported values: ETC, LTC, BCH, SOL, XLM, LINK, ZEC, MANA, ZEN, FIL, BAT, LPT |


# ETF - Solana ETF - ETF Flows History


```
GET /api/etf/solana/flow-history
```


This endpoint provides a list of key status information regarding the history of ETF flows.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1762473600000,
      "flow_usd": 12700000,
      "price_usd": 155.2,
      "etf_flows": [
        {
          "etf_ticker": "BSOL",
          "flow_usd": 11700000
        },
        {
          "etf_ticker": "VSOL"
        },
        {
          "etf_ticker": "FSOL"
        },
        {
          "etf_ticker": "TSOL"
        },
        {
          "etf_ticker": "GSOL",
          "flow_usd": 1000000
        }
      ]
    },
  ]
}

```


# ETF - XRP ETF - ETF Flows History


```
GET /api/etf/xrp/flow-history
```


This endpoint provides a list of key status information regarding the history of ETF flows.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1763078400000,
      "flow_usd": 243050000,
      "price_usd": 2.3212,
      "etf_flows": [
        {
          "etf_ticker": "XRPC",
          "flow_usd": 243050000
        },
        {
          "etf_ticker": "XRPZ"
        },
        {
          "etf_ticker": "XRP"
        },
        {
          "etf_ticker": "GXRP"
        }
      ]
    },
  ]
}

```


# Indic - Futures - Coin RSI List


```
GET /api/futures/rsi/list
```


This endpoint provides the Relative Strength Index (RSI) values for multiple cryptocurrencies across different timeframes.

***Cache / Update Frequency:*** every 10 second for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ❌       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "symbol": "BTC",                                  // Token symbol, e.g., BTC = Bitcoin
      "rsi_15m": 54.71,                                 // RSI (Relative Strength Index) over 15 minutes
      "price_change_percent_15m": 0.04,                 // Price change percentage over 15 minutes
      "rsi_1h": 71.91,                                  // RSI over 1 hour
      "price_change_percent_1h": -0.23,                 // Price change percentage over 1 hour
      "rsi_4h": 72.12,                                  // RSI over 4 hours
      "price_change_percent_4h": -0.09,                 // Price change percentage over 4 hours
      "rsi_12h": 62.33,                                 // RSI over 12 hours
      "price_change_percent_12h": 2.72,                 // Price change percentage over 12 hours
      "rsi_24h": 57.88,                                 // RSI over 24 hours
      "price_change_percent_24h": 3.4,                  // Price change percentage over 24 hours
      "rsi_1w": 52.04,                                  // RSI over 1 week
      "price_change_percent_1w": 2.6,                   // Price change percentage over 1 week
      "current_price": 87348.6                          // Current market price
    },
    {
      "symbol": "ETH",                                  // Token symbol, e.g., ETH = Ethereum
      "rsi_15m": 54.35,                                 // RSI over 15 minutes
      "price_change_percent_15m": -0.13,                // Price change percentage over 15 minutes
      "rsi_1h": 67.93,                                  // RSI over 1 hour
      "price_change_percent_1h": -0.26,                 // Price change percentage over 1 hour
      "rsi_4h": 63.6,                                   // RSI over 4 hours
      "price_change_percent_4h": 0.2,                   // Price change percentage over 4 hours
      "rsi_12h": 52.09,                                 // RSI over 12 hours
      "price_change_percent_12h": 3.41,                 // Price change percentage over 12 hours
      "rsi_24h": 45.03,                                 // RSI over 24 hours
      "price_change_percent_24h": 3.27,                 // Price change percentage over 24 hours
      "rsi_1w": 33.31,                                  // RSI over 1 week
      "price_change_percent_1w": 3.45,                  // Price change percentage over 1 week
      "current_price": 1641.36                          // Current market price
    }
  ]
}

```


# Indic - Futures - Pair RSI


```
GET /api/futures/indicators/rsi
```


This endpoint provides RSI values for trading pairs .

***Cache / Update Frequency:*** Real time for all the API plans..

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1759287600000,
      "rsi_value": 59.32633395
    },
    {
      "time": 1759291200000,
      "rsi_value": 60.90396216
    },
}

```

 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 14 for RSI).             |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |


# Indic - Futures - Moving Average (MA)


```
GET /api/futures/indicators/ma
```


This endpoint provides Moving Average (MA) for trading pairs .

***Cache / Update Frequency:*** Real time for all the API plans..

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1759287600000,
      "ma_value": 114209.64
    },
    {
      "time": 1759291200000,
      "ma_value": 114200.6
    },
}

```

 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 10 for MA).              |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |


# Indic - Futures - Exponential Moving Average (EMA)


```
GET /api/futures/indicators/ema
```


This endpoint provides Exponential Moving Average (EMA) for trading pairs .

***Cache / Update Frequency:*** Real time for all the API plans..

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1759287600000,
      "ema_value": 114209.64
    },
    {
      "time": 1759291200000,
      "ema_value": 114200.6
    },
}

```

 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 10 for EMA).             |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |


# Indic - Futures - Bollinger Bands (BOLL)


```
GET /api/futures/indicators/boll
```


This endpoint provides Bollinger Bands (BOLL) for trading pairs .

***Cache / Update Frequency:*** Real time for all the API plans..

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1759287600000,
      "mb_value": 114209.633,
      "ub_value": 114626.49,
      "lb_value": 113792.776
    },
    {
      "time": 1759291200000,
      "mb_value": 114200.6,
      "ub_value": 114611.931,
      "lb_value": 113789.269
    },
}

```

 **Parameters:**
| Name        | Type    | Mandatory | Description                                                                                                    |
| ----------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange    | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol      | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval    | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit       | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time  | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time    | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| series_type | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |
| window      | integer | NO        | Window size — defines the number of data points used for indicator calculation (e.g., 20 for BOLL).            |
| mult        | number  | NO        | mult: Standard deviation multiplier that defines the width of the Bollinger Bands. Default is 2.               |


# Indic - Futures - Moving Average Convergence Divergence (MACD)


```
GET /api/futures/indicators/macd
```


This endpoint provides Moving Average Convergence Divergence (MACD) for trading pairs .

***Cache / Update Frequency:*** Real time for all the API plans..

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1759352400000,
      "macd_value": 1200.54
    },
    {
      "time": 1759356000000,
      "macd_value": 1175.91
    },
}

```

 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                                    |
| ------------- | ------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| exchange      | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'support-exchange-pair' API. |
| symbol        | string  | YES       |  Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'support-exchange-pair' API.                   |
| interval      | string  | YES       | Time interval for data aggregation.  Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w       |
| limit         | string  | NO        | Number of results per request.  Default: 1000, Maximum: 4500                                                   |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                         |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                           |
| series_type   | string  | NO        | Price type used in calculation. Supported values: open, high, low, close. Default: close.                      |
| fast_window   | integer | NO        | Fast period window size used for indicator calculation (e.g., 12 for MACD).                                    |
| slow_window   | integer | NO        | Slow period window size used for indicator calculation (e.g., 26 for MACD).                                    |
| signal_window | integer | NO        | Signal line window size used to smooth the fast–slow difference (e.g., 9 for MACD).                            |


# Indic - Futures - Futures Basis


```
GET /api/futures/basis/history
```


This endpoint provides historical futures basis data, including open and close basis rates and their corresponding annualized percentage changes over time.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |


 **Parameters:**
| Name       | Type   | Mandatory | Description                                                                                                      |
| ---------- | ------ | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w.             |
| limit      | string | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                                     |
| start_time | string | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | string | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1741629600000,            // Timestamp (in milliseconds)
      "open_basis": 0.0504,             // Opening basis (%) - the basis at the start of the interval
      "close_basis": 0.0445,            // Closing basis (%) - the basis at the end of the interval
      "open_change": 39.5,              // Percentage change in basis at opening compared to previous period
      "close_change": 34.56             // Percentage change in basis at closing compared to previous period
    },
    {
      "time": 1741633200000,            // Timestamp (in milliseconds)
      "open_basis": 0.0446,             // Opening basis (%)
      "close_basis": 0.03,              // Closing basis (%)
      "open_change": 34.65,             // Opening basis change (%)
      "close_change": 23.74             // Closing basis change (%)
    }
  ]
}

```


# Indic - Futures - Whale Index


```
GET /api/futures/whale-index/history
```


This endpoint provides historical Whale Index data.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1665532800000,
      "whale_index_value": -184.8
    },
    {
      "time": 1665619200000,
      "whale_index_value": -118.965
    },
    {
      "time": 1665705600000,
      "whale_index_value": -58.795
    },
    {
      "time": 1665792000000,
      "whale_index_value": -84.095
    },
}

```

 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                                      |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Futures exchange names (e.g., Binance, OKX) .Retrieve supported exchanges via the 'supported-exchange-pair' API. |
| symbol     | string  | YES       | Trading pair (e.g., BTCUSDT). Retrieve supported pairs via the 'supported-exchange-pair' API.                    |
| interval   | string  | YES       | Time interval for data aggregation. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w          |
| limit      | integer | NO        | Number of results per request. Default 1000, Max 1000                                                            |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                           |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                             |


# Indic - Futures - CGDI Index


```
GET /api/futures/cgdi-index/history  
```


This endpoint provides historical CGDI (CoinGlass Derivatives Index) data

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1704067200000,
      "cgdi_index_value": 1000
    },
    {
      "time": 1704153600000,
      "cgdi_index_value": 1053.2551
    },
  ]
}

```


# Indic - Futures - CDRI Index


```
GET /api/futures/cdri-index/history 
```


This endpoint provides historical CDRI (CoinGlass Derivatives Risk Index) data.

***Cache / Update Frequency:*** every 1 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "time": 1646438400000,
      "cdri_index_value": 50
    },
    {
      "time": 1646524800000,
      "cdri_index_value": 47
    },
  ]
}

```


# Indic - Spots - Coinbase Premium Index


```
GET /api/coinbase-premium-index
```


This endpoint provides the Coinbase Bitcoin Premium Index, which indicates the price difference between Bitcoin on Coinbase Pro and Binance.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

<br />


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                          |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000,         // Timestamp (in seconds)
      "premium": 5.55,            // Premium amount (USD)
      "premium_rate": 0.0261      // Premium rate (e.g., 0.0261 = 2.61%)

    },
    {
       "time": 1658880000,         // Timestamp (in seconds)
       "premium": 5.55,            // Premium amount (USD)
       "premium_rate": 0.0261      // Premium rate (e.g., 0.0261 = 2.61%)

    }
  ]
}
```


# Indic - Spots - Bitfinex Margin Long/Short


```
GET /api/bitfinex-margin-long-short
```


This endpoint provides data on margin long and short positions from Bitfinex.

***Cache / Update Frequency:*** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans          | Hobbyist | Startup  | Standard | Professional | Enterprise |
| :------------- | :------- | :------- | :------- | :----------- | :--------- |
| Available      | ✅        | ✅        | ✅        | ✅            | ✅          |
| interval Limit | ​`>=4h`  | ​`>=30m` | No Limit | No Limit     | No Limit   |

<br />


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                          |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| symbol     | string  | YES       | BTC,ETH                                                                                              |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                               |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |


**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "time": 1658880000,              // Timestamp, representing the data's corresponding time point
      "long_quantity": 104637.94,       // Long position quantity
      "short_quantity": 2828.53        // Short position quantity
    },
    {
      "time": 1658966400,              // Timestamp, representing the data's corresponding time point
      "long_quantity": 105259.46,       // Long position quantity
      "short_quantity": 2847.84        // Short position quantity
    }
    // More data entries...
  ]
}

```


# Indic - Spots - Borrow Interest Rate


```
GET /api/borrow-interest-rate/history
```


This endpoint provides daily borrowing interest rates for cryptocurrencies.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |

<br />


 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                          |
| ---------- | ------- | --------- | ---------------------------------------------------------------------------------------------------- |
| exchange   | string  | YES       | Exchange name  support:Binance ,OKX,Bybit                                                            |
| symbol     | string  | YES       | Trading coin (e.g., BTC). Retrieve supported coins via the 'supported-coins' API.                    |
| interval   | string  | YES       | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit      | integer | NO        | Number of results per request. Default: 1000, Maximum: 1000.                                         |
| start_time | integer | NO        |  Start timestamp in milliseconds (e.g., 1641522717000).                                              |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                 |


**Response Data:**

```json
{
  "code": "0",                             
  "msg": "success",                         
  "data": [
    {
      "time": 1741636800,                  // Timestamp (in seconds)
      "interest_rate": 0.002989            // daily Interest rate
    },
    {
      "time": 1741640400,                  // Timestamp (in seconds)
      "interest_rate": 0.002989            // daily Interest rate
    }
  ]
}

```


# Indic - Other - AHR999


```
GET /api/index/ahr999
```


This endpoint provides data for AHR999, including the average value, AHR999 value, and corresponding values for different dates.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "date_string": "2011/02/01",            // Date in string format (YYYY/MM/DD)
      "average_price": 0.1365,                // Average price on the given date
      "ahr999_value": 4.441692296429609,      // AHR999 index value
      "current_value": 0.626                  // Current value on the given date
    },
    {
      "date_string": "2011/02/02",            // Date in string format (YYYY/MM/DD)
      "average_price": 0.1383,                // Average price on the given date
      "ahr999_value": 5.642181244439729,      // AHR999 index value
      "current_value": 0.713                  // Current value on the given date
    }
    // More data entries...
  ]
}

```


# Indic - Other - Bull Market Peak Indicators


```
GET /api/bull-market-peak-indicator
```


This endpoint provides a list of Bull Market Peak Indicators

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "indicator_name": "Bitcoin Ahr999 Index",  // Indicator name
      "current_value": "0.78",                  // Current value
      "target_value": "4",                      // Target value
      "previous_value": "0.77",                 // Previous value
      "change_value": "0.0009811160359081",     // Change value
      "comparison_type": ">=",                  // Comparison type
      "hit_status": false                       // Hit status (whether the target condition is met)
    },
    {
      "indicator_name": "Pi Cycle Top Indicator",  // Indicator name
      "current_value": "85073.0",                  // Current value
      "target_value": "154582",                    // Target value
      "previous_value": "85127.0",                 // Previous value
      "change_value": "-54.0",                     // Change value
      "comparison_type": ">=",                     // Comparison type
      "hit_status": false                          // Hit status (whether the target condition is met)
    }
  ]
}

```


# Indic - Other - Puell-Multiple


```
GET /api/index/puell-multiple
```


This endpoint provides the Puell-Multiple index, which includes data on buy and sell quantities, the price, and the Puell-Multiple value at specific timestamps.

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                              
  "msg": "success",                        
  "data": [
    {
      "timestamp": 1282003200000,           // Timestamp (in milliseconds)
      "price": 0.07,                         // Price on the given day
      "puell_multiple": 1                   // Puell Multiple value
    },
    {
      "timestamp": 1282089600000,           // Timestamp (in milliseconds)
      "price": 0.068,                        // Price on the given day
      "puell_multiple": 1.0007745933384973  // Puell Multiple value
    }
    ...
  ]
}

```


# Indic - Other - Stock-to-Flow Model


```
GET /api/index/stock-flow
```


This endpoint provides data for the Stock-to-Flow model, including the price and the number of days remaining until the next halving event for specific timestamps.

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "timestamp": 1282003200000,       // Timestamp (in milliseconds)
      "price": 0.07,                     // Price on the given day
      "next_halving": 834               // Days remaining until the next halving
    },
    {
      "timestamp": 1282089600000,       // Timestamp (in milliseconds)
      "price": 0.068,                    // Price on the given day
      "next_halving": 833               // Days remaining until the next halving
    }

  ]
}

```


# Indic - Other - Pi Cycle Top Indicator


```
GET /api/index/pi-cycle-indicator
```


This endpoint provides data for the Pi Cycle Top Indicator, including the 111-day moving average (ma110), the 350-day moving average multiplied by 2 (ma350Mu2), and the price at specific timestamps.

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                             
  "msg": "success",                       
  "data": [
    {
      "ma_110": 0.07,                     // 110-day moving average price
      "timestamp": 1282003200000,        // Timestamp (milliseconds)
      "ma_350_mu_2": 0.14,               // 2x value of 350-day moving average
      "price": 0.07                      // Daily price
    },
    {
      "ma_110": 0.069,                   // 110-day moving average price
      "timestamp": 1282089600000,        // Timestamp (milliseconds)
      "ma_350_mu_2": 0.138,              // 2x value of 350-day moving average
      "price": 0.068                     // Daily price
    }
  ]
}

```


# Indic - Other - Golden-Ratio-Multiplier


```
GET /api/index/golden-ratio-multiplier
```


This endpoint provides data for the Golden Ratio Multiplier

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "low_bull_high_2": 0.14,                       // Bull market low-high ratio coefficient
      "timestamp": 1282003200000,                    // Timestamp (in milliseconds)
      "price": 0.07,                                 // Current price
      "ma_350": 0.07,                                // 350-day moving average
      "accumulation_high_1_6": 0.11200000000000002,  // Accumulation high ratio (1/6 golden ratio)
      "x_3": 0.21000000000000002,                    // Golden ratio multiple x3
      "x_5": 0.35000000000000003,                    // Golden ratio multiple x5
      "x_8": 0.56,                                   // Golden ratio multiple x8
      "x_13": 0.9100000000000001,                    // Golden ratio multiple x13
      "x_21": 1.4700000000000002                     // Golden ratio multiple x21
    },
    ...
  ]
}

```


# Indic - Other - Bitcoin Profitable Days


```
GET /api/index/bitcoin/profitable-days
```


This endpoint provides data for the Bitcoin Profitable Days

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                              
  "msg": "success",                        
  "data": [
    {
      "side": 1,                              // Trade direction, 1 represents buy, 0 represents sell
      "timestamp": 1282003200000,             // Timestamp (in milliseconds)
      "price": 0.07                           // Price
    },
    {
      "timestamp": 1282089600000,             // Timestamp (in milliseconds)
      "price": 0.068,                         // Price
      "side": 1                               // Trade direction, 1 represents buy, 0 represents sell
    }
  ]
}

```


# Indic - Other - Bitcoin-Rainbow-Chart


```
GET /api/index/bitcoin/rainbow-chart
```


This endpoint provides data for the Bitcoin Rainbow Chart

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                              
  "msg": "success",                        
  "data": [
    [
      0.07,                                 // Current price
      0.033065,                             // Minimum value of shadow
      0.044064,                             // First layer
      0.059892,                             // Second layer
      0.082219,                             // Third layer
      0.110996,                             // Fourth layer
      0.149845,                             // Fifth layer
      0.205865,                             // Sixth layer
      0.283454,                             // Seventh layer
      0.380525,                             // Eighth layer
      0.517626,                             // Ninth layer
      1282003200000                        // Timestamp
    ]
  ]
}

```


# Indic - Other - Crypto Fear & Greed Index


```
GET /api/index/fear-greed-history
```


This endpoint provides data for the Crypto Fear & Greed Index

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                             
  "msg": "success",                        
  "data": [
    {
      "data_list": [4611285.1141, ...],         // Fear and Greed Index values
      "price_list": [4788636.51145, ...],         // Corresponding price data
      "time_list": [1636588800, ...]        // Timestamps
    }
  ]
}

```


# Indic - Other - StableCoin MarketCap History


```
GET /api/index/stableCoin-marketCap-history
```


This endpoint provides data for the StableCoin MarketCap History

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                             
  "msg": "success",                        
  "data": [
    {
      "data_list": [4611285.1141, ...],         // List of values
      "price_list": [, ...],                    // List of prices
      "time_list": [1636588800, ...]            // List of timestamps
    }
  ]
}

```


# Indic - Other - Bitcoin Bubble Index


```
GET /api/index/bitcoin/bubble-index
```


This endpoint provides data for the Bitcoin Bubble Index

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "price": 0.0495,                          // Current price
      "bubble_index": -29.59827206,             // Bubble index
      "google_trend_percent": 0.0287,           // Google trend percentage
      "mining_difficulty": 181.543,             // Mining difficulty
      "transaction_count": 235,                 // Transaction count
      "address_send_count": 390,                // Address send count
      "tweet_count": 0,                         // Tweet count
      "date_string": "2010-07-17"               // Date string
    },
    {
      "price": 0.0726,                          // Current price
      "bubble_index": -29.30591863,             // Bubble index
      "google_trend_percent": 0.0365,           // Google trend percentage
      "mining_difficulty": 181.543,             // Mining difficulty
      "transaction_count": 248,                 // Transaction count
      "address_send_count": 424,                // Address send count
      "tweet_count": 0,                         // Tweet count
      "date_string": "2010-07-18"               // Date string
    }
  ]
}

```


# Indic - Other - Tow Year Ma Multiplier


```
GET /api/index/2-year-ma-multiplier
```


This endpoint provides data for the Tow Year Ma Multiplier

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                              
  "msg": "success",                         
  "data": [
    {
      "timestamp": 1282003200000,               // Timestamp (in milliseconds)
      "price": 0.07,                            // Current price
      "moving_average_730": 0.07,               // 2-year moving average (730 represents the period)
      "moving_average_730_multiplier_5": 0.35000000000000003, // 5 times the 2-year moving average (Multiplier)
    }
  ]
}

```


# Indic - Other - 200-Week Moving Avg Heatmap


```
GET /api/index/200-week-moving-average-heatmap
```


This endpoint provides data for the 200-Week Moving Avg Heatmap

***Cache / Update Frequency:*** every day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ✅        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                              
  "msg": "success",                         
  "data": [
    {
      "timestamp": 1325203200000,          // Timestamp (in milliseconds)
      "price": 4.31063509000584,           // Current price
      "moving_average_1440": 4.143619070636635, // 200-week moving average (1440 represents the period)
      "moving_average_1440_ip": 0,         // Position of the moving average (IP indicator)
    }
  ]
}

```


# Indic - Other - Altcoin Season Index


```
GET /api/index/altcoin-season
```


This endpoint provides data for the altcoin season index

***Cache / Update Frequency:*** 5 minute for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1491177600000,
      "altcoin_index": 96,
      "altcoin_marketcap": 0
    },
    {
      "timestamp": 1491264000000,
      "altcoin_index": 100,
      "altcoin_marketcap": 0
    },
    {
      "timestamp": 1491350400000,
      "altcoin_index": 96,
      "altcoin_marketcap": 0
    },
}

```


# Indic - Other - Bitcoin Short Term Holder SOPR


```
GET /api/index/bitcoin-sth-sopr
```


This endpoint provides data for the bitcoin short term holder sopr

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1255305600000,
      "price": 0.00110205,
      "sth_sopr": 45.98748129
    },
    {
      "timestamp": 1255651200000,
      "price": 0.00124491,
      "sth_sopr": 1.24312355
    },
    {
      "timestamp": 1255824000000,
      "price": 0.00122546,
      "sth_sopr": 1.04147332
    },
}

```


# Indic - Other - Bitcoin Long Term Holder SOPR


```
GET /api/index/bitcoin-lth-sopr
```


This endpoint provides data for the bitcoin long term holder sopr

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1255305600000,
      "price": 0.00110205,
      "lth_sopr": 45.98748129
    },
    {
      "timestamp": 1255651200000,
      "price": 0.00124491,
      "lth_sopr": 1.24312355
    },
    {
      "timestamp": 1255824000000,
      "price": 0.00122546,
      "lth_sopr": 1.04147332
    },
}

```


# Indic - Other - Bitcoin Short Term Holder Realized Price


```
GET /api/index/bitcoin-sth-realized-price
```


This endpoint provides data for the bitcoin short term holder realized price

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1325376000000,
      "price": 4.61211781,
      "sth_realized_price": 4.8958766225
    },
    {
      "timestamp": 1325462400000,
      "price": 5.13201225,
      "sth_realized_price": 4.8806352365
    },
    {
      "timestamp": 1325548800000,
      "price": 5.21773083,
      "sth_realized_price": 4.8736945702
    },
}

```


# Indic - Other - Bitcoin Long Term Holder Realized Price


```
GET /api/index/bitcoin-lth-realized-price
```


This endpoint provides data for the bitcoin long term holder realized price

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1325376000000,
      "price": 4.61211781,
      "lth_realized_price": 4.8958766225
    },
    {
      "timestamp": 1325462400000,
      "price": 5.13201225,
      "lth_realized_price": 4.8806352365
    },
    {
      "timestamp": 1325548800000,
      "price": 5.21773083,
      "lth_realized_price": 4.8736945702
    },
}

```


# Indic - Other - Bitcoin Short Term Holder Supply


```
GET /api/index/bitcoin-short-term-holder-supply
```


This endpoint provides data for the bitcoin short term holder supply

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 10.8584714558738,
      "short_term_holder_supply": 3682358,
      "timestamp": 1313625600000
    },
    {
      "price": 11.6704730432496,
      "short_term_holder_supply": 3682497,
      "timestamp": 1313712000000
    },
    {
      "price": 11.4597317393337,
      "short_term_holder_supply": 3680156,
      "timestamp": 1313798400000
    },
    {
      "price": 11.3544813407364,
      "short_term_holder_supply": 3684825,
      "timestamp": 1313884800000
    },
}

```


# Indic - Other - Bitcoin Long Term Holder Supply


```
GET /api/index/bitcoin-long-term-holder-supply
```


This endpoint provides data for the bitcoin long term holder supply

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 10.8584714558738,
      "long_term_holder_supply": 3395092,
      "timestamp": 1313625600000
    },
    {
      "price": 11.6704730432496,
      "long_term_holder_supply": 3401503,
      "timestamp": 1313712000000
    },
    {
      "price": 11.4597317393337,
      "long_term_holder_supply": 3411444,
      "timestamp": 1313798400000
    },
}

```


# Indic - Other - Bitcoin RHODL Ratio


```
GET /api/index/bitcoin-rhodl-ratio
```


This endpoint provides data for the bitcoin rhodl ratio

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 0.07,
      "rhodl_ratio": 0.19768584894587235,
      "timestamp": 1282003200000
    },
    {
      "price": 0.068,
      "rhodl_ratio": 0.3765371066876411,
      "timestamp": 1282089600000
    },
    {
      "price": 0.0667,
      "rhodl_ratio": 0.55947437296653,
      "timestamp": 1282176000000
    },
}

```


# Indic - Other - Bitcoin Reserve Risk


```
GET /api/index/bitcoin-reserve-risk
```


This endpoint provides data for the bitcoin reserve risk

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 0.07,
      "reserve_risk_index": 1.0463483830080946,
      "movcd": 0.0031006755142484214,
      "hodl_bank": 0.06689932448575159,
      "vocd": 0.0031006755142484214,
      "timestamp": 1282003200000
    },
    {
      "price": 0.068,
      "reserve_risk_index": 0.5285777367358181,
      "movcd": 0.006252211158717467,
      "hodl_bank": 0.12864711332703413,
      "vocd": 0.009403746803186513,
      "timestamp": 1282089600000
    },
    {
      "price": 0.0667,
      "reserve_risk_index": 0.3469505118474761,
      "movcd": 0.0031006755142484214,
      "hodl_bank": 0.19224643781278572,
      "vocd": 0.0018287503434234224,
      "timestamp": 1282176000000
    },
}

```


# Indic - Other - Bitcoin Active Addresses


```
GET /api/index/bitcoin-active-addresses
```


This endpoint provides data for the bitcoin active addresses

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1282003200000,
      "price": 0.07,
      "active_address_count": 494
    },
    {
      "timestamp": 1282089600000,
      "price": 0.068,
      "active_address_count": 726
    },
    {
      "timestamp": 1282176000000,
      "price": 0.0667,
      "active_address_count": 470
    },
}

```


# Indic - Other - Bitcoin New Addresses


```
GET /api/index/bitcoin-new-addresses
```


This endpoint provides data for the bitcoin new addresses

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1282003200000,
      "price": 0.07,
      "new_address_count": 331
    },
    {
      "timestamp": 1282089600000,
      "price": 0.068,
      "new_address_count": 415
    },
    {
      "timestamp": 1282176000000,
      "price": 0.0667,
      "new_address_count": 316
    },
}

```


# Indic - Other - Bitcoin Net Unrealized PNL


```
GET /api/index/bitcoin-net-unrealized-profit-loss
```


This endpoint provides data for the bitcoin net unrealized profit/loss (nupl)

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 0,
      "net_unpnl": 0,
      "timestamp": 1230940800000
    },
    {
      "price": 0,
      "net_unpnl": 0,
      "timestamp": 1231027200000
    },
    {
      "price": 0,
      "net_unpnl": 0,
      "timestamp": 1231113600000
    },
}

```


# Indic - Other - Bitcoin Correlations 


```
GET /api/index/bitcoin-correlation
```


This endpoint provides data for the bitcoin correlations (GLD, IWM, QQQ, SPY, TLT)

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1284508800000,
      "price": 0.06080235,
      "gld": -0.5150866328682138,
      "iwm": -0.4464952558926045,
      "qqq": 0,
      "spy": -0.38000905719099726,
      "tlt": 0.32525293786188403
    },
    {
      "timestamp": 1284595200000,
      "price": 0.0805732,
      "gld": -0.1441145695322488,
      "iwm": -0.390257896507018,
      "qqq": 0,
      "spy": -0.3562006006485584,
      "tlt": 0.25421749956089384
    },
    {
      "timestamp": 1284681600000,
      "price": 0.09079794,
      "gld": 0.18856803587350612,
      "iwm": -0.06826869030058404,
      "qqq": 0,
      "spy": -0.03849870412867858,
      "tlt": -0.02643535666282007
    },
}

```


# Indic - Other - Bitcoin Macro Oscillator (BMO)


```
GET /api/index/bitcoin-macro-oscillator
```


This endpoint provides data for the bitcoin macro oscillator (bmo)

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "price": 6.3162949999999976,
      "bmo_value": -0.25927286591542786,
      "timestamp": 1326067200000
    },
    {
      "price": 6.449687599999999,
      "bmo_value": -0.23528273675333555,
      "timestamp": 1326153600000
    },
    {
      "price": 6.899966666666668,
      "bmo_value": -0.17373343317542636,
      "timestamp": 1326240000000
    },
}

```


# Indic - Other - Options/Futures OI Ratio


```
GET /api/index/option-vs-futures-oi-ratio
```


This endpoint provides data for the options/futures oi ratio

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "btc_option_vs_futures_radio": 45.1,
      "eth_option_vs_futures_radio": 21.92,
      "timestamp": 1592956800000
    },
    {
      "btc_option_vs_futures_radio": 45.15,
      "eth_option_vs_futures_radio": 23.16,
      "timestamp": 1593043200000
    },
    {
      "btc_option_vs_futures_radio": 47.27,
      "eth_option_vs_futures_radio": 23.65,
      "timestamp": 1593129600000
    },
}

```


# Indic - Other - Bitcoin vs Global M2 Supply & Growth


```
GET /api/index/bitcoin-vs-global-m2-growth
```


This endpoint provides data for the bitcoin vs global m2 supply & growth

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1369008000000,
      "price": 117.8186364699,
      "global_m2_yoy_growth": 5.5654014717,
      "global_m2_supply": 59166686473105
    },
    {
      "timestamp": 1369612800000,
      "price": 126.392905903,
      "global_m2_yoy_growth": 5.8571414345,
      "global_m2_supply": 59490171457382
    },
    {
      "timestamp": 1370217600000,
      "price": 122.9491879018,
      "global_m2_yoy_growth": 6.7670545757,
      "global_m2_supply": 60072386054198
    },
}

```


# Indic - Other - Bitcoin vs US M2 Supply & Growth


```
GET /api/index/bitcoin-vs-us-m2-growth
```


This endpoint provides data for the bitcoin vs US m2 supply & growth

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1278979200000,
      "price": 0.06183332,
      "us_m2_yoy_growth": 0.1321,
      "us_m2_supply": 8639800000000
    },
    {
      "timestamp": 1279065600000,
      "price": 0.05815725,
      "us_m2_yoy_growth": 0.1321,
      "us_m2_supply": 8639800000000
    },
    {
      "timestamp": 1279152000000,
      "price": 0.05640261,
      "us_m2_yoy_growth": 0.1321,
      "us_m2_supply": 8639800000000
    },
}

```


# Indic - Other - Bitcoin Dominance


```
GET /api/index/bitcoin-dominance
```


This endpoint provides data for the bitcoin dominance

***Cache / Update Frequency:*** 1 day for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "timestamp": 1367366400000,
      "price": 139,
      "bitcoin_dominance": 94.3595,
      "market_cap": 1545031856
    },
    {
      "timestamp": 1367625600000,
      "price": 98.0999984741,
      "bitcoin_dominance": 93.8787,
      "market_cap": 1097883152
    },
    {
      "timestamp": 1367884800000,
      "price": 112.25,
      "bitcoin_dominance": 94.3851,
      "market_cap": 1240126128
    },
}

```


# Indic - Other - Exchanges Assets Transparency


```
GET /api/exchange_assets_transparency/list
```


This endpoint provides transparency data of exchange assets, including total balances, inflows, balance changes, open interest, leverage, and trading volume.

***Cache / Update Frequency:*** 1 hour

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |



**Response Data:**

```json
{
  "code": "0",                         // Status code
  "data": [
    {
      "exchange_name": "Binance",       //Exchange name
      "exchange_logo_url": "https://cdn.coinglasscdn.com/static/exchanges/270.png",  //Exchange Logo
      "balance_usd": 178382444198.04,   // Total balance
      "balance_change_usd_24h": -4244709940.9,  // 24h change
      "balance_change_usd_7d": 183489103818.63, // 7d change
      "inflow_usd_24h": 1104357008.908988,      // 24h inflow
      "inflow_usd_7d": 870098130.1614555,       // 7d inflow
      "open_interest": 28940016260,             // Open interest
      "average_leverage": 0.1622,               // Avg leverage
      "volume_usd": 114901619432                // Volume
    },
    {
      "exchange_name": "Bitfinex",              //Exchange Name
      "exchange_logo_url": "https://cdn.coinglasscdn.com/static/exchanges/bitfinex.jpg", //Exchange Logo
      "balance_usd": 25836820506.17,            // Total balance
      "balance_change_usd_24h": -164420313.45,  // 24h change
      "balance_change_usd_7d": 26135897993.59,  // 7d change
      "inflow_usd_24h": 225181636.35856062,     // 24h inflow
      "inflow_usd_7d": 706172180.891416,        // 7d inflow
      "open_interest": 732439767,               // Open interest
      "average_leverage": 0.0283,               // Avg leverage
      "volume_usd": 68891576                    // Volume
    }
  ]
}
```


# Indic - Other - Futures vs Spot Volume Ratio


```
GET /api/futures_spot_volume_ratio
```


This endpoint provides time-series data for the futures-to-spot trading volume ratio, including timestamp, volume ratio, futures trading volume (USD), and spot trading volume (USD).

**Cache / Update Frequency:** Real time for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name          | Type    | Mandatory | Description                                                                                             |
| ------------- | ------- | --------- | ------------------------------------------------------------------------------------------------------- |
| exchange_list | string  | YES       | List of exchange names to retrieve data from (e.g.,  'Binance, OKX, Bybit')                             |
| symbol        | string  | YES       | Trading coin (e.g., BTC).Retrieve supported coins via the 'support-coins' API.                          |
| interval      | string  | YES       | Time interval for data aggregation.Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w. |
| limit         | integer | NO        | Number of results per request.Default: 1000, Maximum: 1000.                                             |
| start_time    | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000).                                                  |
| end_time      | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).                                                    |


**Response Data:**

```json
{
  "code": "0",
  "data": [
  {
    "time": 1766588040000,        // timestamp (ms)
    "futures_spot_vol_ratio": 16.9974, // futures / spot volume ratio
    "futures_vol_usd": 59900899.685,   // futures volume (USD)
    "spot_vol_usd": 3524120.4165       // spot volume (USD)
  },
  {
    "time": 1766588100000,        // timestamp (ms)
    "futures_spot_vol_ratio": 9.0887,  // futures / spot volume ratio
    "futures_vol_usd": 24469968.832,   // futures volume (USD)
    "spot_vol_usd": 2692346.1708       // spot volume (USD)
  }
]
}
```


# Other - Financial Calendar - Economic Data


```
GET /api/calendar/economic-data
```


This endpoint provides data for the economic data

***Cache / Update Frequency:*** 10 minutes for all the API plans.

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |

<br />

**Response Data**

```json
{
  "code": "0",
  "data": [
    {
      "calendar_name": "Seasonally adjusted industrial output (MoM)(May)",
      "country_code": "SK",
      "country_name": "Korea",
      "data_effect": "Minor Impact",
      "forecast_value": "-0.1%",
      "revised_previous_value": "",
      "previous_value": "-0.9%",
      "publish_timestamp": 1751238000000,
      "published_value": "-2.9%",
      "importance_level": 1, //1,2,3
      "has_exact_publish_time": 1
    },
    {
      "calendar_name": "Industrial Output(YoY)(May)",
      "country_code": "SK",
      "country_name": "Korea",
      "data_effect": "Minor Impact",
      "forecast_value": "2.6%",
      "revised_previous_value": "",
      "previous_value": "4.9%",
      "publish_timestamp": 1751238000000,
      "published_value": "0.2%",
      "importance_level": 1,  //1,2,3
      "has_exact_publish_time": 1
    },
}

```

 **Parameters:**
| Name       | Type    | Mandatory | Description                                                                                            |
| ---------- | ------- | --------- | ------------------------------------------------------------------------------------------------------ |
| start_time | integer | NO        | Start timestamp in milliseconds. The maximum supported range is up to 15 days before the current time. |
| end_time   | integer | NO        | End timestamp in milliseconds. The maximum supported range is up to 15 days after the current time.    |
| language   | string  | NO        | Supported language :  'en' or  'zh'                                                                    |


# Other - News - News


```
GET /api/article/list
```


This endpoint provides an instant news (up to nearly 1000 news items).

***Cache / Update Frequency:*** Real-time updates

***This endpoint is available on the following*** [API plans](https://www.coinglass.com/pricing)：

| Plans     | Hobbyist | Startup | Standard | Professional | Enterprise |
| :-------- | :------- | :------ | :------- | :----------- | :--------- |
| Available | ❌        | ✅       | ✅        | ✅            | ✅          |


 **Parameters:**
| Name       | Type    | Mandatory | Description                                            |
| ---------- | ------- | --------- | ------------------------------------------------------ |
| start_time | integer | NO        | Start timestamp in milliseconds (e.g., 1641522717000). |
| end_time   | integer | NO        | End timestamp in milliseconds (e.g., 1641522717000).   |
| language   | string  | NO        | Supported languages: 'en', 'zh', 'zh-tw'               |
| page       | integer | NO        | Current page number                                    |
| per_page   | integer | NO        | Number of items returned per page                      |


**Response Data:**

```json
{
  "code": "0",
  "data": [
    {
      "article_picture":  "https://images.cointelegraph.com/images/528_aHR0cHM6Ly9zMy5jb2ludGVsZWdyYXBoLmNvbS91cGxvYWRzLzIwMjUtMDIvMDE5NTNkOTUtOTEyYi03MTE4LWE3NTEtNDRjNDExZWUzNmMy.jpg",  //Article Picture
      "article_title": "Crypto ETFs ‘punching above weight’ as almost half of ETF investers plan buys", // Article Title
      "article_content": "<p>Nearly h \n</blockquote> <!---->",  //Article Content
      "source_name": "COINTELEGRAPH",   // Source Name
      "source_website_logo": "https://cdn.coinglasscdn.com/news/coin_telegraph.png",   //Source Website Logo
      "article_release_time": 1762482358000, //Article Release Time
      "article_description": "<p>Bloomberg ETF analyst Eric Balchunas said it was “shocking” to see Schwab’s findings that crypto ETF investments could be on par with those in bond ETFs.</p>" // Article Description
    },

    {
      "article_picture": "https://images.cointelegraph.com/images/528_aHR0cHM6Ly9zMy5jb2ludGVsZWdyYXBoLmNvbS91cGxvYWRzLzIwMjUtMTEvMDE5YTViM2MtODFkOC03NWFhLTg2MjEtOGEyYmZjMDJhZDk0.jpg",
      "article_title": "Bitcoin at $100K is ‘speed bump’ to $56K, but data signals no signs of panic",
      "article_content": "<p data-ct-non-bby 2030.</p> <!---->",
      "source_name": "COINTELEGRAPH",
      "source_website_logo": "https://cdn.coinglasscdn.com/news/coin_telegraph.png",
      "article_release_time": 1762478945000,
      "article_description": "<p>Bloomberg analyst Mike McGlone says Bitcoin hitting $100,000 is “a speed bump” to $56,000, but other analysts say Bitcoin has bottomed out.</p>"
    },
  ]
}
```