GET /v1/calendar/events

#`GET /v1/calendar/events`listCalendarEvents

Economic calendar events in a time range (scheduled, released, revised)

Ordered by time, then importance, then id. actual is null until the release.

Scope	calendar:read
Lowest tier	sandbox
Weight (units)	1
History each tier may read	Sandbox: 31 days; Starter: 92 days; Elite (included): 92 days; Developer: 366 days; Business: 800 days
Paginated	yes: follow meta.next_cursor
SDK	Python client.calendar.list_events · JavaScript cd.calendar.listEvents

Parameters

Parameter	In	Type	Description
`from`	query	`string`	Start, inclusive: unix seconds or RFC 3339.
`to`	query	`string`	End, exclusive: unix seconds or RFC 3339. Default now.
`country`	query	`string`	Comma-separated countries (US, CRYPTO, EU, GB, JP, CN, CA, AU, NZ, CH).
`importance`	query	`integer`	Lowest importance, 1 to 3.
`category`	query	`string`	Comma-separated categories.
`series`	query	`string`	Comma-separated series ids.
`status`	query	`string`	Comma-separated: scheduled, released, delayed, cancelled.
`limit`	query	`integer`	Rows per page, at most 500 (default 100).
`cursor`	query	`string`	`meta.next_cursor` of the previous page (opaque; bound to the route).

Answer

data: a list of events: id, series, name, period, at, t, tentative, status, country, category, importance, unit, decimals, previous, forecast, forecast_kind, actual, revised, actual_at, delayed, publisher, report_url

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/events" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.calendar.list_events()
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.listEvents();
console.log(r.data, r.meta.attribution);

GET /v1/calendar/events

#GET /v1/calendar/eventslistCalendarEvents

#`GET /v1/calendar/events`listCalendarEvents