Get ABS Data
get_abs_dataRead-onlyIdempotent
Retrieve normalized ABS time-series data using SDMX keys, with optional period bounds, last N observations, and updated-after filtering.
Instructions
Expert/source-native ABS SDMX retrieval in a normalised response shape.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataflow_id | Yes | Non-empty dataset or table id. | |
| key | No | ABS SDMX key, or "all" for all series. | all |
| start_period | No | Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format. | |
| end_period | No | Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format. | |
| last_n | No | Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped. | |
| updated_after | No | Optional ISO date or datetime accepted by the ABS updatedAfter API. | |
| include_observation_dimensions | No | Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | Yes | Source, provenance, cache, and retrieval metadata for this response. | |
| series | Yes | Series descriptors keyed by series_id. | |
| observations | Yes | Long-form observations keyed by date and series_id. |