Get a figure
get_figureGets one Australian retirement figure by an id from search_figures. Returns the value recorded for a date (as_at, or today in Sydney), the date it applies from and what that date means, conditions, exceptions, the official source by name, the date last checked and a citation of the figure's Retirement Wealth page. Values set by law but not yet in force are listed under upcoming. No value is returned for a date before the earliest recorded value, after today, or from the start of a value set by law not yet confirmed in force.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>"
},
"name": "get_figure"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The figure id, such as concessional_cap. search_figures returns ids. | |
| as_at | No | A date, as YYYY-MM-DD. Leave it out for today's date in Sydney. | |
| include_history | No | Also return the earlier recorded values, newest first. Default false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| kind | Yes | ||
| note | Yes | ||
| page | Yes | The figure's Retirement Wealth page: its value, conditions, change history and a link to its official source. | |
| unit | Yes | ||
| as_at | Yes | The date the value was looked up for. | |
| label | Yes | ||
| notes | Yes | ||
| ratio | Yes | For rates, the same value as a plain ratio: 3.75 per cent is 0.0375. Otherwise null. | |
| scope | Yes | What this site does and does not provide. | |
| today | Yes | Today's date in Sydney when the request was answered. | |
| value | Yes | ||
| resets | Yes | ||
| source | Yes | The official source, by publisher and title. Its address is on the figure's Retirement Wealth page. | |
| status | Yes | in_force: the registry's current value. superseded: an earlier value. | |
| caveats | Yes | ||
| cite_as | Yes | A citation line: the value, its date, the official source by name, the date it was last checked and the figure's Retirement Wealth page. | |
| concept | Yes | ||
| history | No | Recorded values, newest first. | |
| category | Yes | ||
| citation | Yes | The figure's Retirement Wealth page, as an address and a title. | |
| recorded | Yes | True when a value is recorded for as_at. False when it is not: the value fields are then null and note says why. | |
| upcoming | Yes | Values set by law that are not the current value here: for a later date, or not yet confirmed in force. | |
| data_hash | Yes | ||
| former_id | Yes | Set when the id asked for is an earlier id of this figure. | |
| applies_by | Yes | ||
| conditions | Yes | ||
| derivation | Yes | The calculation that links this figure to the figures it is worked out from, or null. | |
| dimensions | Yes | ||
| exceptions | Yes | Exceptions. One marked modelled: false is not built into any calculation on this site. | |
| review_due | Yes | due: true when the figure's first scheduled review day after it was last checked (from) is on or before as_at, today in Sydney: the figure has not been checked against its source since that review. note says so in words when due is true. from is null for a figure with no fixed review days. | |
| value_notes | Yes | ||
| data_release | Yes | The number of the data release these values come from. | |
| effective_to | Yes | The last day the value applies: the day before the next recorded value starts. Null when no later value is recorded, or when the end is not recorded. | |
| history_note | No | ||
| review_dates | Yes | ||
| verification | Yes | How the value was verified and the date it was last checked against its source. | |
| display_value | Yes | ||
| history_total | No | ||
| category_label | Yes | ||
| effective_from | Yes | The date the value applies from. effective_from_basis says what the date means. | |
| earliest_recorded | Yes | The earliest date for which a value of this figure is held. | |
| history_truncated | No | True when history was cut short to keep the response small. | |
| effective_from_basis | Yes | value: the day this value started. provision: the day the current rule started; the number itself is older. as_at: a day the official source shows the value in force; the day it started is not recorded. |