Order flow and analytics
Aggregated taker flow and CVD, OI, funding and long/short over every venue, OI build, stacked imbalances, screener, TWAPs, market-cap indexes.
These are ChartDeck's own computations over the data it records, read through the same code the terminal and ChartScript use, so the API, the chart and a script always agree.
- Aggregated delta and CVD (
/v1/flow/agg-delta,/v1/flow/cvd): taker buys, sells and their difference per bar, summed over every exchange (perpetuals, spot, or both split), and its running sum from the window's first bar. - Aggregates over venues (
/v1/flow/oi-agg,/v1/flow/funding-agg,/v1/flow/lsr-agg): open interest in coins summed over the perpetual venues; funding per 8 hours OI-weighted and as a simple mean; the long/short ratio OI-weighted. - OI build (
/v1/flow/oi-build): per bar, whether open interest and price moved together (longs or shorts opening or closing), the terminal's reading. - Stacked imbalances (
/v1/footprint/stacks): the Footprint chart's zones where buyers or sellers dominated several price rows in a row. - Screener (
/v1/screener): the Market Screener's table of metrics per market. - TWAPs (
/v1/twap): large time-weighted orders on Hyperliquid, running and finished. - Market-cap indexes (
/v1/indices/{index}): TOTAL, TOTAL2 and TOTAL3 bars and the newest snapshot.
Modelled readings (OI build, stacked imbalances, the TOTAL2 / TOTAL3 reconstruction) are reading aids, not forecasts; their answers say so.
#Operations
| Operation | Summary |
|---|---|
GET /v1/flow/agg-delta | Taker buys, sells and delta per bar, every exchange summed |
GET /v1/flow/cvd | Cumulative volume delta from the window's first bar |
GET /v1/flow/funding-agg | Funding per 8 h: OI-weighted and simple mean over the venues |
GET /v1/flow/lsr-agg | Long/short ratio, OI-weighted over the coin's perpetuals |
GET /v1/flow/oi-agg | Open interest in coins summed over the perpetual venues |
GET /v1/flow/oi-build | Open interest build regimes per bar (longs / shorts opening or closing) |
GET /v1/footprint/stacks | Stacked imbalance zones (the Footprint chart's rule) |
GET /v1/indices/{index} | Market-cap index bars (TOTAL, TOTAL2, TOTAL3) and the newest snapshot |
GET /v1/screener | The Market Screener's metrics table |
GET /v1/twap | Hyperliquid TWAP orders (running and finished) |