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

GET /v1/calendar/series/{id}/history

#GET /v1/calendar/series/{id}/historylistCalendarSeriesHistory

A series' released figures, newest first

Scopecalendar:read
Lowest tiersandbox
Weight (units)5
History each tier may readSandbox: 92 days; Starter: 366 days; Elite (included): 366 days; Developer: 800 days; Business: 800 days
Paginatedyes: follow meta.next_cursor
SDKPython client.calendar.series_history ยท JavaScript cd.calendar.seriesHistory

Parameters

ParameterInTypeDescription
id requiredpathstringSeries id (e.g. US.CPI.MOM).
fromquerystringStart, inclusive: unix seconds or RFC 3339.
toquerystringEnd, exclusive: unix seconds or RFC 3339. Default now.
limitqueryintegerRows per page, at most 500 (default 100).
cursorquerystringmeta.next_cursor of the previous page (opaque; bound to the route).

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

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

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.calendar.seriesHistory("<id>");
console.log(r.data, r.meta.attribution);

The Developer API documentation is in English.