Discovery and markets API
Macro calendar brief: the most important releases this week
The 60 most important economic releases due or just out (CPI, jobs, rates), with forecast, previous and actual.
/api/external/discovery/macro-calendar-briefWhat it returns
The brief of macro-calendar; prefer it unless you need every minor release. The same query: range, importance and country. It lists the 60 most important releases of the window, oldest first, each exactly as macro-calendar lists it, with how many releases the window holds at each importance. Raise importance or name a country to see every release of that kind.
Chains
This endpoint is not tied to a chain: it takes no chain in its request.
Request
Send your key in the x-dex-data-key header. Replace each <placeholder> with a real value.
curl -H "x-dex-data-key: $DEXDATA_API_KEY" \ "https://api.dexdata.io/api/external/discovery/macro-calendar-brief"
| Parameter | Description |
|---|---|
rangequery · string · optional | upcoming (next 7 days), recent (last 7 days) or both. Defaults to upcoming.upcomingrecentboth |
importancequery · string · optional | Lowest importance kept: 1 low, 2 medium, 3 high. Defaults to 1 (all).123 |
countryquery · string · optional | Keep one country, as an uppercase ISO 3166-1 alpha-2 code; EU is the eurozone. |
Response fields
A JSON response. Every field is always present; null means the value could not be established, never zero.
| Field | Type | Description |
|---|---|---|
range | string | The range answered. |
from | integer | Start of the range, unix seconds. |
to | integer | End of the range, unix seconds. |
eventCount | integer | Releases in the full answer, after importance and country. |
eventsByImportance | object[] | Releases in the full answer per importance, highest first; an importance with none is left out. |
eventsByImportance[].importance | integer | 1 low, 2 medium, 3 high. |
eventsByImportance[].eventCount | integer | Releases at that importance. |
events | object[] | The 60 most important releases, ties kept in time order, listed oldest first, each exactly as macro-calendar lists it. |
events[].time | integer | Release time, unix seconds. |
events[].timeIsExact | boolean | False when only the day is known. |
events[].country | string | Country or area name. |
events[].countryCode | string | null | ISO 3166-1 alpha-2 code, EU for the eurozone; null if unknown. |
events[].name | string | The release, ending with the period it covers. |
events[].importance | integer | 1 low, 2 medium, 3 high. |
events[].forecast | string | null | Consensus forecast, as published. |
events[].previous | string | null | The previous release's figure. |
events[].revisedPrevious | string | null | The previous figure as revised in this release, when it was. |
events[].actual | string | null | The published figure; null until it is out. |
events[].effect | object[] | null | What the figure means for markets; [] minor impact, null not out yet or not read. |
events[].effect[].direction | string | |
events[].effect[].asset | string | e.g. US dollar, euro, crude oil, gold and silver. |
Start building with DexData today
Sign in, create a key and make your first call in a minute. Free credits every month, and you only pay for calls that succeed.
Get a free API key