Servers Playground How we check Add a server Log in

Australian Economic Data (ABS, RBA & APRA)

Working · 779 ms

io.github.AnthonyPuggs/ausecon-mcp-serverv1.14.5

Australian economic data from the ABS, RBA, and APRA: CPI, GDP, cash rate, labour, and more.

Finance & Payments

Source Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.auseconmcp.com/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

describe_dataset Read-only

Describe a source-native ABS, RBA, or APRA dataset without hiding native IDs.

sourcestring, required

Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.

identifierstring, required

Non-empty dataset or table id.

table_idstring

Non-empty dataset or table id.

include_structureboolean

Whether ABS descriptions should include source-native structure details.

Australian Economic Data (ABS, RBA & APRA) MCP server | mcptry

Tools (14)

describe_dataset

Describe a source-native ABS, RBA, or APRA dataset without hiding native IDs.

read-only

Argument	Type	Description
source*	string	Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
table_id	any	Non-empty dataset or table id.
identifier*	string	Non-empty dataset or table id.
include_structure	boolean	Whether ABS descriptions should include source-native structure details.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source",
    "identifier"
  ],
  "properties": {
    "source": {
      "enum": [
        "abs",
        "rba",
        "apra"
      ],
      "type": "string",
      "description": "Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "table_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "Non-empty dataset or table id."
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Non-empty dataset or table id."
    },
    "identifier": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "include_structure": {
      "type": "boolean",
      "default": false,
      "description": "Whether ABS descriptions should include source-native structure details."
    }
  },
  "additionalProperties": false
}

get_abs_data

Expert/source-native ABS SDMX retrieval in a normalised response shape.

read-only

Argument	Type	Description
key	string	ABS SDMX key, or "all" for all series.
last_n	any	Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped.
end_period	any	Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format.
dataflow_id*	string	Non-empty dataset or table id.
start_period	any	Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format.
updated_after	any	Optional ISO date or datetime accepted by the ABS updatedAfter API.
include_observation_dimensions	boolean	Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "dataflow_id"
  ],
  "properties": {
    "key": {
      "type": "string",
      "default": "all",
      "minLength": 1,
      "description": "ABS SDMX key, or \"all\" for all series."
    },
    "last_n": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped."
    },
    "end_period": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(\\d{4}|\\d{4}-Q[1-4]|\\d{4}-(0[1-9]|1[0-2])|\\d{4}-S[1-2])$"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format."
    },
    "dataflow_id": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "start_period": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(\\d{4}|\\d{4}-Q[1-4]|\\d{4}-(0[1-9]|1[0-2])|\\d{4}-S[1-2])$"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format."
    },
    "updated_after": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional ISO date or datetime accepted by the ABS updatedAfter API."
    },
    "include_observation_dimensions": {
      "type": "boolean",
      "default": false,
      "description": "Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id."
    }
  },
  "additionalProperties": false
}

get_abs_dataset_structure

Get ABS SDMX dataset dimensions and codelists.

read-only

Argument	Type	Description
dataflow_id*	string	Non-empty dataset or table id.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "dataflow_id"
  ],
  "properties": {
    "dataflow_id": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    }
  },
  "additionalProperties": false
}

get_apra_data

Expert/source-native APRA public XLSX publication retrieval. Only curated official APRA publication IDs are accepted; arbitrary URLs are not.

read-only

Argument	Type	Description
last_n	any	Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped.
end_date	any	Optional ISO date bound in YYYY-MM-DD format.
table_id	any	Non-empty dataset or table id.
series_ids	any	Optional list of non-empty source-native series IDs to keep after download.
start_date	any	Optional ISO date bound in YYYY-MM-DD format.
publication_id*	string	Non-empty dataset or table id.
include_observation_dimensions	boolean	Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id.

Input schema (JSON)

get_derived_series

Read-only retrieval for the narrow transparent derived series layer. Date bounds accept YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD and are normalised to the derived series frequency.

read-only

Argument	Type	Description
end	any	Optional analyst-friendly bound for a derived series: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Bounds are normalised to the derived series frequency.
start	any	Optional analyst-friendly bound for a derived series: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Bounds are normalised to the derived series frequency.
last_n	any	Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped.
concept*	string	Derived concept name.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "concept"
  ],
  "properties": {
    "end": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional analyst-friendly bound for a derived series: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Bounds are normalised to the derived series frequency."
    },
    "start": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional analyst-friendly bound for a derived series: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Bounds are normalised to the derived series frequency."
    },
    "last_n": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped."
    },
    "concept": {
      "type": "string",
      "minLength": 1,
      "description": "Derived concept name."
    }
  },
  "additionalProperties": false
}

get_economic_series

Preferred analyst-facing retrieval tool for curated ABS/RBA economic concepts. Use list_economic_concepts for discovery. Date bounds accept YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD and are normalised to the resolved source.

read-only

Argument	Type	Description
end	any	Optional analyst-friendly date bound: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Semantic retrieval normalises this to the resolved source frequency.
start	any	Optional analyst-friendly date bound: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Semantic retrieval normalises this to the resolved source frequency.
last_n	any	Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped.
concept*	string	Curated semantic concept name.
variant	any	Optional curated concept variant, such as headline, underlying, or target.
frequency	any	Optional requested frequency for a curated concept, such as monthly, quarterly, or annual.
geography	any	Optional geography selector for a curated concept, usually aus for Australia.

get_latest_observations

Source-aware convenience wrapper for the latest observations. For a single curated indicator prefer get_economic_series(concept=...), which resolves one series; pass series_ids=[...] to narrow a broad dataset instead of returning every series it contains.

read-only

Argument	Type	Description
key	string	ABS SDMX key, or "all" for all series.
count	integer	Number of most recent observations to return per series; metadata.truncated is true when older observations were dropped.
source*	string	Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
table_id	any	Non-empty dataset or table id.
identifier*	string	Non-empty dataset or table id.
series_ids	any	Optional list of non-empty source-native series IDs to keep after download.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source",
    "identifier"
  ],
  "properties": {
    "key": {
      "type": "string",
      "default": "all",
      "minLength": 1,
      "description": "ABS SDMX key, or \"all\" for all series."
    },
    "count": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Number of most recent observations to return per series; metadata.truncated is true when older observations were dropped."
    },
    "source": {
      "enum": [
        "abs",
        "rba",
        "apra"
      ],
      "type": "string",
      "description": "Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "table_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "Non-empty dataset or table id."
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Non-empty dataset or table id."
    },
    "identifier": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "series_ids": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional list of non-empty source-native series IDs to keep after download."
    }
  },
  "additionalProperties": false
}

get_rba_table

Expert/source-native RBA statistical table retrieval in a normalised response shape.

read-only

Argument	Type	Description
last_n	any	Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped.
end_date	any	Optional ISO date bound in YYYY-MM-DD format.
table_id*	string	Non-empty dataset or table id.
series_ids	any	Optional list of non-empty source-native series IDs to keep after download.
start_date	any	Optional ISO date bound in YYYY-MM-DD format.
include_observation_dimensions	boolean	Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "table_id"
  ],
  "properties": {
    "last_n": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped."
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "table_id": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "series_ids": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional list of non-empty source-native series IDs to keep after download."
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "include_observation_dimensions": {
      "type": "boolean",
      "default": false,
      "description": "Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id."
    }
  },
  "additionalProperties": false
}

get_top_observations

Source-aware convenience wrapper for highest or lowest numeric observations. For a single curated indicator prefer get_economic_series(concept=...), which resolves one series; pass series_ids=[...] to narrow a broad dataset instead of returning every series it contains.

read-only

Argument	Type	Description
n	integer	Positive observation count.
key	string	ABS SDMX key, or "all" for all series.
source*	string	Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
end_date	any	Optional ISO date bound in YYYY-MM-DD format.
table_id	any	Non-empty dataset or table id.
direction	string	Whether to return the highest or lowest numeric observations.
end_period	any	Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format.
identifier*	string

list_catalogue

List curated ABS, RBA, and APRA catalogue entries, optionally filtered by source, category, or tag. Unranked complement to ``search_datasets``.

read-only

Argument	Type	Description
tag	any	Optional curated catalogue tag filter.
source	any	Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
category	any	Optional curated catalogue or semantic concept category filter.
include_ceased	boolean	Whether to include ceased ABS catalogue entries.
include_discontinued	boolean	Whether to include discontinued RBA catalogue entries.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "tag": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional curated catalogue tag filter."
    },
    "source": {
      "anyOf": [
        {
          "enum": [
            "abs",
            "rba",
            "apra"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional curated catalogue or semantic concept category filter."
    },
    "include_ceased": {
      "type": "boolean",
      "default": false,
      "description": "Whether to include ceased ABS catalogue entries."
    },
    "include_discontinued": {
      "type": "boolean",
      "default": false,
      "description": "Whether to include discontinued RBA catalogue entries."
    }
  },
  "additionalProperties": false
}

list_economic_concepts

List analyst-friendly semantic economic concepts accepted by get_economic_series.

read-only

Argument	Type	Description
query	any	Optional query for filtering semantic economic concepts.
source	any	Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
category	any	Optional curated catalogue or semantic concept category filter.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional query for filtering semantic economic concepts."
    },
    "source": {
      "anyOf": [
        {
          "enum": [
            "abs",
            "rba",
            "apra"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional curated catalogue or semantic concept category filter."
    }
  },
  "additionalProperties": false
}

list_rba_tables

Deprecated compatibility alias. Prefer list_catalogue(source="rba").

read-only

Argument	Type	Description
category	any	Optional RBA catalogue category filter.
include_discontinued	boolean	Whether to include discontinued RBA catalogue entries.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "category": {
      "anyOf": [
        {
          "enum": [
            "exchange_rates",
            "external_sector",
            "household_finance",
            "inflation",
            "interest_rates",
            "monetary_policy",
            "money_credit",
            "output_labour",
            "payments"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional RBA catalogue category filter."
    },
    "include_discontinued": {
      "type": "boolean",
      "default": false,
      "description": "Whether to include discontinued RBA catalogue entries."
    }
  },
  "additionalProperties": false
}

list_release_events

List source-aware release calendar or release-pulse events.

read-only

Argument	Type	Description
limit	integer	Positive observation count.
query	any	Optional query for filtering semantic economic concepts.
source	any	Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.
end_date	any	Optional ISO date bound in YYYY-MM-DD format.
start_date	any	Optional ISO date bound in YYYY-MM-DD format.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "minimum": 1,
      "description": "Positive observation count."
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional query for filtering semantic economic concepts."
    },
    "source": {
      "anyOf": [
        {
          "enum": [
            "abs",
            "rba",
            "apra"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    }
  },
  "additionalProperties": false
}

search_datasets

Search curated ABS, RBA, and APRA economic datasets.

read-only

Argument	Type	Description
query*	string	Discovery query text.
source	any	Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Discovery query text."
    },
    "source": {
      "anyOf": [
        {
          "enum": [
            "abs",
            "rba",
            "apra"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional source filter. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "publication_id"
  ],
  "properties": {
    "last_n": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped."
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "table_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "Non-empty dataset or table id."
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Non-empty dataset or table id."
    },
    "series_ids": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional list of non-empty source-native series IDs to keep after download."
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "publication_id": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "include_observation_dimensions": {
      "type": "boolean",
      "default": false,
      "description": "Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "concept"
  ],
  "properties": {
    "end": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional analyst-friendly date bound: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Semantic retrieval normalises this to the resolved source frequency."
    },
    "start": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional analyst-friendly date bound: YYYY, YYYY-QN, YYYY-SN, YYYY-MM, or YYYY-MM-DD. Semantic retrieval normalises this to the resolved source frequency."
    },
    "last_n": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional limit returning only the most recent N observations per series; metadata.truncated is true when older observations were dropped."
    },
    "concept": {
      "type": "string",
      "minLength": 1,
      "description": "Curated semantic concept name."
    },
    "variant": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional curated concept variant, such as headline, underlying, or target."
    },
    "frequency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional requested frequency for a curated concept, such as monthly, quarterly, or annual."
    },
    "geography": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional geography selector for a curated concept, usually aus for Australia."
    },
    "include_observation_dimensions": {
      "type": "boolean",
      "default": false,
      "description": "Whether to repeat the full dimension dict on every observation. Off by default because the same dimensions already appear on each series descriptor and are encoded in series_id."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "source",
    "identifier"
  ],
  "properties": {
    "n": {
      "type": "integer",
      "default": 10,
      "minimum": 1,
      "description": "Positive observation count."
    },
    "key": {
      "type": "string",
      "default": "all",
      "minLength": 1,
      "description": "ABS SDMX key, or \"all\" for all series."
    },
    "source": {
      "enum": [
        "abs",
        "rba",
        "apra"
      ],
      "type": "string",
      "description": "Source selector. Use abs for Australian Bureau of Statistics, rba for Reserve Bank of Australia, or apra for Australian Prudential Regulation Authority."
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "table_id": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "description": "Non-empty dataset or table id."
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Non-empty dataset or table id."
    },
    "direction": {
      "enum": [
        "highest",
        "lowest"
      ],
      "type": "string",
      "default": "highest",
      "description": "Whether to return the highest or lowest numeric observations."
    },
    "end_period": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(\\d{4}|\\d{4}-Q[1-4]|\\d{4}-(0[1-9]|1[0-2])|\\d{4}-S[1-2])$"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format."
    },
    "identifier": {
      "type": "string",
      "minLength": 1,
      "description": "Non-empty dataset or table id."
    },
    "series_ids": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional list of non-empty source-native series IDs to keep after download."
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "format": "date",
      "default": null,
      "description": "Optional ISO date bound in YYYY-MM-DD format."
    },
    "start_period": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(\\d{4}|\\d{4}-Q[1-4]|\\d{4}-(0[1-9]|1[0-2])|\\d{4}-S[1-2])$"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional ABS period bound in YYYY, YYYY-QN, YYYY-MM, or YYYY-SN format."
    }
  },
  "additionalProperties": false
}