API SDMX 2.1 - data discovery

These API operations support requests for catalogues of data and SDMX lists of structural metadata and data.

SDMX 2.1 endpoint - SDMX lists of structural metadata and data

This is the REST request for retrieving the list of all structural metadata from the SDMX 2.1 endpoint:

https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/all?detail=<details>

where

Parameter	Description
api_base_uri	See definition of api_base_uri
resource	Following resources are supported: dataflow datastructure codelist conceptscheme
agencyID	See definition of agencyID
Optional	Description
details	Specify the scope: full to return everything for each item (default). Requesting full scope can return very large responses. Potentially it may be preferable to request first a stub view, and then request individually (relevant) artefact(s) in sequence. allstubs / referencestubs to return only the name of each item
completestubs	true to return the name, description and annotations of each item

as illustrated by

SDMX provides a metamodel for describing data in any statistical domain:

A category scheme is a container for categories, which can be organized in a tree hierarchy.
Categories in SDMX are used to classify Dataflows;
- Each of the dataflows can be connected to one or more categories, and
- Any one category can be connected to zero or more dataflows.
  This connection supports data discovery by organised topics, e.g. Economy and finance, Population and social conditions, Industry, trade and services etc.
A categorisation links a category in a Category Scheme to any other Identifiable structure in SDMX. Typically in a dissemination environment a categorisation would link a Category to a Dataflow.

The request is the same as for retrieving the list of all structural metadata:

https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/all

where

Parameter	Description
api_base_uri	See definition of api_base_uri
resource	Following resources are supported: categoryscheme categorisation
agencyID	See definition of agencyID

Note that there is no detail parameter for resources 'categoryscheme' and 'categorisation'.

Examples
Get all categoryschemes:
https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1/categoryscheme/ESTAT/all
Get all categorisations:
https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1/categorisation/ESTAT/all

The request is the same as for retrieving other structural metadata:

https://<api_base_uri>/sdmx/2.1/<resource>/<agencyID>/<resourceID>

where

Parameter	Description
api_base_uri	See definition of api_base_uri
resource	Following resources are supported: categoryscheme categorisation
agencyID	See definition of agencyID
resourceID	The identifier of the resource The resourceID for a categorisation is a GUID. This information is to be found by requesting the list of all categorisations.

as illustrated by

Examples
Get categoryscheme for AGRIC:
https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1/categoryscheme/ESTAT/AGRIC
Get a categorisation under AGRIC:
https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1/categorisation/ESTAT/APRO_MT_STRPIG_uuid_apro_mt_str

Expand all Collapse all