v1

latestOpenAPI 3.0.02026-07-266091181.5 KB
economics

Returns the economic calendar data

Returns economic calendar data including economic indicators, releases, and reports from various countries. Includes actual values, consensus estimates, and prior values for economic events such as GDP, employment data, inflation metrics, and more.

get/api/v2.1/calendar/economics

Query parameters

pageinteger

Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date

pagesizeinteger

Number of results returned. Limit 1000

parameters[date]string YYYY-MM-DD

Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest

parameters[date_from]string YYYY-MM-DD

Date to query from point in time

parameters[date_to]string YYYY-MM-DD

Date to query to point in time

parameters[importance]1 | 2 | 3

The importance level to filter by. Uses Greater Than or Equal To the importance indicated

parameters[updated]integer

Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated

countrystring A-Z:3

3-Digit Country Code (e.g., USA, CAN, GBR)

event_namestring csv

One or more event name prefixes separated by a comma (e.g., CPI matches CPI, CPI (MoM), CPI (Mom) - Prelim)

event_categorystring csv

One or more categories separated by a comma

Headers

accept'application/json' required

Specifies return format. Query parameters work the same for both formats

Response

success

Example response

{
  "economics": [
    {
      "actual": "216000",
      "actual_t": "216K",
      "confirmed": true,
      "consensus": "170000",
      "consensus_t": "170K",
      "country": "United States",
      "date": "2024-01-09",
      "description": "The change in the number of employed people",
      "event_category": "Employment",
      "event_name": "Nonfarm Payrolls",
      "event_period": "December",
      "id": "60a7f5e8e4b0f5a3c8e9f5af",
      "importance": 5,
      "notes": "Nonfarm payrolls beat expectations",
      "period_year": 2023,
      "prior": "199000",
      "prior_t": "199K",
      "time": "08:30:00",
      "updated": 1704819600
    }
  ]
}