OEoecd
Data queries

Get data

get/data/{flow}/{key}/{provider}

Request

Path parameters

flowstring required

The statistical domain (aka dataflow) of the data to be returned.

Examples:

  • EXR: The ID of the domain
  • ECB,EXR: The EXR domain, maintained by the ECB
  • ECB,EXR,1.0: Version 1.0 of the EXR domain, maintained by the ECB
keystring required

The (possibly partial) key identifying the data to be returned.

The keyword all can be used to indicate that all data belonging to the specified dataflow and provided by the specified provider must be returned.

The examples below are based on the following key: Frequency, Country, Component of inflation, Unit of measure.

  • M.DE.000000.ANR: Full key, matching exactly one series, i.e. the monthly (M) rates of change (ANR) of overall inflation (000000) in Germany (DE).
  • A+M.DE.000000.ANR: Retrieves both annual and monthly data (A+M), matching exactly two series
  • A+M..000000.ANR: The second dimension is wildcarded, and it wil therefore match the annual and monthly rates of change of overall inflation in any country.
providerstring required

The provider of the data to be retrieved.

The keyword all can be used to indicate that all data matching the supplied key and belonging to the specified dataflow and provided by any data provider must be returned.

Examples:

  • ECB: Data provided by ECB
  • CH2+NO2: Data provided by CH2 or NO2

Query parameters

startPeriodstring

The start of the period for which results should be supplied (inclusive).

Can be expressed using 8601 dates or SDMX reporting periods.

Examples:

  • 2000: Year (ISO 8601)
  • 2000-01: Month (ISO 8601)
  • 2000-01-01: Date (ISO 8601)
  • 2000-Q1: Quarter (SDMX)
  • 2000-W01: Week (SDMX)
endPeriodstring

The end of the period for which results should be supplied (inclusive).

Can be expressed using 8601 dates or SDMX reporting periods.

Examples:

  • 2000: Year (ISO 8601)
  • 2000-01: Month (ISO 8601)
  • 2000-01-01: Date (ISO 8601)
  • 2000-S1: Semester (SDMX)
  • 2000-D001: Day (SDMX)
updatedAfterstring date-time

The last time the query was performed by the client.

The response should include the latest version of what has changed in the database since that point in time (i.e. additions, revisions or deletions since the last time the query was performed).

firstNObservationsinteger

The maximum number of observations to be returned starting from the oldest one

lastNObservationsinteger

The maximum number of observations to be returned starting from the most recent one

dimensionAtObservationstring

Indicates how the data should be packaged.

The options are:

  • TIME_PERIOD: A timeseries view
  • The ID of any other dimension: A cross-sectional view of the data
  • AllDimensions: A flat view of the data.
detail'full' | 'dataonly' | 'serieskeysonly' | 'nodata'

The amount of information to be returned.

Possible options are:

  • full: All data and documentation
  • dataonly: Everything except attributes
  • serieskeysonly: The series keys. This is useful to return the series that match a certain query, without returning the actual data (e.g. overview page)
  • nodata: The series, including attributes and annotations, without observations.
includeHistoryboolean

Retrieve previous versions of the data.

When true, the response will contain up to two datasets per dissemination, one containing new or updated values and one containing the deleted data (if any).

Headers

Accept-Encoding'br' | 'compress' | 'deflate' | 'exi' | 'gzip' | 'identity' | 'pack200-gzip' | 'zstd'

Specifies whether the response should be compressed and how.

identity (the default) indicates that no compression will be performed.

Accept-Languagestring

Specifies the client's preferred language.

If-Modified-Sincestring date-time

Instructs to return the content matching the query only if it has changed since the supplied timestamp.

Response

OK

string required

Changes

No recorded changes to this operation across all 1 revision of this API.