Skip to content
ChartDeck Developer API docs Account Get an API key

Market data

Venues, markets, candles (incl. the TOTAL indexes), open interest, funding, basis, long/short, large trades, order-book heatmap, footprints, ETF flows.

Market data is what the terminal's charts read, through the same code: a candle from /v1/candles is the chart's own bar.

  • /v1/venues lists the exchanges and sources and what each offers; /v1/markets lists every market with its symbol, base, quote, type and tick size. Use them to build valid requests.
  • Candles: bars { t, o, h, l, c, v [, qv, bv, qbv] } where t is the bar's open (unix seconds), v base volume, qv quote volume, bv / qbv the taker-buy volumes where the venue publishes them. Minutes to months on every tier; seconds and tick bars from Developer. Venue mcap gives ChartDeck's crypto market-cap indexes (TOTAL, TOTAL2, TOTAL3).
  • Derivatives series: open interest (base coin), funding (with settlements), basis (perpetual vs spot, percent) and the long/short ratio, per bar of one venue.
  • Large trades: the big prints of one market (t_ms).
  • Order-book heatmap: recorded resting liquidity per bar (heavy: 10 to 20 units).
  • Footprint bars: volume at price, buy and sell, per bar (heavy).
  • ETF flows: spot ETF flows per fund and in total, daily or from quarterly filings.

Pages walk backward in time: the first page is the newest. Long history costs more units (Units and weights).

#Operations

OperationSummary
GET /v1/basisPerpetual vs spot basis per bar (percent)
GET /v1/candlesOHLCV bars of one market (the chart's own bars); venue mcap = the TOTAL indexes
GET /v1/etf/flowsOne asset's spot ETF flows per fund and in total, daily or quarterly
GET /v1/etf/summaryEvery asset's latest spot ETF totals
GET /v1/footprint/barsFootprint bars: volume at price, buy and sell
GET /v1/fundingFunding rate per bar, with settlements
GET /v1/lsrLong/short ratio per bar of one venue
GET /v1/marketsEvery listed market: venue, symbol, base, quote, type, precision, tick size
GET /v1/oiOpen interest per bar (base coin)
GET /v1/orderbook/heatmapRecorded resting liquidity per bar
GET /v1/trades/largeThe large prints of one market
GET /v1/venuesThe exchanges and data sources the API serves (id, name, type, quotes, market count)

#Typical call

JavaScript
const r = await cd.market.candles({ venue: 'binance', symbol: 'BTCUSDT', res: '60', limit: 500 });
console.log(r.data.length, r.meta.attribution);

The Developer API documentation is in English.