Sdmx Dataflow Structure
sdmx_dataflow_structureGet the structure of one dataflow from any SDMX 2.1 registry: its ordered dimensions and, for each, the valid codes with labels. This answers "what do the codes in dataflow X mean" and "what key do I need to pull data from it" — use it before calling a registry-specific get_data tool. Covers eurostat, oecd, ecb, unsd (UN Statistics Division via the data.un.org SDMX hub), imf, bis, ilo, abs. For ILO or ABS dataflows, prefer the ilostat/abs-au packs' own dataflow_structure tool — this one exists mainly for the other six. Example: sdmx_dataflow_structure({ registry: "eurostat", dataflow: "une_rt_m" }) or sdmx_dataflow_structure({ registry: "bis", dataflow: "WS_CBPOL" }).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agency | No | Override the registry's default maintaining agency id, e.g. "OECD.SDD.NAD" for an OECD dataflow published by a specific directorate. Most callers can omit this. | |
| version | No | Dataflow version, e.g. "1.0". Defaults to "latest". | |
| dataflow | Yes | Dataflow id, e.g. "une_rt_m" (Eurostat), "WS_CBPOL" (BIS), "EER" (IMF). Case usually does not matter but pass it exactly as published. | |
| registry | Yes | Which SDMX registry to query: eurostat, oecd, ecb, unsd, imf, bis, ilo, abs. | |
| max_codes_per_dimension | No | Cap codes returned per dimension (default 50, max 500). Codelists like country or region lists can have thousands of codes. |