Market data

get_tickCopy Anchor Link

Latest bid/ask/last (and mark/index for perps) with spread in bps. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_tick

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_barsCopy Anchor Link

OHLCV bars, up to 5000, order:"chronological" (oldest first). volume is in base units; quote_volume when the exchange provides it; partial_last_bar tells whether the last bar is still forming. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_bars

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1",
  "count": 1
}

get_symbolsCopy Anchor Link

Tradable USDT markets (spot and USDT-M perps) with 24h quote volume, order:"quote_volume_desc". Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_symbols

Example request:

{}

get_symbol_infoCopy Anchor Link

Market specification: tick_size, amount_step, contract_size, min_notional_usdt, max_leverage, fees, leverage tiers. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_symbol_info

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_market_depthCopy Anchor Link

Real L2 order book (levels<=50, best first; amounts in base units) with imbalance within 50 bps. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_market_depth

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_recent_tradesCopy Anchor Link

Recent public trades with real aggressor side, order:"chronological", plus buy/sell volume and delta. Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_recent_trades

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_order_flowCopy Anchor Link

Footprint (volume-at-price, delta, POC, imbalances) per bar from recent public trades; bars older than the trade window report coverage:"insufficient". Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_order_flow

Example request:

{
  "symbol": "BTC/USDT:USDT",
  "timeframe": "M1"
}

get_fundingCopy Anchor Link

Perp funding: current & predicted rate, next funding time, interval, annualized %, 30-day z-score, optional history (chronological) and cross-exchange comparison. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_funding

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_open_interestCopy Anchor Link

Open interest (contracts and USDT), 1h/4h/24h change and the price-vs-OI quadrant (e.g. price_up_oi_up). Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_open_interest

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_positioningCopy Anchor Link

Long/short account ratio history (raw numbers, no contrarian signal is derived). Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_positioning

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_liquidationsCopy Anchor Link

Liquidations from our own collector: per-side counts and USDT notional over a window and the largest events. coverage:"sampled" on Binance (lower bounds). Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_liquidations

Example request:

{}

get_basisCopy Anchor Link

Perp mark vs spot premium %, funding-based annualization and optional hourly history. Requires the analytics capability (Pro and above).

Capability: analytics · read-only · REST: POST /v1/tools/get_basis

Example request:

{
  "symbol": "BTC/USDT:USDT"
}

get_fear_greedCopy Anchor Link

Crypto Fear & Greed index (alternative.me) with history; the attribution field must be shown when quoting it. Available on every tier.

Capability: read · read-only · REST: POST /v1/tools/get_fear_greed

Example request:

{}