CoinGlass Proxy API 3.1.33 -------------------------- This server provides unified access to CoinGlass market & analytics data (futures, spot, options, order book, ETF, on‑chain/exchange wallets). To request data, you must build the URL correctly. ============================================================ 1. REQUEST BUILDER (GENERAL RULES) ============================================================ FULL TEMPLATE https://coinglass2.api-proxy.ai/v1/{FUNCTION}?instrument={INSTRUMENT}&exchange={EXCHANGE}&exchanges={EXCHANGES}&timeFrame={TIMEFRAME}&range={RANGE}&unit={UNIT}&expiry={EXPIRY}&startTime={START_TIME}&endTime={END_TIME}&limit={LIMIT}&page={PAGE}&page_size={PAGE_SIZE}&format={FORMAT}&mode={MODE}&x={X} CONVENTION * All parameter names in this document are shown in CAPS inside braces (e.g., {TIMEFRAME}, {LIMIT}) to describe the contract. The actual query keys are lowercase (instrument, timeFrame, …), matching the Binance‑style reference. * Function names in the examples below are simplified for readability. Always consult Part 2 (Function Reference) for the exact endpoint path (e.g., `cg_futures_open_interest_history`) and its required/optional parameters. BEST PRACTICE * Recommended: include {MODE} and {FORMAT} explicitly (agent/direct and txt/json/pre/html/csv) in your queries. Explicit mode and format make debugging and logging easier. If omitted, the proxy will fall back to sensible defaults. ------------------------------------------------------------ REQUIRED ------------------------------------------------------------ {FUNCTION} * Logical function name of this proxy, e.g., openInterest_ohlc_history, fundingRate_ohlc_history, taker_buy_sell_volume_exchange_list, orderbook_ask_bids_history, spot_price_history, option_max_pain, etf_bitcoin_price_history, exchange_chain_tx_list, etc. * IMPORTANT: When constructing the URL, always consult Part 2 (Function Reference) for the specific endpoint’s required vs optional parameters. Do **not** assume a parameter is required unless Part 2 lists it as such. {INSTRUMENT} * IMPORTANT: Only instruments listed at `/instrument` are supported. * Canonical instrument (include **only** if required by the selected endpoint per Part 2). – Pair‑level endpoints expect BASE‑QUOTE (e.g., BTC‑USDT). The proxy strips the hyphen → BTCUSDT for upstream `instId/symbol`. – Coin‑level endpoints expect just the base coin (e.g., BTC, ETH). – Synonyms accepted: `instId`, `symbol`, `pair`. Both BTC‑USDT and BTCUSDT are accepted and normalized internally. ------------------------------------------------------------ OPTIONAL (UNIVERSAL) ------------------------------------------------------------ {TIMEFRAME} * Universal time parameter for time‑based endpoints. * Internally mapped to CoinGlass `INTERVAL` (candles/series) or `RANGE` (aggregation windows), depending on the endpoint. * Include **only** if the selected endpoint in Part 2 requires/accepts it. Allowed values are endpoint‑specific. {LIMIT} * Number of records (defaults/maximums are endpoint‑specific; typical histories support up to 1000). {PAGE} * Page number (default 1). {PAGE_SIZE} * Records per page (default typically 250; max typically 1000). {FORMAT} * txt, json, html, pre, csv (same semantics as in the Binance‑styled template). {MODE} * agent or direct (same semantics as in the Binance‑styled template). {X} * Access parameter. If present, the entire query string must be percent‑encoded (see §2, STEP 3). If no code is used, omit {X}. ------------------------------------------------------------ OPTIONAL (ENDPOINT‑SPECIFIC) ------------------------------------------------------------ {EXCHANGE} — Single exchange (e.g., Binance, OKX, Bybit, Hyperliquid). {EXCHANGES} — CSV list of exchanges (e.g., Binance,OKX) for aggregated endpoints. {RANGE} — Aggregation window for certain “exchange‑list / history‑chart” endpoints (e.g., 5m, 15m, 30m, 1h, 4h, 12h, 24h). {UNIT} — usd | coin (for OI/volumes and some series). {EXPIRY} — Options expiry date. Accepted formats: `YYYY‑MM‑DD` or `YYYYMMDD`. The proxy will normalize either form. {STATE} — Large‑limit‑order history: 1 = In Progress, 2 = Finish, 3 = Revoke. {MIN_LIQUIDATION_AMOUNT} — Minimum notional for liquidation orders (USD or coin if unit=coin). {CHAIN}, {TOKEN} — On‑chain wallets section (e.g., chain=Ethereum, token=USDT). {START_TIME}, {END_TIME} — Timestamps in ms (inclusive) for historical windows. ============================================================ 2. REQUEST ALGORITHM (STEP‑BY‑STEP) ============================================================ STEP 0 — CHECK PART 2 * In Part 2 (Function Reference), find the function and check its REQUIRED and OPTIONAL parameters, plus valid values (e.g., allowed {TIMEFRAME}/{RANGE}, whether {INSTRUMENT} must be coin or pair, if {EXCHANGE} is needed, etc.). * {TIMEFRAME} is **not globally required** — include it only if the chosen endpoint in Part 2 requires/accepts it. STEP 1 — BUILD PLAIN QUERY STRING * Start with `/v1/{FUNCTION}`. If the exact endpoint uses a prefix (e.g., `cg_futures_...`), use that name from Part 2. * Add only the required params for that function (per Part 2). Examples: {INSTRUMENT}, {EXCHANGE}, {TIMEFRAME} — if they are required. * Add optional params as needed ({LIMIT}, {PAGE}, {PAGE_SIZE}, {START_TIME}, {END_TIME}, {UNIT}, {RANGE}, {EXPIRY}, {FORMAT}, {MODE}). * This string is **not** encoded yet. STEP 2 — ADD {X} (IF USED) * Append `{X}=YOUR_CODE` to the same plain query string (skip if no code). STEP 3 — ENCODE WHEN NEEDED * Percent‑encode the entire query string only if {X} is present or you must use the encoded form: `?` → `%3F`, `&` → `%26`, `=` → `%3D`, `-` → `%2D` (the hyphen inside {INSTRUMENT}). * Attach the encoded string directly after `/v1/{FUNCTION}` (no literal `?`). STEP 4 — SEND THE REQUEST * Use the final URL. Control pagination via {PAGE}/{PAGE_SIZE} when the endpoint supports it. ============================================================ 3. EXAMPLES (PLAIN, MINIMAL) ============================================================ A) AGENT defaults (FORMAT defaults to TXT) with required params only (per its Part 2 spec): `/v1/cg_futures_open_interest_history?instrument=BTC-USDT&exchange=Binance&timeFrame=1d` B) DIRECT (explicit MODE) with required params for funding rate history: `/v1/cg_futures_funding_rate_history?instrument=BTC-USDT&exchange=OKX&timeFrame=1h&mode=direct` C) AGENT with JSON, RANGE‑style endpoint (include timeFrame only if accepted by this endpoint in Part 2): `/v1/cg_futures_taker_buy_sell_volume_exchange_list?instrument=BTC&timeFrame=4h&format=json` D) DIRECT with {X} (encoded), minimal required params for this function: `/v1/cg_futures_open_interest_history%3Finstrument%3DBTC%2DUSDT%26exchange%3DBinance%26timeFrame%3D1d%26mode%3Ddirect%26x%3DYOUR_CODE` ============================================================ 4. SERVER DEFAULTS & BEHAVIOR ============================================================ UNIFIED PARAMETERS (Canonical & Synonyms) * instrument — canonical instrument passed by client: – Pair‑level: `BASE‑QUOTE` (e.g., BTC‑USDT) → upstream `SYMBOL/instId` = `BTCUSDT` (hyphen removed). – Coin‑level: BTC, ETH, ... Synonyms accepted: `instId`, `symbol`, `pair` (normalized internally). IMPORTANT: Include only if required by the selected endpoint in Part 2. * timeFrame — universal time parameter; mapped internally to: – `INTERVAL` for OHLC/series (e.g., open interest OHLC, funding OHLC, spot price history); – `RANGE` for certain exchange‑list/history‑chart endpoints (short aggregation windows). Synonyms: `timeframe`, `time_frame`, `interval`, `range`, `window`. IMPORTANT: Include only if the endpoint requires/accepts it per Part 2. * exchange / exchanges** — mapped to `EXCHANGE` / `EXCHANGE_LIST` (names normalized to CoinGlass’ expected values). * unit — `usd` | `coin` (series that support units). * expiry — `YYYY‑MM‑DD` or `YYYYMMDD`. * startTime, endTime — ms (inclusive). * format/mode — agent/direct and txt/json/html/pre/csv; defaults same as Binance‑styled behavior. SUMMARY (quick mapping) Function family | Accepts (unified) | → Upstream | Examples --------------------------+-------------------------------------+------------------------------+--------------------------------------- Candles & time series | timeFrame / interval / tf | → interval | 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 8h, 12h, 1d, 1w Statistical metrics | timeFrame / period / window | → period | 5m, 15m, 30m, 1h, 1d Rolling tickers | timeFrame / windowSize / window | → windowSize | 1m–7d (default 1d) Aggregated lists/charts | timeFrame / range / window | → range | 5m, 15m, 30m, 1h, 4h, 12h, 24h Order‑book % window | range | → range (±% from mid) | 0.25, 0.5, 1, 2, 5 *(currently unused; refer to Part 2 when supported)* Options (expiry) | expiration / expiry / exp | → expiry | 2025‑12‑31 Instrument (pair) | instrument / symbol / pair / instId | → symbol (BTCUSDT) | BTC‑USDT Instrument (coin) | instrument / symbol | → symbol (BTC) | BTC Exchange / exchanges | exchange; exchanges/exchangeList | → exchange / exchangeList | Binance, OKX FORMATS & MODES (defaults) * agent → default `format=txt`; response wrapped as `{ok, function, data, paging, meta}`. * direct → default `format=pre`; returns raw upstream payload. PAGINATION * `page` ≥ 1; `page_size` ≤ 1000. If an upstream endpoint doesn’t paginate, the proxy may ignore these and expose navigation via `meta` in agent mode. ENCODING * If {X} is present → percent‑encode the entire query string (see §2, STEP 3). Part 2 – Function Reference (Full Parameter Lists + Minimal Examples) All examples below are plain (NOT percent-encoded) and include ONLY REQUIRED parameters for each endpoint. For access/encoding rules, see Part 1 (Request Algorithm). Function: openInterest_ohlc_history Description: Historical open-interest for a single futures trading pair in OHLC format. Parameters: * EXCHANGE; type=str; required; default=`Binance`; the futures exchange (e.g., Binance, OKX, Bybit, Hyperliquid). * SYMBOL; type=str; required; default=`BTCUSDT`; trading pair (coin + contract currency, such as `BTCUSDT`). * INTERVAL; type=str; required; default=`1d`; allowed=`1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `4h`, `6h`, `8h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=10; max=1000; number of rows to return. * START_TIME; type=int; optional; start timestamp in ms (inclusive). * END_TIME; type=int; optional; end timestamp in ms (inclusive). * UNIT; type=str; optional; default=`usd`; allowed=`usd`, `coin`. Minimal example: /v1/cg_futures_open_interest_history?instId=BTCUSDT&exchange=Binance&interval=1d --- Function: openInterest_ohlc_aggregated_history Description: Aggregated open-interest across all supported exchanges for a given coin, returned in OHLC format. Parameters: * SYMBOL; type=str; required; default=`BTC`; the base coin (e.g., `BTC` or `ETH`). * INTERVAL; type=str; required; default=`1d`; allowed=as above for open-interest history. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional; start timestamp in ms. * END_TIME; type=int; optional; end timestamp in ms. * UNIT; type=str; optional; default=`usd`; allowed=`usd`, `coin`. Minimal example: /v1/cg_futures_open_interest_aggregated_history?symbol=BTC&interval=1d --- Function: openInterest_ohlc_aggregated_stablecoin Description: Aggregated open-interest for stable-coin-margined contracts across multiple exchanges. Parameters: * EXCHANGE_LIST; type=str; required; comma-separated list of exchanges (e.g., `Binance,OKX`). * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`1d`; allowed=as in open-interest history. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_open_interest_aggregated_stablecoin_margin_history?symbol=BTC&interval=1d&exchanges=Binance --- Function: openInterest_ohlc_aggregated_coin_margin_history Description: Aggregated open-interest for coin-margined contracts across selected exchanges. Parameters: * EXCHANGE_LIST; type=str; required; comma-separated list of futures exchanges (e.g., `OKX,Binance`). * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`1d`; allowed=as above. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_open_interest_aggregated_coin_margin_history?symbol=BTC&interval=1d&exchanges=Binance,OKX --- Function: openInterest_exchange_list Description: Lists exchanges with current open-interest, including aggregated open interest and long/short ratios. Parameters: * SYMBOL; type=str; required; default=`BTC`. Minimal example: /v1/cg_futures_open_interest_exchange_list?symbol=BTC --- Function: openInterest_exchange_history_chart Description: Open-interest history by exchange. Returns time-series data for each exchange. Parameters: * SYMBOL; type=str; required; default=`BTC`. * RANGE (alias: `timeFrame`); type=str; optional; default=`12h`; allowed=`all`, `1m`, `15m`, `1h`, `4h`, `12h`. This value controls the duration of the exchange‑history chart; `all` returns the entire history, while the other options specify fixed windows. * UNIT; type=str; optional; default=`usd`; allowed=`usd`, `coin`. Minimal example: /v1/cg_futures_open_interest_exchange_history_chart?symbol=BTC&timeFrame=12h --- Function: fundingRate_ohlc_history Description: Historical funding rate in OHLC form for a given pair and exchange. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1d`; allowed=`1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `4h`, `6h`, `8h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. * UNIT; type=str; optional; default=`percent`; allowed=`percent`, `bps` (basis points). (Unit is inferred from API weight.) Minimal example: /v1/cg_futures_funding_rate_history?instId=BTCUSDT&exchange=Binance&interval=1d Equivalent with the unified `instrument` parameter: /v1/cg_futures_funding_rate_history?instrument=BTC-USDT&exchange=Binance&interval=1d --- Function: fundingRate_oi_weight_ohlc_history Description: Funding rate history weighted by open interest (aggregates across exchanges by weighting each exchange’s funding rate by its open interest). Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`1d`; allowed=as in funding-rate history. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_funding_rate_oi_weight_history?symbol=BTC&interval=1d --- Function: fundingRate_vol_weight_ohlc_history Description: Funding rate history weighted by trading volume. Parameters: * SYMBOL; type=str; required; default=`BTC`; the base coin (e.g., `BTC`, `ETH`). * INTERVAL; type=str; required; default=`1d`; allowed=`1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `4h`, `6h`, `8h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=10; max=1000. * START_TIME; type=int; optional; start timestamp in milliseconds (inclusive). * END_TIME; type=int; optional; end timestamp in milliseconds (inclusive). Minimal example: /v1/cg_futures_funding_rate_vol_weight_history?symbol=BTC&interval=1d --- Function: fundingRate_exchange_list Description: Current funding rates by exchange for a given coin or trading pair. Returns a table of funding rates for each supported futures exchange. Parameters: * SYMBOL; type=str; required; default=`BTC`; the base coin. Use uppercase without quote marks (e.g., `ETH`). * MARGIN_TYPE; type=str; optional; default=`all`; allowed=`all`, `stablecoin`, `coin`. Filters results by margin type. * PAGE; type=int; optional; default=1; results page for pagination. Minimal example: /v1/cg_futures_funding_rate_exchange_list?symbol=BTC --- Function: fundingRate_cumulative_exchange_list Description: Cumulative funding‑rate totals by exchange. This endpoint aggregates funding paid/received on each exchange over time. Parameters: * SYMBOL; type=str; required; default=`BTC`; the base coin symbol. * PERIOD; type=str; optional; default=`30d`; allowed=`1d`, `7d`, `30d`, `90d`. Length of accumulation window. * MARGIN_TYPE; type=str; optional; default=`all`; allowed=`all`, `stablecoin`, `coin`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_funding_rate_cumulative_exchange_list?symbol=BTC&period=30d --- Function: global_long_short_account_ratio_history Description: Global long/short account ratio history for retail traders. This metric compares the number of traders holding long positions versus short positions across all major exchanges. Parameters: * SYMBOL; type=str; required; default=`BTC`; coin symbol (e.g., `BTC`, `ETH`). * INTERVAL; type=str; required; default=`4h`; allowed=`1h`, `4h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=50; max=1000; number of data points. * START_TIME; type=int; optional; start timestamp (ms). * END_TIME; type=int; optional; end timestamp (ms). Minimal example: /v1/cg_futures_global_long_short_account_ratio_history?symbol=BTC&interval=4h --- Function: top_long_short_account_ratio_history Description: Top-trader long/short account ratio history. Similar to the global ratio but restricted to accounts with the largest positions. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`4h`; allowed as in the global ratio. * LIMIT; type=int; optional; default=50; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_top_long_short_account_ratio_history?symbol=BTC&interval=4h --- Function: top_long_short_position_ratio_history Description: Top-trader position ratio history. Measures the aggregate position size (long vs short) held by the largest traders. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`4h`. * LIMIT; type=int; optional; default=50; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_top_long_short_position_ratio_history?symbol=BTC&interval=4h --- Function: taker_buy_sell_volume_exchange_list Description: Taker buy/sell volume by exchange. Returns the total taker buy and sell volumes on each futures exchange (ratio can be derived by dividing the two). Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; optional; default=`15m`; allowed=`1m`, `5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_taker_buy_sell_volume_exchange_list?symbol=BTC&interval=15m --- Function: net_position Description: Net long versus short position across all futures exchanges. Positive values indicate the market is net long; negative values indicate net short. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; optional; default=`4h`; allowed=`1h`, `4h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=50; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_net_position?symbol=BTC&interval=4h --- Function: net_position_v2 Description: Enhanced net-position endpoint with additional metrics (e.g., margin type splits and exchange breakdown). Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; optional; default=`4h`. * MARGIN_TYPE; type=str; optional; default=`all`; allowed=`all`, `stablecoin`, `coin`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_net_position_v2?symbol=BTC&interval=4h --- Function: liquidation_history Description: Liquidation history for a futures trading pair, aggregated by time interval. Returns total liquidated volume for long and short positions. Parameters: * EXCHANGE; type=str; optional; if specified, filters by a single exchange (e.g., `Binance`). If omitted, aggregates across all exchanges. * SYMBOL; type=str; required; default=`BTCUSDT`; trading pair. * INTERVAL; type=str; required; default=`15m`; allowed=`5m`, `15m`, `30m`, `1h`, `2h`, `4h`, `12h`, `1d`. * LIMIT; type=int; optional; default=50; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_liquidation_history?exchange=Binance&instId=BTCUSDT&interval=15m Equivalent with `instrument`: /v1/cg_futures_liquidation_history?exchange=Binance&instrument=BTC-USDT&interval=15m --- Function: liquidation_aggregated_history Description: Aggregated liquidation history for a coin across all trading pairs and exchanges. Summarizes both long and short liquidations. Parameters: * SYMBOL; type=str; required; default=`BTC`; base coin. * INTERVAL; type=str; required; default=`15m`; allowed as above. * LIMIT; type=int; optional; default=50; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_liquidation_aggregated_history?symbol=BTC&interval=15m --- Function: liquidation_coin_list Description: List of coins with recent liquidation statistics, including total liquidated volume and number of liquidations. Parameters: * MARGIN_TYPE; type=str; optional; default=`all`; allowed=`all`, `stablecoin`, `coin`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_liquidation_coin_list --- Function: liquidation_exchange_list Description: List of exchanges with current liquidation statistics (total long/short liquidations). Returns aggregated metrics by exchange. Parameters: * SYMBOL; type=str; optional; base coin filter. * MARGIN_TYPE; type=str; optional; default=`all`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_liquidation_exchange_list --- Function: liquidation_order Description: Latest individual liquidation orders. Provides granular liquidation trade data including price, volume, side, and timestamp. Parameters: * EXCHANGE; type=str; optional; filter by exchange. * SYMBOL; type=str; optional; trading pair (e.g., `BTCUSDT`). * LIMIT; type=int; optional; default=50; max=100. Minimal example: /v1/cg_futures_liquidation_order?exchange=Binance&instId=BTCUSDT&limit=50 --- Function: orderbook_ask_bids_history Description: Historical bid and ask depth for a specific futures trading pair on a single exchange. Returns aggregated depth at various price levels over time. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`; allowed=`1m`, `5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * DEPTH_LEVELS; type=str; optional; default=`5,10,25,50`; comma-separated order book depth levels (number of price levels to aggregate). * LIMIT; type=int; optional; default=50; max=500. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_orderbook_ask_bids_history?exchange=Binance&instId=BTCUSDT&interval=5m Equivalent with `instrument`: /v1/cg_futures_orderbook_ask_bids_history?exchange=Binance&instrument=BTC-USDT&interval=5m --- Function: orderbook_aggregated_ask_bids_history Description: Aggregated historical bid and ask depth across multiple exchanges for a single coin. Sums order-book depth at each level. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`5m`. * DEPTH_LEVELS; type=str; optional; default=`5,10,25,50`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_orderbook_aggregated_ask_bids_history?symbol=BTC&interval=5m --- Function: orderbook_history Description: Futures order-book heatmap data (historical depth). Provides a time-series heatmap of the full order book for a trading pair. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_orderbook_history?exchange=Binance&instId=BTCUSDT&interval=5m --- Function: orderbook_large_limit_order Description: Returns current large (block) limit orders on a futures order book. Useful for monitoring whale orders near the top of the book. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * MIN_SIZE; type=float; optional; default=100000; minimum order size in USD to include. * SIDE; type=str; optional; default=`all`; allowed=`all`, `buy`, `sell`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_orderbook_large_limit_order?exchange=Binance&instId=BTCUSDT&minSize=100000 --- Function: orderbook_large_limit_order_history Description: Historical large limit orders on futures markets. Returns past large orders with timestamps and sizes. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1h`; allowed=`5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * MIN_SIZE; type=float; optional; default=100000. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_orderbook_large_limit_order_history?exchange=Binance&instId=BTCUSDT&interval=1h&minSize=100000 --- Function: hyperliquid_whale_alert Description: Alerts for Hyperliquid whale trades. Provides real-time notifications when large trades occur on the Hyperliquid decentralized exchange. Parameters: * MIN_NOTIONAL; type=float; optional; default=10000; minimum USD notional of the trade to trigger an alert. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_hyperliquid_whale_alert?minNotional=10000 --- Function: hyperliquid_whale_position Description: Hyperliquid whale positions. Returns the current positions held by large traders on Hyperliquid. Parameters: * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_hyperliquid_whale_position --- Function: hyperliquid_position Description: Aggregated Hyperliquid positions. Summarizes the open positions across all traders on the Hyperliquid platform. Parameters: * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_hyperliquid_position --- Function: taker_buy_sell_volume_history Description: Historical taker buy and sell volume for a futures trading pair. Shows volumes executed at market price on each side. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`; allowed=`1m`, `5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * LIMIT; type=int; optional; default=50; max=500. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_taker_buy_sell_volume_history?exchange=Binance&instId=BTCUSDT&interval=5m --- Function: aggregated_taker_buy_sell_volume_history Description: Aggregated taker buy and sell volume history for a coin across multiple exchanges. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`5m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_aggregated_taker_buy_sell_volume_history?symbol=BTC&interval=5m --- Function: futures_coins_price_change Description: Price-change percentages for futures coins over various intervals. Allows quick comparison of performance across timeframes. Parameters: * SYMBOL_LIST; type=str; optional; comma-separated coin symbols to include (e.g., `BTC,ETH`). If omitted, returns all coins. * INTERVALS; type=str; optional; default=`1h,4h,24h`; comma-separated list of intervals (`5m`, `15m`, `1h`, `4h`, `12h`, `24h`). Minimal example: /v1/cg_futures_coins_price_change?symbols=BTC,ETH&intervals=1h,24h --- Function: futures_price_history Description: OHLC price history for a futures trading pair. Returns time series of open, high, low, and close prices. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1h`; allowed=`1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `2h`, `4h`, `6h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=100; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_price_history?exchange=Binance&instId=BTCUSDT&interval=1h Equivalent with `instrument`: /v1/cg_futures_price_history?exchange=Binance&instrument=BTC-USDT&interval=1h --- Function: futures_exchange_rank Description: Ranking of futures exchanges by open interest, trading volume, funding rates, and other metrics. Parameters: * SORT_BY; type=str; optional; default=`openInterest`; field used for ranking (e.g., `volume`, `openInterest`, `fundingRate`). * ORDER; type=str; optional; default=`desc`; allowed=`asc`, `desc`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_futures_exchange_rank?sortBy=openInterest&order=desc --- Function: spot_price_history Description: OHLC price history for a spot trading pair. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1h`; allowed as in futures price history. * LIMIT; type=int; optional; default=100; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_price_history?exchange=Binance&instId=BTCUSDT&interval=1h Equivalent with `instrument`: /v1/cg_spot_price_history?exchange=Binance&instrument=BTC-USDT&interval=1h --- Function: spot_orderbook_ask_bids_history Description: Historical order-book depth for a spot trading pair on a specific exchange. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`; allowed=`1m`, `5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * DEPTH_LEVELS; type=str; optional; default=`5,10,25,50`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_orderbook_ask_bids_history?exchange=Binance&instId=BTCUSDT&interval=5m Equivalent with `instrument`: /v1/cg_spot_orderbook_ask_bids_history?exchange=Binance&instrument=BTC-USDT&interval=5m --- Function: spot_orderbook_aggregated_ask_bids_history Description: Aggregated order-book depth for a spot coin across all exchanges. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`5m`. * DEPTH_LEVELS; type=str; optional; default=`5,10,25,50`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_orderbook_aggregated_ask_bids_history?symbol=BTC&interval=5m --- Function: spot_orderbook_history Description: Spot order-book heatmap (historical depth) for a trading pair. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_orderbook_history?exchange=Binance&instId=BTCUSDT&interval=5m Equivalent with `instrument`: /v1/cg_spot_orderbook_history?exchange=Binance&instrument=BTC-USDT&interval=5m --- Function: spot_orderbook_large_limit_order Description: Large limit orders on spot order books. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * MIN_SIZE; type=float; optional; default=50000; minimum notional in USD. * SIDE; type=str; optional; default=`all`; allowed=`all`, `buy`, `sell`. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_spot_orderbook_large_limit_order?exchange=Binance&instId=BTCUSDT&minSize=50000 --- Function: spot_orderbook_large_limit_order_history Description: Historical large orders on spot order books. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1h`. * MIN_SIZE; type=float; optional; default=50000. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_orderbook_large_limit_order_history?exchange=Binance&instId=BTCUSDT&interval=1h&minSize=50000 --- Function: spot_taker_buy_sell_volume_history Description: Historical taker buy and sell volume for a spot trading pair. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`5m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_taker_buy_sell_volume_history?exchange=Binance&instId=BTCUSDT&interval=5m --- Function: aggregated_spot_taker_buy_sell_volume_history Description: Aggregated taker buy and sell volume history for a coin across spot exchanges. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`5m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_spot_aggregated_taker_buy_sell_volume_history?symbol=BTC&interval=5m --- Function: option_max_pain Description: Maximum pain price for options. Returns the strike price at which the greatest number of open option contracts (puts and calls) expire worthless. Parameters: * UNDERLYING; type=str; required; default=`BTC`; the underlying asset (e.g., `BTC`, `ETH`). * EXPIRY; type=str; optional; option expiry date in `YYYYMMDD` format. If omitted, uses the nearest expiration. Minimal example: /v1/cg_option_max_pain?underlying=BTC --- Function: option_exchange_oi_history Description: Option open-interest history by exchange. Tracks the notional value of open option contracts over time. Parameters: * EXCHANGE; type=str; required; exchange name (e.g., `Deribit`). * UNDERLYING; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`1d`; allowed=`1h`, `4h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=50; max=500. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_option_exchange_oi_history?exchange=Deribit&underlying=BTC&interval=1d --- Function: option_exchange_vol_history Description: Option volume history by exchange. Shows trading volumes of option contracts. Parameters: * EXCHANGE; type=str; required. * UNDERLYING; type=str; required; default=`BTC`. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_option_exchange_vol_history?exchange=Deribit&underlying=BTC&interval=1d --- Function: exchange_assets Description: Exchange wallet holdings (on-chain assets, including balances and USD values). Useful for monitoring inflows/outflows to exchanges. Parameters: * EXCHANGE; type=str; required; exchange name (e.g., `Binance`, `OKX`). Minimal example: /v1/cg_exchange_assets?exchange=Binance --- Function: exchange_balance_list Description: Historical list of on-chain balances for an exchange. Provides discrete snapshots of wallet holdings. Parameters: * EXCHANGE; type=str; required; exchange name. * COIN; type=str; optional; default=`all`; filter by specific coin (e.g., `BTC`). * LIMIT; type=int; optional; default=50; max=500. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_exchange_balance_list?exchange=Binance&coin=BTC --- Function: exchange_balance_chart Description: Time-series chart of exchange balances. Returns continuous balance history for a coin on a given exchange. Parameters: * EXCHANGE; type=str; required. * COIN; type=str; required; the coin symbol (`BTC`, `ETH`, etc.). * INTERVAL; type=str; required; default=`1d`; allowed=`1h`, `4h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=100; max=500. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_exchange_balance_chart?exchange=Binance&coin=BTC&interval=1d --- Function: exchange_chain_tx_list Description: On-chain transfer data (ERC‑20 token transfers) for a given exchange. Shows inbound and outbound transactions. Parameters: * EXCHANGE; type=str; required. * COIN; type=str; optional; default=`USDT`; token symbol. * LIMIT; type=int; optional; default=100; max=500. * PAGE; type=int; optional; default=1. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_exchange_chain_tx_list?exchange=Binance&coin=USDT --- Function: etf_bitcoin_list Description: List of Bitcoin-related ETFs available on regulated exchanges. Parameters: * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_etf_bitcoin_list --- Function: hk_etf_bitcoin_flow_history Description: Hong Kong Bitcoin ETF flow history. Tracks net inflows and outflows of capital into Hong Kong-listed Bitcoin ETFs. Parameters: * INTERVAL; type=str; required; default=`1d`; allowed=`1d`, `1w`, `1m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_hk_etf_bitcoin_flow_history?interval=1d --- Function: etf_bitcoin_net_assets_history Description: Net assets history for Bitcoin ETFs. Shows total assets under management (AUM) over time. Parameters: * ETF_SYMBOL; type=str; required; ticker symbol of the ETF (e.g., `BITO`). * INTERVAL; type=str; required; default=`1d`; allowed=`1d`, `1w`, `1m`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_bitcoin_net_assets_history?etfSymbol=BITO&interval=1d --- Function: etf_bitcoin_flow_history Description: Flow history for Bitcoin ETFs (US-listed). Returns net inflows/outflows to each ETF. Parameters: * ETF_SYMBOL; type=str; optional; if provided, filters by a specific ETF. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_bitcoin_flow_history?interval=1d --- Function: etf_bitcoin_premium_discount_history Description: Premium/discount history for Bitcoin ETFs relative to their net asset value (NAV). Parameters: * ETF_SYMBOL; type=str; required. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_bitcoin_premium_discount_history?etfSymbol=BITO&interval=1d --- Function: etf_bitcoin_history Description: Full trading history for Bitcoin ETFs, including price, volume, and NAV. Parameters: * ETF_SYMBOL; type=str; required. * INTERVAL; type=str; required; default=`1d`; allowed=`1h`, `1d`, `1w`. * LIMIT; type=int; optional; default=100; max=1000. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_bitcoin_history?etfSymbol=BITO&interval=1d --- Function: etf_bitcoin_price_history Description: Price history for Bitcoin ETFs. Parameters: * ETF_SYMBOL; type=str; required. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=100. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_bitcoin_price_history?etfSymbol=BITO&interval=1d --- Function: etf_ethereum_net_assets_history Description: Net assets history for Ethereum ETFs. Parameters: * ETF_SYMBOL; type=str; required. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_ethereum_net_assets_history?etfSymbol=EETH&interval=1d --- Function: etf_ethereum_flow_history Description: Flow history for Ethereum ETFs. Parameters: * ETF_SYMBOL; type=str; optional; Ethereum ETF symbol. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_etf_ethereum_flow_history?interval=1d --- Function: grayscale_holdings_list Description: List of Grayscale fund holdings. Returns the underlying assets held by each Grayscale trust. Parameters: * FUND; type=str; optional; default=`GBTC`; Grayscale fund ticker. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_grayscale_holdings_list?fund=GBTC --- Function: grayscale_premium_history Description: Grayscale premium history. Shows the premium or discount of Grayscale funds relative to NAV. Parameters: * FUND; type=str; required; fund ticker (e.g., `GBTC`). * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_grayscale_premium_history?fund=GBTC&interval=1d --- Function: futures_rsi_list Description: Relative Strength Index (RSI) values for futures contracts. Returns RSI over multiple timeframes. Parameters: * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVALS; type=str; optional; default=`14d,28d`; comma-separated window lengths. Minimal example: /v1/cg_futures_rsi_list?instId=BTCUSDT --- Function: futures_basis_history Description: Futures basis history. Measures the difference between futures and spot prices. Parameters: * EXCHANGE; type=str; required; default=`Binance`. * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_basis_history?exchange=Binance&instId=BTCUSDT&interval=1d --- Function: futures_whale_index Description: Whale index for futures. Indicates the positions of large traders and whales. Parameters: * SYMBOL; type=str; required; default=`BTCUSDT`. * INTERVAL; type=str; optional; default=`4h`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_futures_whale_index?instId=BTCUSDT&interval=4h --- Function: futures_cgdi_index Description: CoinGlass Derivatives Index (CGDI). Synthesizes various derivatives metrics into a single indicator. Parameters: * SYMBOL; type=str; required; default=`BTC`. Minimal example: /v1/cg_futures_cgdi_index?symbol=BTC --- Function: futures_cdri_index Description: CoinGlass DEX Index (CDRI). An index measuring decentralized derivatives activity. Parameters: * SYMBOL; type=str; required; default=`BTC`. Minimal example: /v1/cg_futures_cdri_index?symbol=BTC --- Function: coinbase_premium_index Description: Coinbase Premium Index. Measures the premium or discount of Coinbase's spot price relative to other exchanges. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; optional; default=`1h`; allowed=`1m`, `5m`, `15m`, `1h`, `4h`, `12h`, `1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_coinbase_premium_index?symbol=BTC&interval=1h --- Function: bitfinex_margin_long_short Description: Bitfinex margin long/short ratio. Shows the amount of margin long positions versus short positions on Bitfinex. Parameters: * SYMBOL; type=str; required; default=`BTC`. * INTERVAL; type=str; optional; default=`4h`; allowed=`1h`, `4h`, `12h`, `1d`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_bitfinex_margin_long_short?symbol=BTC&interval=4h --- Function: borrow_interest_rate_history Description: Borrow interest rate history (crypto lending rates) across major exchanges. Parameters: * COIN; type=str; required; default=`USDT`; the borrowed coin. * INTERVAL; type=str; optional; default=`1d`; allowed=`1h`, `4h`, `12h`, `1d`, `1w`. * LIMIT; type=int; optional; default=50. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_borrow_interest_rate_history?coin=USDT&interval=1d --- Function: ahr999 Description: AHR999 indicator. A high‑level valuation metric for Bitcoin derived from long-term moving averages. Parameters: * N/A; this endpoint requires no parameters. Minimal example: /v1/cg_index_ahr999 --- Function: puell_multiple Description: Puell Multiple indicator. Ratio of daily coin issuance value (in USD) to the 365‑day moving average of the same. Parameters: * N/A. Minimal example: /v1/cg_index_puell_multiple --- Function: stock_to_flow Description: Stock-to-Flow model indicator. Calculates the scarcity ratio of Bitcoin (stock) to new supply (flow). Parameters: * N/A. Minimal example: /v1/cg_index_stock_flow --- Function: pi_cycle_indicator Description: Pi Cycle Top Indicator for Bitcoin. Compares moving averages to identify cycle peaks. Parameters: * N/A. Minimal example: /v1/cg_index_pi_cycle_indicator --- Function: golden_ratio_multiplier Description: Golden Ratio Multiplier indicator. Uses multiples of the 350‑day moving average to gauge market cycles. Parameters: * N/A. Minimal example: /v1/cg_index_golden_ratio_multiplier --- Function: bitcoin_profitable_days Description: Bitcoin Profitable Days metric. Shows the percentage of days Bitcoin traded above current price. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_profitable_days --- Function: bitcoin_rainbow_chart Description: Bitcoin Rainbow Chart. Uses logarithmic regression to visualize long-term price trends. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_rainbow_chart --- Function: fear_greed_history Description: Crypto Fear and Greed Index history. Measures market sentiment from extreme fear to extreme greed. Parameters: * INTERVAL; type=str; optional; default=`1d`; allowed=`1d`, `1w`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_fear_greed_history?interval=1d --- Function: stablecoin_marketcap_history Description: Stablecoin market-cap history. Tracks the total market capitalization of major stablecoins over time. Parameters: * COIN; type=str; optional; if provided, filters by a specific stablecoin (e.g., `USDT`, `USDC`). * INTERVAL; type=str; required; default=`1d`. * LIMIT; type=int; optional; default=100. * START_TIME; type=int; optional. * END_TIME; type=int; optional. Minimal example: /v1/cg_index_stablecoin_marketcap_history?coin=USDT&interval=1d --- Function: bitcoin_bubble_index Description: Bitcoin Bubble Index. An indicator designed to identify speculative bubbles in the Bitcoin price. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_bubble_index --- Function: bull_market_peak_indicator Description: Bull Market Peak Indicators. Series of metrics designed to identify potential market tops. Parameters: * N/A. Minimal example: /v1/cg_bull_market_peak_indicator --- Function: two_year_ma_multiplier Description: Two Year MA Multiplier. Compares price to a two-year moving average and its multiples to gauge market cycles. Parameters: * N/A. Minimal example: /v1/cg_index_2_year_ma_multiplier --- Function: two_hundred_week_ma_heatmap Description: 200‑Week Moving Average Heatmap. Shows price relative to its 200‑week moving average using a colored heatmap. Parameters: * N/A. Minimal example: /v1/cg_index_200_week_moving_average_heatmap --- Function: rhodl_ratio Description: Bitcoin RHODL Ratio. Compares Realized HODL Waves to gauge market cycles. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_rhodl_ratio --- Function: bitcoin_active_addresses Description: Bitcoin Active Addresses. Number of unique addresses active in the Bitcoin network per day. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_active_addresses --- Function: bitcoin_new_addresses Description: Bitcoin New Addresses. Number of new addresses appearing on the Bitcoin blockchain each day. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_new_addresses --- Function: bitcoin_net_unrealized_pnl Description: Bitcoin Net Unrealized Profit/Loss (NUPL). Measures the ratio of unrealized profits to losses among Bitcoin holders. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_net_unrealized_pnl --- Function: bitcoin_correlations Description: Correlations between Bitcoin and other assets (e.g., S&P 500, gold, bonds). Parameters: * ASSET; type=str; optional; default=`SPX`; asset ticker to compute correlation with (e.g., `NDX`, `GOLD`). * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_correlations?asset=SPX --- Function: bitcoin_macro_oscillator Description: Bitcoin Macro Oscillator (BMO). A composite indicator built from macroeconomic variables and Bitcoin market data. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_macro_oscillator --- Function: options_futures_oi_ratio Description: Options/Futures Open‑Interest Ratio. Compares the outstanding notional value of options contracts to that of futures contracts. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_options_futures_oi_ratio --- Function: bitcoin_vs_global_m2_supply_growth Description: Bitcoin vs Global M2 supply and growth. Plots Bitcoin’s market cap relative to global money supply growth. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_vs_global_m2_supply_growth --- Function: bitcoin_vs_us_m2_supply_growth Description: Bitcoin vs US M2 supply and growth. Parameters: * N/A. Minimal example: /v1/cg_index_bitcoin_vs_us_m2_supply_growth --- Function: bitcoin_dominance Description: Bitcoin dominance (BTC market dominance) over time. Parameters: * INTERVAL; type=str; optional; default=`1d`. * LIMIT; type=int; optional; default=100. Minimal example: /v1/cg_index_bitcoin_dominance --- Function: economic_data Description: Macroeconomic calendar and economic data releases. Provides upcoming events and historical macro indicators. Parameters: * COUNTRY; type=str; optional; comma-separated country codes (e.g., `US,CN,EU`). * CATEGORY; type=str; optional; event category (e.g., `GDP`, `CPI`, `FOMC`). * START_DATE; type=str; optional; start date in `YYYY-MM-DD` format. * END_DATE; type=str; optional; end date in `YYYY-MM-DD` format. * PAGE; type=int; optional; default=1. Minimal example: /v1/cg_economic_data?country=US&category=CPI --- For a live list of supported coins, trading pairs and exchanges, please refer to the `/instrument` endpoint. The instrument page provides up‑to‑date spot and futures markets and replaces the previously documented instrument list functions.