Get structure (metadata)
get_metadataInspect a dataset's dimensions and codelists to find valid codes for building series keys before retrieving economic data.
Instructions
Return the structure (dimensions and codelists) of a dataset, to find the codes get_data needs.
- OECD, IMF, BIS: source + dataflow → the dimensions and codelists of the institution's own DSD.
A series key is the codes joined with '.' in dimension order (e.g. BIS WS_CBPOL → 'M.US').
- ECOS: stat_code → the table's structure mapped to SDMX (FREQ + ITEM_CODE1..4, coverage, units).
output_format="sdmx" returns an SDMX-JSON structure message.
Args:
stat_code: ECOS table code (e.g. "901Y009")
source: OECD | IMF | BIS (with dataflow)
dataflow: SDMX dataflow (e.g. "BIS:WS_CBPOL(1.0)", "IMF.STA:CPI")
code_keyword: filter codes by name or value (e.g. "Japan", "JPN", "current account")
codes_limit: maximum codes per dimension (default 30)
output_format: "compact" | "sdmx" (ECOS only)
language: "kr" | "en" (ECOS names)
Returns:
dimensions, codes per dimension, a key template
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | ||
| dataflow | No | ||
| language | No | kr | |
| stat_code | No | ||
| codes_limit | No | ||
| code_keyword | No | ||
| output_format | No | compact |