API reference
Generated from the routes the API serves (the same document as https://api.chartdeck.trade/v1/openapi.json), version 1.0.0.
- AccountYour key, tier, limits and usage.
- CalendarEconomic calendar: events, releases, revisions and series history.
- NewsMarket news stories with links to the publishers.
- StrataLiquidation model (levels, heatmap, net positions, calibration) and recorded liquidations.
- MarketVenues, markets, candles, open interest, funding, basis, long/short ratio, large trades, order-book heatmap, footprint bars.
- AnalyticsAggregated order flow, OI build regimes, stacked imbalances, screener, TWAP tracker, market-cap indexes.
- WebhooksWebhook endpoints and test deliveries (Developer, Business and Elite included).
- ChartsSTRATA charts as PNG pictures (liquidation levels, liquidation heatmap, positions and net-position heatmaps) for bots.
| Operation | Scope | Summary |
|---|---|---|
GET /v1/basis | market:read | Perpetual vs spot basis per bar (percent) |
GET /v1/calendar/events | calendar:read | Economic calendar events in a time range (scheduled, released, revised) |
GET /v1/calendar/events/{id} | calendar:read | One event with its revision history and change log |
GET /v1/calendar/series | calendar:read | The calendar series (indicators) with country, category, unit and importance |
GET /v1/calendar/series/{id}/history | calendar:read | A series' released figures, newest first |
GET /v1/candles | market:read | OHLCV bars of one market (the chart's own bars); venue mcap = the TOTAL indexes |
GET /v1/charts/{kind}.png | charts:read | A STRATA chart as a PNG picture (1200 x 675) for a bot to post |
GET /v1/etf/flows | market:read | One asset's spot ETF flows per fund and in total, daily or quarterly |
GET /v1/etf/summary | market:read | Every asset's latest spot ETF totals |
GET /v1/flow/agg-delta | analytics:read | Taker buys, sells and delta per bar, every exchange summed |
GET /v1/flow/cvd | analytics:read | Cumulative volume delta from the window's first bar |
GET /v1/flow/funding-agg | analytics:read | Funding per 8 h: OI-weighted and simple mean over the venues |
GET /v1/flow/lsr-agg | analytics:read | Long/short ratio, OI-weighted over the coin's perpetuals |
GET /v1/flow/oi-agg | analytics:read | Open interest in coins summed over the perpetual venues |
GET /v1/flow/oi-build | analytics:read | Open interest build regimes per bar (longs / shorts opening or closing) |
GET /v1/footprint/bars | market:read | Footprint bars: volume at price, buy and sell |
GET /v1/footprint/stacks | analytics:read | Stacked imbalance zones (the Footprint chart's rule) |
GET /v1/funding | market:read | Funding rate per bar, with settlements |
GET /v1/indices/{index} | analytics:read | Market-cap index bars (TOTAL, TOTAL2, TOTAL3) and the newest snapshot |
GET /v1/lsr | market:read | Long/short ratio per bar of one venue |
GET /v1/markets | market:read | Every listed market: venue, symbol, base, quote, type, precision, tick size |
GET /v1/me | account:read | This key, the account tier and limits, and the quota used this month |
GET /v1/news | news:read | News stories, newest first (one row per story, with the publishers that reported it) |
GET /v1/news/sources | news:read | The enabled news sources |
GET /v1/oi | market:read | Open interest per bar (base coin) |
GET /v1/orderbook/heatmap | market:read | Recorded resting liquidity per bar |
GET /v1/screener | analytics:read | The Market Screener's metrics table |
GET /v1/strata/calibration | strata:read | The model scored against recorded liquidations (30 days) |
GET /v1/strata/heatmap | strata:read | The modelled liquidation field over time |
GET /v1/strata/hl | strata:read | Observed Hyperliquid liquidation prices (aggregated, never an address) |
GET /v1/strata/levels | strata:read | Modelled liquidation levels now (or as of `at`) |
GET /v1/strata/liq-exact | strata:read | Single recorded liquidation orders with exact time, price and size (at most 6 hours a call) |
GET /v1/strata/netpos | strata:read | Net positions inferred from open interest |
GET /v1/strata/realized | strata:read | Actual liquidations: hourly totals and price clusters |
GET /v1/strata/symbols | strata:read | The coins with a liquidation model, busiest first, and their venues |
GET /v1/trades/large | market:read | The large prints of one market |
GET /v1/twap | analytics:read | Hyperliquid TWAP orders (running and finished) |
GET /v1/usage | account:read | Units used per day and per route |
GET /v1/venues | market:read | The exchanges and data sources the API serves (id, name, type, quotes, market count) |
GET /v1/webhooks | webhooks:write | Your webhook endpoints |
POST /v1/webhooks | webhooks:write | Add an endpoint; the signing secret is shown once |
GET /v1/webhooks/{id} | webhooks:write | One endpoint and its last 50 deliveries |
DELETE /v1/webhooks/{id} | webhooks:write | Delete an endpoint |
POST /v1/webhooks/{id}/enable | webhooks:write | Turn an endpoint that was switched off after failures back on (failures reset, waiting deliveries due now, a ping sent) |
POST /v1/webhooks/{id}/test | webhooks:write | Send a signed test event (ping) to the endpoint now |