get_data
Retrieve curated APRA data on banks, super funds, and insurers. Filter by institution, measures, and time period to get observations.
Instructions
Query a curated APRA dataset and return observations.
Examples: # CBA's CET1 ratio over time resp = await get_data( "ADI_KEY_STATS", filters={"institution": "cba"}, measures="cet1_ratio", )
# Major banks' total capital, last 5 quarters
resp = await get_data(
"ADI_KEY_STATS",
filters={"sector": "major_banks"},
measures="total_capital",
start_period="2024-01-01",
)
# Total industry gross written premium (general insurance)
resp = await get_data(
"INSURANCE_GENERAL",
filters={"data_item": "Gross written premium",
"industry_segment": "total_industry"},
)
# AustralianSuper member account counts
resp = await get_data(
"SUPER_FUND_LEVEL",
filters={"fund_name": "australian_super"},
measures=["total_member_accounts", "total_members_benefits"],
)Returns: DataResponse with records (or csv), unit, period bounds, row_count, source URL, the actual download_url used, optional framework info (insurance only), and CC-BY 3.0 AU attribution.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | Curated dataset ID. Use search_datasets() / list_curated(). | |
| filters | No | Dimension filters. Keys are plain-English aliases from the dataset's describe_dataset response. Values are matched against the source data; pass a list to OR across values. Permissive dimensions (e.g. institution, fund_name, data_item) accept any string — including substring search via trailing '*' (e.g. {'institution': 'macquarie*'}). | |
| measures | No | Which measure(s) to return. Plain-English keys from describe_dataset. Omit to return all measures. For long-format datasets (insurance), the single measure is 'value' and the semantic metric lives in the 'data_item' dimension filter. | |
| start_period | No | Inclusive start period. Format: 'YYYY-MM-DD' (e.g. '2024-01-01'), 'YYYY-Qx' (e.g. '2024-Q1'), or 'YYYY'. Matched against the dataset's period_column (quarter-end date). | |
| end_period | No | Inclusive end period. Same format as start_period. | |
| format | No | Response shape. 'records' (default): flat list of observations. 'series': grouped by measure. 'csv': pandas CSV string in `csv` field. | records |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dataset_id | Yes | ||
| dataset_name | Yes | ||
| query | No | ||
| period | No | ||
| unit | No | ||
| row_count | No | ||
| records | No | ||
| csv | No | ||
| source | No | Australian Prudential Regulation Authority | |
| attribution | No | Source: Australian Prudential Regulation Authority. Licensed under Creative Commons Attribution 3.0 Australia (https://creativecommons.org/licenses/by/3.0/au/). | |
| retrieved_at | Yes | ||
| apra_url | Yes | ||
| download_url | No | ||
| framework | No | ||
| stale | No | ||
| stale_reason | No | ||
| server_version | No |