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

Channels

Every stream channel - candles, trades, large trades, liquidations, flow, liquidation levels, calendar, market-cap indexes - with its tier.

Channel names are case-sensitive: venue ids lower case, symbols as the venue writes them (as in /v1/markets), coins upper case.

ChannelDataLowest tier
candles:{venue}:{symbol}:{res}the forming and closed bars of one market (first frame after subscribing: the forming bar, snapshot: true); seconds resolutions from DeveloperSandbox
trades:{venue}:{symbol} (optional :{min_usd})the market's trades, batchedSandbox
trades.large:{coin}:{min_usd}prints of at least min_usd (50,000 or more) over the coin's recorded venuesSandbox
liquidations:{coin}liquidation orders of the coin over its venuesSandbox
cvd:{coin}:{market} / flow:...aggregated taker flow and CVD, one frame a second (market: split, perp, spot, all)Developer
strata.levels:{coin} (optional :{window})the liquidation model's levels, pushed when they change (checked every minute); 30d from DeveloperSandbox
calendar / calendar:{country}calendar events as they happen (release, revision, reschedule); resumableSandbox
mcap:{index} (optional :{res})TOTAL, TOTAL2 or TOTAL3 barsSandbox
indicesall three market-cap indexesSandbox

Calendar channels take filters in the subscribe message, for example only US and importance 3:

JSON
{"op":"subscribe","id":"c1","channels":["calendar"],"filters":{"calendar":{"countries":["US"],"min_importance":3}}}

How many channels you may hold at once depends on your tier (Tiers); over the limit, the ack refuses the extra channels with channel_limit.

The Developer API documentation is in English.