get_data
Retrieve time series observations from any Reserve Bank of Australia F-table. Specify the table ID and optionally series, date range, and output format.
Instructions
Query an RBA F-table and return observations.
Curated tables accept plain-English series keys that map to canonical
RBA series IDs server-side. Omit `series` to get the table's headline
series (e.g. F1.1 → cash rate target, F11/F11.1 → AUD/USD, F6 → owner-
occupier outstanding variable rate). Pass an explicit list for a multi-
series query.
Examples:
# Cash rate target since 2020 (portfolio-standard name)
resp = await get_data("F1.1", series="cash_rate_target", start_period="2020")
# → resp.records[0]: period='2020-01-01', value=0.25, series='cash_rate_target'
# Headline default — no series arg returns the table's canonical series
resp = await get_data("F11.1", start_period="2024-01-01", end_period="2024-12-31")
# → resp.records: AUD/USD daily (the headline) for the period
# Multiple FX rates — pass an explicit list
resp = await get_data(
"F11.1",
series=["aud_usd", "aud_eur", "aud_jpy"],
start_period="2024-01-01",
end_period="2024-12-31",
)
# Mortgage rates as CSV
resp = await get_data("F6", format="csv", start_period="2023")
# → resp.csv = "date,series,value2023-01-01,..."
# Raw (non-curated) F-table — pass raw RBA series IDs
resp = await get_data("F1", series=["FIRMMCRTD", "FIRMMBAB30"])
# Legacy alias still works (start_date / end_date)
resp = await get_data("F11", series="aud_usd", start_date="2024")
Parameter notes:
- Prefer `start_period` / `end_period` (portfolio-standard names; 7
of 9 sister MCPs use them).
- `start_date` / `end_date` are retained as legacy aliases.
Supplying both `start_period` and `start_date` (or `end_period`
and `end_date`) raises ValueError — pick one per pair.
When to use:
- You want a time series of an RBA indicator (use latest() for current-only)
- You want a multi-series comparison (e.g. all FX rates)
- You want CSV for downstream charting
Returns:
DataResponse with records, unit, period bounds, RBA source URL,
and CC-BY 4.0 attribution.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Response shape. 'records' (default): flat list of observations. 'series': observations grouped by series_id. 'csv': returns the table as a CSV string in the `csv` field. | records |
| series | No | Which series to return. For curated tables: plain-English keys (e.g. 'aud_usd', 'cash_rate_target') or a list for multi-series. For raw F-tables: raw RBA series IDs (e.g. 'FXRUSD'). Pass None (default) to use the table's headline series — e.g. F1.1 defaults to the cash rate target, F11/F11.1 to AUD/USD, F6 to the owner-occupier outstanding variable rate. Pass an explicit list to fetch multiple series. | |
| end_date | No | Legacy alias for `end_period` — retained for backward compatibility. Prefer `end_period` for cross-sister consistency. Supplying both raises ValueError. | |
| table_id | Yes | RBA F-table ID like 'F1.1', 'F11'. Use search_tables() to discover. | |
| end_period | No | Inclusive end period (portfolio-standard name). Same format as start_period. Mutually exclusive with the legacy `end_date` alias. | |
| start_date | No | Legacy alias for `start_period` — retained for backward compatibility (rba-mcp <= 0.2.x). Prefer `start_period` for cross-sister consistency. Same format and semantics as `start_period`. Supplying both raises ValueError. | |
| start_period | No | Inclusive start period (portfolio-standard name). Accepts 'YYYY', 'YYYY-MM', or 'YYYY-MM-DD'. An int year (e.g. 2024) is also accepted and treated as 'YYYY'. Semantic-checked: '2024-13' or '----' rejected at the boundary. Mutually exclusive with the legacy `start_date` alias. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | ||
| unit | No | ||
| query | No | ||
| stale | No | ||
| period | No | ||
| source | No | Reserve Bank of Australia | |
| rba_url | Yes | Click-through URL for this table's source page. rba-mcp legacy name — prefer source_url (canonical) for new code. Both fields are populated identically. | |
| records | No | ||
| table_id | Yes | ||
| row_count | No | Number of observation rows in records. | |
| source_url | Yes | Canonical click-through URL. Same value as rba_url; both populated for backward compat. | |
| table_name | Yes | ||
| attribution | No | Data sourced from the Reserve Bank of Australia and licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). https://www.rba.gov.au/copyright/ | |
| retrieved_at | Yes | ||
| stale_reason | No | ||
| truncated_at | No | ||
| server_version | No |