.. currentmodule:: sdmx Data sources ============ SDMX distinguishes: - a **data provider** —the original publisher or maintainer of statistical information and metadata. - a **data source** —a specific web service that provides access to SDMX content via a standard API. A single data *source* might aggregate and provide data or metadata from many data *providers*. Or, an agency might operate a data source that only contains information they provide themselves; in this case, the source and provider are matched one-to-one. :mod:`sdmx` has built-in support for a number of data sources, each identified with a string such as :py:`"ABS"`. Use :meth:`list_sources` to list these, or see the file :file:`sources.json` in the package source code. https://khaeru.github.io/sdmx displays a summary of every SDMX-REST API endpoint for every data source known to :mod:`sdmx`; this summary is `updated daily by an automatic run `_ of the test suite. Read the following sections, for more details on how the limitations and quirks of particular sources are handled. :mod:`sdmx` also supports adding other data sources; see :meth:`add_source` and :class:`~.source.Source`. .. _data-source-limitations: Data source limitations ----------------------- Each SDMX web service provides a subset of the full SDMX feature set, so the same request made to two different sources may yield different results, or an error message. In order to anticipate and handle these differences: 1. :meth:`add_source` accepts "data_content_type" and "supported" keys. For example: .. code-block:: json [ { "id": "ABS", "data_content_type": "JSON" }, { "id": "UNESCO", "supported": {"datastructure": false} }, ] :mod:`sdmx` will raise :class:`NotImplementedError` on an attempt to query the "datastructure" API endpoint of either of these data sources. 2. :mod:`sdmx.source` includes adapters (subclasses of :class:`~.source.Source`) with hooks used when querying sources and interpreting their HTTP responses. These are documented below, e.g. ABS_, ESTAT_, and SGR_. .. _source-policy: Handling and testing limitations and (un)supported endpoints ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As of version 2.5.0, :mod:`sdmx` handles service limitations as follows. Please `open an issue `__ if the supported endpoints or behaviour of a particular service appear to have changed. - :attr:`.source.Source.supports` lists endpoints/:class:`resources <.Resource>` that are not supported by *any* known web service. - :file:`sources.json` contains ``supports: {"[resource]": false}`` for any endpoint where the service returns an HTTP **404 Not found** response code. This means that the service fails to even give a proper 501 response (see below). :meth:`.Client.get` will refuse to query these sources at all, instead raising :class:`NotImplementedError`. You can override this behaviour by giving :py:`force=True` as an argument to :meth:`~.Client.get`. - The test suite (:mod:`test_sources`) includes notation of all endpoints for which services return **400 Bad syntax** or **501 Not implemented** response codes. :mod:`sdmx` will make an actual query to these endpoints, but raise built-in Python exceptions that can be caught and handled by user code: - For a 501 response code, :class:`NotImplementedError` is raised. This is behaviour *fully compliant with the SDMX standard*: the service accurately and honestly responds when a client makes a request that the server does not implement. - For a 400 response code, :class:`HTTPError` is raised. Some of these “bad syntax” responses are erroneous: the service actually has a *non-standard* URL scheme or handling, different from the SDMX-REST standard. The :class:`.Client` is constructing a standards-compliant URL, but the service idiosyncratically rejects it. Handling these idiosyncrasies is currently out-of-scope for :mod:`sdmx`. .. _source-matrix: - Because of the large number of services and endpoints, this matrix of support is only periodically updated. https://khaeru.github.io/sdmx includes all endpoints known to return a reply, even if the reply is an error message of some sort. SDMX-JSON—only services ~~~~~~~~~~~~~~~~~~~~~~~ A key difference is between sources offering SDMX-ML and SDMX-JSON content. Although the SDMX-JSON 2.0 format (corresponding to SDMX 3.0) includes structure messages, many web services that return SDMX-JSON still do not provide such content or support structure queries; only data queries. The SDMX-REST standard specifies how services should respond to the HTTP ``Accepts:`` header and return either SDMX-ML or SDMX-JSON, but implementation of this feature is inconsistent across known sources. Where data structures are not available, :mod:`sdmx` cannot automatically construct keys. For such services, start by browsing the source's website to identify a dataflow of interest. Then identify the key format and construct a key for the desired data request. .. _ABS: ``ABS``: Australian Bureau of Statistics (SDMX-ML) -------------------------------------------------- SDMX-ML — `Website `__ .. versionadded:: 2.10.0 .. _ABS_JSON: ``ABS_JSON``: Australian Bureau of Statistics (SDMX-JSON) --------------------------------------------------------- SDMX-JSON — `Website `__ .. autoclass:: sdmx.source.abs_json.Source() :members: .. _BBK: ``BBK``: German Federal Bank ---------------------------- SDMX-ML — Website `(en) `__, `(de) `__ .. versionadded:: 2.5.0 - German name: Deutsche Bundesbank - The web service has some non-standard behaviour; see :issue:`82`. - The `version` path component is not-supported for non-data endpoints. :mod:`sdmx` discards other values with a warning. - Some endpoints, including :data:`.codelist`, return malformed URNs and cannot be handled with :mod:`sdmx`. .. autoclass:: sdmx.source.bbk.Source() :members: .. _BIS: ``BIS``: Bank for International Settlements ------------------------------------------- SDMX-ML — `Website `__ — `API reference `__ .. versionadded:: 2.5.0 .. _ECB: ``ECB``: European Central Bank ------------------------------ SDMX-ML — `Website `__ - Supports categorisations of data-flows. - Supports preview_data and series-key based key validation. .. versionchanged:: 2.10.1 `As of 2023-06-23 `__ the ECB source is part of an “ECB Data Portal” that replaces an earlier “ECB Statistical Data Warehouse (SDW)” (`documentation `__ still available). The URL in :mod:`sdmx` is updated. Text on the ECB website (above) states that the previous URL (in :mod:`sdmx` ≤ 2.10.0) should continue to work until about 2024-06-23. .. _ESTAT: ``ESTAT``: Eurostat and related ------------------------------- SDMX-ML — Website `1 `__, `2 `__ - Eurostat also maintains four additional SDMX REST API endpoints, available in :mod:`sdmx` with the IDs below. These are described at URL (2) above. .. contents:: :local: - In some cases, the service can have a long response time, so :mod:`sdmx` will time out. Increase the timeout attribute if necessary. .. automodule:: sdmx.source.estat :members: Source, handle_references_param .. automodule:: sdmx.source.estat3 :members: Source .. _ESTAT_COMEXT: ``ESTAT_COMEXT``: Eurostat Comext and Prodcom databases ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The :class:`.Agency` ID for data is still ``ESTAT``. .. _COMP: .. _EMPL: .. _GROW: ``COMP``, ``EMPL``, ``GROW``: Directorates General of the European Commission ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These are, respectively: - ``COMP``: Directorate General for Competition. - ``EMPL``: Directorate General for Employment, Social Affairs and inclusion. - ``GROW``: Directorate General for Internal Market, Industry, Entrepreneurship and SMEs. No separate online documentation appears to exist for these API endpoints. In order to identify available data flows: .. code-block:: python COMP = sdmx.Client("COMP") sm = COMP.dataflow() print(sm.dataflow) .. automodule:: sdmx.source.comp :members: .. automodule:: sdmx.source.empl :members: .. automodule:: sdmx.source.grow :members: .. _ILO: ``ILO``: International Labour Organization ------------------------------------------ SDMX-ML — `Website `__ .. versionchanged:: 2.15.0 Sometime before 2024-04-26, the base URL of this source changed from ``https://www.ilo.org/sdmx/rest`` to ``https://sdmx.ilo.org/rest``. The "SDMX query builder" at the above URL reflects the change, but the documentation still shows the old URL, and there does not appear to have been any public announcement about the new URL, retirement of the old URL, etc. Thanks :gh-user:`SebaJeku` for the tip (:issue:`177`). .. _IMF: ``IMF``: International Monetary Fund's “SDMX Central” source ------------------------------------------------------------ SDMX-ML — `Website `__ - Subset of the data available on http://data.imf.org. - Supports series-key-only and hence dataset-based key validation and construction. .. _INEGI: ``INEGI``: National Institute of Statistics and Geography (Mexico) ------------------------------------------------------------------ SDMX-ML — `Website `__. - Spanish name: Instituto Nacional de Estadística y Geografía. .. _INSEE: ``INSEE``: National Institute of Statistics and Economic Studies (France) ------------------------------------------------------------------------- SDMX-ML — Website `(en) `__, `(fr) `__ - French name: Institut national de la statistique et des études économiques. .. autoclass:: sdmx.source.insee.Source() :members: .. _ISTAT: ``ISTAT``: National Institute of Statistics (Italy) --------------------------------------------------- SDMX-ML — Website `(en) `__, `(it) `__ - Italian name: Istituto Nazionale di Statistica. - Similar server platform to Eurostat, with similar capabilities. - Distinct API endpoints are available for: - 2010 Agricultural census - 2011 Population and housing census - 2011 Industry and services census …see the above URLs for details. .. _LSD: ``LSD``: National Institute of Statistics (Lithuania) ----------------------------------------------------- SDMX-ML — `Website `__ - Lithuanian name: Lietuvos statistikos. - This web service returns the non-standard HTTP content-type "application/force-download"; :mod:`sdmx` replaces it with "application/xml". .. _NB: ``NB``: Norges Bank (Norway) ---------------------------- SDMX-ML — `Website `__ - Few data flows, so do not use category scheme. - It is unknown whether NB supports series-keys-only. .. _NBB: ``NBB``: National Bank of Belgium (Belgium) ------------------------------------------- SDMX-JSON — `Website `__ — API documentation `(en) `__ - French name: Banque Nationale de Belgique. - Dutch name: Nationale Bank van België. - As of 2020-12-13, this web service (like STAT_EE) uses server software that serves SDMX-ML 2.0 or SDMX-JSON. Since :mod:`sdmx` does not support SDMX-ML 2.0, the package is configured to use the JSON endpoint. - The web service returns a custom HTML error page rather than an SDMX error message for certain queries or an internal error. This appears as: ``ValueError: can't determine a SDMX reader for response content type 'text/html; charset=utf-8'`` .. _OECD: .. currentmodule:: sdmx.source.oecd ``OECD``: Organisation for Economic Cooperation and Development (SDMX-ML) ------------------------------------------------------------------------- SDMX-ML — `Website `__, `documentation `__ - As of 2023-08-14, the site includes a disclaimer that “This is a public beta release. Not all data is available on this platform yet, as it is being progressively migrated from https://stats.oecd.org.” - The OECD website `describes an older SDMX-ML API `__, but this is an implementation of SDMX 2.0, which is not supported by :mod:`sdmx` (see :ref:`sdmx-version-policy`). .. autoclass:: sdmx.source.oecd.Source :members: .. versionadded:: 2.12.0 .. _OECD_JSON: .. currentmodule:: sdmx.source.oecd_json ``OECD_JSON``: Organisation for Economic Cooperation and Development (SDMX-JSON) -------------------------------------------------------------------------------- SDMX-JSON — `Website `__ - Only :ref:`SDMX-JSON version 1.0 ` is supported. .. versionchanged:: 2.12.0 Renamed from ``OECD``. .. autofunction:: sdmx.source.oecd_json.Client .. autoclass:: sdmx.source.oecd_json.HTTPSAdapter .. _SGR: ``SGR``: SDMX Global Registry ----------------------------- SDMX-ML — `Website `__ .. autoclass:: sdmx.source.sgr.Source() :members: .. _SPC: ``SPC``: Pacific Data Hub DotStat by the Pacific Community (SPC) ---------------------------------------------------------------- SDMX-ML — `API documentation `__ — `Web interface `__ - French name: Communauté du Pacifique .. _STAT_EE: ``STAT_EE``: Statistics Estonia (Estonia) ----------------------------------------- SDMX-JSON — `Website `__ (et) — API documentation `(en) `__, `(et) `__ - Estonian name: Eesti Statistika. - As of 2023-05-19, the site displays a message: From March 2023 onwards, data in this database are no longer updated! Official statistics can be found in the database at `andmed.stat.ee `__. The latter URL indicates an API is provided, but it is not an SDMX API, and thus not supported. - As of 2020-12-13, this web service (like NBB) uses server software that serves SDMX-JSON or SDMX-ML 2.0. The latter is not supported by :mod:`sdmx` (see :ref:`sdmx-version-policy`). .. _UNESCO: ``UNESCO``: UN Educational, Scientific and Cultural Organization ---------------------------------------------------------------- SDMX-ML — `Website `__ - Free registration required; user credentials must be provided either as parameter or HTTP header with each request. .. warning:: An issue with structure-specific datasets has been reported. It seems that Series are not recognized due to some oddity in the XML format. .. _UNICEF: ``UNICEF``: UN Children's Fund ------------------------------ SDMX-ML or SDMX-JSON — `API documentation `__ — `Web interface `__ — `Data browser `__ - This source always returns structure-specific messages for SDMX-ML data queries; even when the HTTP header ``Accept: application/vnd.sdmx.genericdata+xml`` is given. .. _CD2030: - UNICEF also serves data for the `Countdown to 2030 `_ initiative under a data flow with the ID ``CONSOLIDATED``. The structures can be obtained by giving the `provider` argument to a structure query, and then used to query the data: .. code-block:: python import sdmx UNICEF = sdmx.Client("UNICEF") # Use the dataflow ID to obtain the data structure definition dsd = UNICEF.dataflow("CONSOLIDATED", provider="CD2030").structure[0] # Use the DSD to construct a query for indicator D5 (“Births”) client.data("CONSOLIDATED", key=dict(INDICATOR="D5"), dsd=dsd) - The example query from the UNICEF API documentation (also used in the :mod:`sdmx` test suite) returns XML like: .. code-block:: xml Contrary to this, the corresponding DSD actually has the ID ``DSD_AGGREGATE``, not ``GLOBAL_DATAFLOW``. To retrieve the DSD—which is necessary to parse a data message—first query this data *flow* by ID, and select the DSD from the returned message: .. ipython:: python import sdmx msg = sdmx.Client("UNICEF").dataflow("GLOBAL_DATAFLOW") msg dsd = msg.structure[0] The resulting object `dsd` can be passed as an argument to a :meth:`.Client.get` data query. See the `sdmx test suite `_ for an example. .. _UNSD: ``UNSD``: United Nations Statistics Division -------------------------------------------- SDMX-ML — `Website `__ - Supports preview_data and series-key based key validation. .. _WB: ``WB``: World Bank Group “World Integrated Trade Solution” ---------------------------------------------------------- SDMX-ML — `Website `__ .. _WB_WDI: ``WB_WDI``: World Bank Group “World Development Indicators” ----------------------------------------------------------- SDMX-ML — `Website `__ - This web service also supports SDMX-JSON. To retrieve messages in this format, pass the HTTP ``Accept:`` header described on the service website. Source API ---------- .. currentmodule:: sdmx.source This module defines :class:`Source ` and some utility functions. For built-in subclasses of Source used to provide :mod:`sdmx`'s built-in support for certain data sources, see :doc:`sources`. .. autoclass:: sdmx.source.Source() :members: This class should not be instantiated directly. Instead, use :func:`.add_source`, and then create a new :class:`.Client` with the corresponding source ID. .. automodule:: sdmx.source :members: list_sources, load_package_sources