Discovery and Retrieval
Choosing the right surface
Section titled “Choosing the right surface”Use list_economic_concepts and get_economic_series for ordinary analyst requests. This route is
the safest LLM-facing path because the server controls the mapping from economic concepts to
audited source datasets and series.
Use source-native tools when you know the ABS dataflow, SDMX key, RBA table, or RBA series IDs you want:
search_datasetsranks matching curated ABS and RBA entries.list_cataloguelists entries unranked and supports source, category, and tag filters.get_abs_dataset_structureretrieves ABS SDMX dimensions and code lists.get_abs_dataretrieves ABS data in the normalised response shape.get_rba_tableretrieves RBA statistical tables in the normalised response shape.
list_rba_tables remains available as a deprecated compatibility alias. New integrations should
use list_catalogue(source="rba").
Date bounds
Section titled “Date bounds”get_economic_series accepts analyst-friendly bounds:
YYYYYYYY-QNYYYY-SNYYYY-MMYYYY-MM-DD
The server normalises these to ABS periods or RBA ISO dates after resolving the concept.
Raw ABS and RBA tools keep source-native conventions:
- ABS retrieval uses
start_periodandend_period. - RBA retrieval uses
start_dateandend_date.
Validation behaviour
Section titled “Validation behaviour”- Empty identifiers and empty search queries are rejected before any network call.
last_nmust be positive when provided.- ABS period strings are validated for annual, half-yearly, quarterly, and monthly formats.
- RBA date bounds are validated as ISO dates.
- Unknown semantic concepts and unsupported variants raise explicit validation errors.
Search scores are ranking metadata, not a stable public contract.