Page tree

For versioned artefacts (Code lists, Concept schemes, DSDs) It is important to remember that each version is made available for download via the API.

This is the SDMX 2.1 REST request for structural metadata:

https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/<resourceID>/<version>?<parameters>

In SDMX, a maintainable structure can be uniquely identified by a combination of:

  • resource (i.e codelist, data structure, dataflow, …​),

  • agencyID,

  • resourceID, and

  • version.

ParameterDescription

api_base_uri

See definition of api_base_uri

resource

Following resources are supported:
dataflow
datastructure
codelist
conceptscheme
contentconstraint

agencyID

See definition of agencyID

resourceID

The identifier of the resource

OptionalDescription

version

Used to specify the version of the resourceID.
See also metadata filtering on version

parameters

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


References resolution
references=<value>
To get other resources referenced
See also references resolution


Format
format=<value>
To get responses in other format than SDMX-ML.
This parameter is only supported for resource 'codelist'. Supported values are:
JSON for JSON-stat
TSV for Tab Separated Value


Language
lang=<value>
To get responses in languages other than English (if supported by the content provider).
This parameter maybe set only for resource 'codelist'. Accepted values are for instance for Eurostat:
en for English
fr for French
de for German


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

SDMX 2.1 endpoint - REST - SDMX-ML 2.1 Dataflow

Retrieving a Eurostat dataflow in SDMX-ML 2.1 format using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - SDMX-ML 2.1 Data Structure

Retrieving a Eurostat data structure in SDMX-ML 2.1 format using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - SDMX-ML 2.1 Codelist

Retrieving a Eurostat codelist in SDMX-ML 2.1 format using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - JSON-stat Codelist

It is mandatory to specify the language when requesting JSON-stat format for a codelist

Retrieving a Eurostat codelist in JSON-stat in English format using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - TSV Codelist

It is mandatory to specify the language when requesting TSV format for a codelist

Retrieving a Eurostat codelist in TSV format in English using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - SDMX-ML 2.1 Concept Scheme

Retrieving a Eurostat concept scheme in SDMX-ML 2.1 format using REST from the SDMX 2.1 endpoint.

SDMX 2.1 endpoint - REST - SDMX-ML 2.1 Content Constraint

Retrieving a Eurostat content constraint in SDMX-ML 2.1 format using REST from the SDMX 2.1 endpoint.

_