describe_dataset
Discover valid filter dimensions, value codes, and source URL for any ABS dataflow. Check if a dataflow supports plain-English values or raw SDMX codes before querying.
Instructions
Describe an ABS dataflow's filter dimensions, value codes, and source.
For curated dataflows (LF, CPI, ANA_AGG, AWE, BA_GCCSA, ERP_Q, JV, LEND_HOUSING, WPI, ABS_ANNUAL_ERP_ASGS2021), returns plain-English dimension names + curated value keys + the ABS source URL.
For other dataflows (~1,200 in total), returns raw SDMX dimensions and codelists translated to the same response shape — pass raw SDMX codes to get_data when querying these.
Examples: # Curated path — plain-English values detail = await describe_dataset("LF") # detail.dimensions = [{'name': 'region', 'values': [{'key': 'nsw', # 'sdmx_code': '1'}, {'key': 'vic', 'sdmx_code': '2'}, ...]}, ...]
# Raw path — full SDMX codelist
detail = await describe_dataset("ALC") # Apparent Consumption of Alcohol
# detail.is_curated == False; values are raw SDMX codesWhen to use: - Before calling get_data on an unfamiliar dataflow — to discover valid filter dim names and value keys - To get the canonical source URL on the ABS site - To see whether a dataflow is curated (plain-English) or raw SDMX
Returns: DatasetDetail with id, name, description, is_curated flag, the list of filter dimensions (name, sdmx_id, values), and abs_url.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | ABS dataflow ID. Use search_datasets to discover, or list_curated to enumerate the 10 dataflows with plain-English support. Case-insensitive — 'lf', 'LF', and ' LF ' all resolve to 'LF'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| abs_url | Yes | ||
| dimensions | Yes | ||
| is_curated | Yes | ||
| description | Yes | ||
| hidden_defaults | No |