API TraderAPI QuantAPI Developer
The macroeconomic calendar: scheduled and released economic indicators - GDP, inflation, employment, central-bank decisions and more - with the actual print, the consensus expectation, the surprise versus that expectation and the previous value.
Each row describes a country's release, not a company, so a request needs no instrument: narrow it with country, or omit country for every country covered.
Available Data Points:
- Title: Short descriptive title of the release, including its reference period.
- Date: The release date (
YYYY-MM-DD). - Datetime: The scheduled release time,
YYYY-MM-DDTHH:mmZ(UTC), where known. - Actual Value: The reported value; null until the figure is released.
- Expectation: The consensus forecast for the release.
- Surprise: How far the actual value landed from the expectation.
- Previous: The value reported for the previous period.
- Country ISO2: Two-letter ISO code of the country the release describes (e.g. US, GB, DE).
- Category: Broad classification of the release (e.g. GDP, inflation, employment).
Filtering
from_date is required and to_date defaults to today; pass a future to_date to include scheduled releases. The window may span at most 31 days and bounds the release date in UTC, weekends included. country takes an ISO 3166-1 alpha-2 code the calendar covers; any other code returns 400 invalidCountry listing the covered ones.
Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.
Trial key restrictions: Trial keys may be limited to a specific date range and set of regions. Requests outside the allowed regions or entirely outside the allowed date range are rejected; a date window that partially overlaps the allowed range is trimmed to it, reported in meta.restriction.
Get full access! Get a key at app.ortex.com/apis