Get Top Observations
get_top_observationsRetrieve the highest or lowest numeric observations from ABS, RBA, or APRA datasets. Specify the source, dataset, and number of top observations.
Instructions
Source-aware convenience wrapper for highest or lowest numeric observations.
For a single curated indicator prefer get_economic_series(concept=...), which resolves one series; pass series_ids=[...] to narrow a broad dataset instead of returning every series it contains.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | Yes | Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority. | |
| identifier | Yes | Non-empty dataset or table id. | |
| n | No | Positive observation count. | |
| direction | No | Whether to return the highest or lowest numeric observations. | highest |
| key | No | ABS SDMX key, or "all" for all series. | all |
| table_id | No | Non-empty dataset or table id. | |
| series_ids | No | Optional list of non-empty source-native series IDs to keep after download. | |
| 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. | |
| start_date | No | Optional ISO date bound in YYYY-MM-DD format. | |
| end_date | No | Optional ISO date bound in YYYY-MM-DD format. |
Output 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. |