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

GET /v1/flow/cvd

#GET /v1/flow/cvdgetCvd

Cumulative volume delta from the window's first bar

Scopeanalytics:read
Lowest tiersandbox
Weight (units)1; 2 over 1,000 bars; 10 over 30 days
History each tier may readSandbox: 7 days; Starter: 30 days; Elite (included): 30 days; Developer: 90 days; Business: 90 days
SDKPython client.flow.cvd ยท JavaScript cd.flow.cvd

Parameters

ParameterInTypeDescription
coin requiredquerystringCoin ticker, upper case (BTC).
marketquery"split" | "perp" | "spot" | "all"Which markets to sum.
resquerystringResolution of the series (5, 15, 30, 60, 240, 1D).
fromquerystringStart, inclusive: unix seconds or RFC 3339.
toquerystringEnd, exclusive: unix seconds or RFC 3339. Default now.

Errors

  • 400 invalid_param, invalid_cursor
  • 401 unauthorized: missing, unknown, revoked or expired key
  • 403 insufficient_scope, tier_required
  • 404 not_found, not_available, not_in_sandbox
  • 422 window_too_large
  • 429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
  • 503 api_disabled, overloaded

Example

Shell
curl "https://api.chartdeck.trade/v1/flow/cvd?coin=BTC" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"
Python
from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.flow.cvd(coin="BTC")
print(r.data, r.meta["attribution"])
JavaScript
import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.flow.cvd({ coin: "BTC" });
console.log(r.data, r.meta.attribution);

The Developer API documentation is in English.