Endpoint catalogue
Everything that can be called, on one page. The parameters of each route are read from the OpenAPI contract, so they cannot drift from the API. The detail (response fields, units, traps) lives in the family page linked at the top of each section, and in the interactive reference.
Host: https://api.bytnode.com. Every route requires the X-API-KEY header (except /v1/health) and accepts ?fields= (except /v1/health, /v1/status and POST /v1/indicators, which choose their output otherwise). The Parameters column lists symbol where a route takes it; whole-market routes (macro, on-chain, ETF, global market, sentiment, system) take none and refuse it.
#System and metadata
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/health no key | Is the API answering. | — | — |
GET /v1/status | Freshness of each data feed, feed by feed. | — | price_volume |
GET /v1/symbols | The enabled symbols. | — | price_volume |
GET /v1/capabilities | What can be computed for this symbol, and what cannot. | symbol (required) | price_volume |
GET /v1/limits | What your key may do: families, history windows, rate and quota left. | — | — |
POST /v1/ws/token | A short-lived WebSocket token for a web page: 60 seconds, one connection, never your key. | — | — |
#Snapshot
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/snapshot | Up to 48 fields in one request. | one parameter per field (value = depth or true) | snapshot |
#Price and volume
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/klines | The latest closed OHLCV candle, every timeframe from 1m to 1w. | timeframe (required), live, symbol (required) | price_volume |
GET /v1/klines/history | OHLCV candles, every timeframe from 1m to 1w, most recent first. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | price_volume |
GET /v1/price-change | Change in % over the eight timeframes. | symbol (required) | price_volume |
GET /v1/trades/spot | Individual spot trades. | limit, since_ms, until_ms, before_ms, after_id, order, symbol (required) | trades |
GET /v1/trades/futures | Individual futures trades. | limit, since_ms, until_ms, before_ms, after_id, order, symbol (required) | trades |
GET /v1/trades/large | Large orders, filtered by amount. | min_usd, limit, since_ms, until_ms, before_ms, after_id, order, symbol (required) | trades |
GET /v1/trades-kline/futures/seconds | Futures trades aggregated to the second, all venues. | limit, since_ms, until_ms, order, symbol (required), before_ms | trades |
GET /v1/trades-kline | Trade candle, spot and futures summed. | symbol (required), timeframe (required), live | microstructure |
GET /v1/trades-kline/history | History of the trade candles. | symbol (required), timeframe (required), since_ms, until_ms, limit, before_ms, order | microstructure |
GET /v1/trades-kline/spot | Trade candle, spot only. | symbol (required), timeframe (required), live | microstructure |
GET /v1/trades-kline/spot/history | Spot history. | symbol (required), timeframe (required), since_ms, until_ms, limit, before_ms, order | microstructure |
GET /v1/trades-kline/futures | Trade candle, futures only. | symbol (required), timeframe (required), live | microstructure |
GET /v1/trades-kline/futures/history | Futures history. | symbol (required), timeframe (required), since_ms, until_ms, limit, before_ms, order | microstructure |
#Derivatives
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/oi | Current open interest, summed across venues. | symbol (required) | derivatives |
GET /v1/oi/history | Aggregated open interest, per bucket. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
GET /v1/oi/change | Change in open interest. | symbol (required) | derivatives |
GET /v1/oi/change/history | History of the open interest delta. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
GET /v1/funding/rate | Last funding rate applied. | live, symbol (required) | derivatives |
GET /v1/funding/rate/history | History of the applied rate. | since_ms, until_ms, limit, symbol (required), before_ms, order | derivatives |
GET /v1/funding/next | Next estimated funding. | symbol (required) | derivatives |
GET /v1/funding/cumulative | Funding accumulated over 24 h. | symbol (required) | derivatives |
GET /v1/funding/cumulative/history | History of the cumulative funding. | since_ms, until_ms, limit, symbol (required), before_ms, order | derivatives |
GET /v1/liquidations/events | Individual liquidations. | limit, min_usd, symbol (required) | derivatives |
GET /v1/liquidations/cumulative | Cumulative liquidations, longs against shorts. | symbol (required) | derivatives |
GET /v1/liquidations/cumulative/history | History of the cumulative liquidations. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
GET /v1/liquidations/big-small-ratio | Large liquidations against small ones. | timeframe (required), symbol (required) | derivatives |
GET /v1/liquidations/big-small-ratio/history | History of the ratio. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
GET /v1/basis | Futures against spot spread. | symbol (required) | derivatives |
GET /v1/basis/history | History of the basis. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
GET /v1/spread/interexchange | Premium of each venue against the reference. | timeframe (required), live, symbol (required) | microstructure |
GET /v1/spread/interexchange/history | History of the premiums. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
#Flow and microstructure
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/cvd | Cumulative volume delta, spot and futures. | timeframe (required), live, symbol (required) | microstructure |
GET /v1/cvd/history | History of the CVD, spot and futures. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/cvd/spot | Cumulative volume delta, spot only. | timeframe (required), live, symbol (required) | microstructure |
GET /v1/cvd/spot/history | History of the CVD, spot only. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/cvd/futures | Cumulative volume delta, futures only. | timeframe (required), live, symbol (required) | microstructure |
GET /v1/cvd/futures/history | History of the CVD, futures only. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/orderbook | Order book depth by price range, spot and futures. | timeframe (required), symbol (required) | microstructure |
GET /v1/orderbook/history | History of the order book, spot and futures. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/orderbook/spot | Order book depth by price range, spot only. | timeframe (required), symbol (required) | microstructure |
GET /v1/orderbook/spot/history | History of the order book, spot only. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/orderbook/futures | Order book depth by price range, futures only. | timeframe (required), symbol (required) | microstructure |
GET /v1/orderbook/futures/history | History of the order book, futures only. | timeframe (required), since_ms, until_ms, limit, symbol (required), before_ms, order | microstructure |
GET /v1/buy-sell-ratio | Buy / sell ratio of the latest closed bucket, spot and futures. | timeframe (required), symbol (required) | microstructure |
GET /v1/buy-sell-ratio/history | History of the buy / sell ratio, spot and futures. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/buy-sell-ratio/spot | Buy / sell ratio of the latest closed bucket, spot only. | timeframe (required), symbol (required) | microstructure |
GET /v1/buy-sell-ratio/spot/history | History of the buy / sell ratio, spot only. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/buy-sell-ratio/futures | Buy / sell ratio of the latest closed bucket, futures only. | timeframe (required), symbol (required) | microstructure |
GET /v1/buy-sell-ratio/futures/history | History of the buy / sell ratio, futures only. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/trades/avg-size | Average trade size, spot and futures. | timeframe (required), symbol (required) | microstructure |
GET /v1/trades/avg-size/history | History of the average size, spot and futures. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/trades/avg-size/spot | Average trade size, spot only. | timeframe (required), symbol (required) | microstructure |
GET /v1/trades/avg-size/spot/history | History of the average size, spot only. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/trades/avg-size/futures | Average trade size, futures only. | timeframe (required), symbol (required) | microstructure |
GET /v1/trades/avg-size/futures/history | History of the average size, futures only. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | microstructure |
GET /v1/heatmap/clusters | The most attractive liquidation clusters. | symbol (required) | derivatives |
GET /v1/heatmap/clusters/history | History of the clusters. | since_ms, until_ms, limit, timeframe (required), symbol (required), before_ms, order | derivatives |
#Technical indicators
| Route | Description | Parameters | Data family |
|---|---|---|---|
POST /v1/indicators | Nineteen indicator types, up to 50 instances per call. | — | indicators |
#Options
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/options/summary | Overview of the asset. | asset (required) | options |
GET /v1/options/oi | Options open interest. | asset (required) | options |
GET /v1/options/oi/history | History of the open interest. | timeframe (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/oi/change | Change in open interest. | timeframe (required), asset (required) | options |
GET /v1/options/oi/change/history | History of the delta. | timeframe (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/oi/distribution | Breakdown of OI by strike and by expiry. | expiry, asset (required) | options |
GET /v1/options/volume | Options volume in USD. | asset (required) | options |
GET /v1/options/volume/history | History of the volume. | timeframe (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/put-call-ratio | Put / call ratio. | asset (required) | options |
GET /v1/options/put-call-ratio/history | History of the put / call. | timeframe (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/max-pain | Max pain by expiry. | asset (required) | options |
GET /v1/options/max-pain/history | History of the max pain. | expiry (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/iv | Weighted implied volatility. | asset (required) | options |
GET /v1/options/iv/klines | The latest closed OHLC candle of the implied volatility. | timeframe (required), asset (required) | options |
GET /v1/options/iv/klines/history | OHLC candles of the implied volatility, most recent first. | timeframe (required), since_ms, until_ms, limit, asset (required), before_ms, order | options |
GET /v1/options/greeks | Aggregated Greeks. | asset (required) | options |
GET /v1/options/expiry | Summary by expiry. | asset (required) | options |
#Bitcoin network
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/btc/network | Height, difficulty, next adjustment. | — | onchain |
GET /v1/btc/network/history | Network history. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/btc/mempool | Pending transactions, weight, fees. | — | onchain |
GET /v1/btc/mempool/history | Mempool history. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/btc/fees | Recommended fees by priority. | — | onchain |
GET /v1/btc/fees/history | History of the fees. | since_ms, until_ms, limit, timeframe, before_ms, order | onchain |
GET /v1/btc/mining | Pool concentration, rewards. | — | onchain |
GET /v1/btc/mining/history | Mining history. | dataset, since_ms, until_ms, limit, before_ms, order | onchain |
#Bitcoin on-chain valuation
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/btc/mvrv | MVRV and valuation zone. | — | onchain |
GET /v1/btc/mvrv/history | MVRV history. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/btc/nvt | NVT and its smoothed signal. | — | onchain |
GET /v1/btc/nvt/history | NVT history. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/btc/active-addresses | Active addresses and momentum. | — | onchain |
GET /v1/btc/active-addresses/history | History of the active addresses. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/btc/revenue-per-difficulty | Miner stress. | — | onchain |
GET /v1/btc/revenue-per-difficulty/history | History of the miner stress. | since_ms, until_ms, limit, before_ms, order | onchain |
#Ethereum on-chain
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/eth/supply | Supply, staking, burnt, net issuance. | — | onchain |
GET /v1/eth/supply/history | History of the supply. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/gas | Gas price and congestion. | — | onchain |
GET /v1/eth/gas/history | History of the gas. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/gas-momentum | Gas momentum and regime. | — | onchain |
GET /v1/eth/gas-momentum/history | History of the momentum. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/staking | Staking ratio and yield. | — | onchain |
GET /v1/eth/staking/history | History of the staking. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/deflation | Burn against issuance. | — | onchain |
GET /v1/eth/deflation/history | History of the deflation. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/defi | Ethereum TVL and DEX volume. | — | onchain |
GET /v1/eth/defi/history | DeFi history. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/squeeze | Squeeze index. | — | onchain |
GET /v1/eth/squeeze/history | History of the squeeze. | since_ms, until_ms, limit, before_ms, order | onchain |
GET /v1/eth/price-btc | ETH/BTC ratio and momentum. | — | onchain |
GET /v1/eth/price-btc/history | History of the ratio. | since_ms, until_ms, limit, before_ms, order | onchain |
#Macro
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/macro | Latest value of one series (series required). | series (required) | macro |
GET /v1/macro/series | Catalogue of the available series. | category | macro |
GET /v1/macro/history | History of a series. | since_ms, until_ms, limit, series (required), before_ms, order | macro |
GET /v1/macro/correlations | BTC against macro correlations. | — | macro |
GET /v1/macro/net-liquidity | Net liquidity. | — | macro |
GET /v1/macro/net-liquidity/history | History of the net liquidity. | since_ms, until_ms, limit, before_ms, order | macro |
GET /v1/macro/momentum | Macro momentum score. | — | macro |
GET /v1/macro/risk | Risk-on / risk-off regime. | — | macro |
GET /v1/macro/intraday/series | Catalogue of the intraday instruments. | — | macro |
GET /v1/macro/intraday/history | OHLC candles of a macro instrument. | since_ms, until_ms, limit, series (required), timeframe (required), before_ms, order | macro |
#ETF, tokenomics and sentiment
| Route | Description | Parameters | Data family |
|---|---|---|---|
GET /v1/etf/fundamentals | Quarterly anchor by issuer. | asset (required) | etf |
GET /v1/etf/fundamentals/history | History of the fundamentals. | ticker, since_ms, until_ms, limit, asset (required), before_ms, order | etf |
GET /v1/tokenomics | Supply, market cap and FDV of the symbol. | symbol (required) | tokenomics |
GET /v1/tokenomics/history | Tokenomics history. | since_ms, until_ms, limit, symbol (required), before_ms, order | tokenomics |
GET /v1/global | Total market cap and dominance. | — | price_volume |
GET /v1/global/history | History of the global market. | since_ms, until_ms, limit, timeframe, before_ms, order | price_volume |
GET /v1/fear-greed | Fear & Greed of the day. | — | sentiment |
GET /v1/fear-greed/history | History since 2018. | since_ms, until_ms, limit, before_ms, order | sentiment |
GET /v1/fear-greed/cmc | CoinMarketCap Fear & Greed, refreshed during the day. | — | sentiment |
GET /v1/fear-greed/cmc/history | One point per day since 2023. | since_ms, until_ms, limit, before_ms, order | sentiment |
GET /v1/altcoin-season | Altcoin Season Index, altcoin market cap, 1-year extremes. | — | sentiment |
GET /v1/altcoin-season/history | One point per day, the last 90 days and on. | since_ms, until_ms, limit, before_ms, order | sentiment |
GET /v1/indices/cmc20 | CMC20 index, 24 h change and its 20 constituents. | — | sentiment |
GET /v1/indices/cmc20/history | One value per day since 2024. | since_ms, until_ms, limit, before_ms, order | sentiment |
GET /v1/indices/cmc100 | CMC100 index, 24 h change and its 100 constituents. | — | sentiment |
GET /v1/indices/cmc100/history | One value per day since 2024. | since_ms, until_ms, limit, before_ms, order | sentiment |