Child pages
  • API SDMX 2.1 - data query

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Depending on the request, a data query can result in a (potentially very) large response in which case data is delivered asynchronously. For more information please read the page 'API getting started' for the section about ASYNC endpoint

This is the SDMX 2.1 REST request for data:

...

Parameter

Description

api_base_uri

See definition of api_base_uri

resource

Following resource is supported: data

flowRef

The identifier of the dataflow reference.
Perform a data discovery metadata query for all dataflows to get the list of dataflow references.

Optional

Description

key

The key in the query is constructed as a dot ('.') separated list of dimension filtered values.
See also Data filtering on dimension

parameters

Multiple parameters can be combined by means of '&' character.


Format
format=<value>
To get responses in other format than SDMX-ML 2.1 Generic, wich is supported by default.
Supported values are:
SDMX_2.1_STRUCTURED for SDMX-ML 2.1 Structure Specific Data
SDMX-CSV for SDMX-CSV flat format
JSON for JSON-stat
TSV for Tab Separated Value


Data filtering on time
startPeriod=<value>&endPeriod=<value>
See also data filtering on time


Data filtering on first N and last N observations
firstNObservations=<value>&lastNObservations=<value>
See also data filtering on first N and last N observations


Details
detail=<value>
To get responses with details.
Supported values are:
dataonly for each series, only the observations are returned, no attributes are returned
serieskeysonly for each series, only the series key are returned, no data or attributes are returned
nodata for each series, only the series level attributes are returned
See also data details


Compression
compressed=true
To get responses in .gz compressed format

...

Retrieving data in SDMX-ML Generic Data format using REST from the SDMX 2.1 endpoint.

...

Retrieving data in SDMX-ML Structure Specific Data format using REST from the SDMX 2.1 endpoint.

...

Tip

In SDMX-CSV, the response contains the data displayed in a flat format. It includes codes, and not labels, for dimensions positions. The labels equivalent to codes can be resolved by requesting the dataflow or data structure definition with references resolution.

Retrieving data in SDMX-CSV format using REST from the SDMX 2.1 endpoint.

...

Retrieving data in JSON-stat format in English using REST from the SDMX 2.1 endpoint.

...

Tip

In TSV, the response includes codes, and not labels, for dimensions positions. The labels equivalent to codes can be resolved by requesting the dataflow or data structure definition with references resolution.

Retrieving data in TSV format using REST from the SDMX 2.1 endpoint.