Examples

Discovery

For examples that start with a natural-language user prompt and show the likely AI-agent tool sequence, see Prompting AI Agents.

Search for datasets related to the cash rate:

search_datasets(query="cash rate")

Discover semantic concepts related to inflation:

list_economic_concepts(query="inflation")

Browse active RBA inflation tables:

list_catalogue(source="rba", category="inflation")

ABS retrieval

Inspect the ABS CPI data structure:

get_abs_dataset_structure(dataflow_id="CPI")

Fetch a filtered ABS CPI response:

get_abs_data(
  dataflow_id="CPI",
  key="all",
  start_period="2024-Q1",
  end_period="2024-Q4",
  last_n=4
)

RBA retrieval

Fetch the latest observations from RBA table g1:

get_latest_observations(
  source="rba",
  identifier="g1",
  count=8
)

Fetch the highest numeric observations in an RBA table:

get_top_observations(
  source="rba",
  identifier="g1",
  n=5,
  direction="highest"
)

Fetch an event-style policy table:

get_rba_table(
  table_id="a2",
  last_n=8
)

APRA retrieval

Fetch a bounded APRA table directly:

get_apra_data(
  publication_id="ADI_QUARTERLY_PERFORMANCE",
  table_id="key_stats",
  last_n=4
)

Describe an APRA publication before retrieving it:

describe_dataset(
  source="apra",
  identifier="ADI_QUARTERLY_PERFORMANCE",
  table_id="key_stats"
)

Semantic retrieval

Resolve the cash rate target:

get_economic_series(
  concept="cash_rate_target",
  start="2020-01-01"
)

Resolve trimmed mean inflation:

get_economic_series(
  concept="trimmed_mean_inflation",
  start="2020-01-01"
)

Resolve quarterly real GDP growth:

get_economic_series(
  concept="gdp_growth",
  start="2020-01-01"
)

Resolve an APRA-backed ADI capital ratio:

get_economic_series(
  concept="adi_capital_ratio",
  last_n=4
)

Derived retrieval

Fetch transparent formula-based indicators:

get_derived_series(
  concept="real_cash_rate",
  last_n=12
)

get_derived_series(
  concept="yield_curve_slope",
  start="2024-01-01",
  last_n=5
)

get_derived_series(
  concept="credit_to_gdp",
  start="2020-Q1"
)

Release awareness

Find upcoming release or release-pulse rows:

list_release_events(
  source="rba",
  query="balance sheet",
  limit=5
)