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

GET /v1/usage

#GET /v1/usagegetUsage

Units used per day and per route

Scopeaccount:read
Lowest tiersandbox
Weight (units)1
SDKPython client.account.usage ยท JavaScript cd.account.usage

Parameters

ParameterInTypeDescription
daysqueryintegerDays back, 1 to 90 (default 30).

Answer

data: { month, quota: { used, limit, remaining }, days: [{ day, calls, units, errors }], routes: [{ route, calls, units }] }

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/usage" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"
Python
from chartdeck import Client

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

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.account.usage();
console.log(r.data, r.meta.attribution);

The Developer API documentation is in English.