Retirement Wealth Data

Start here, before get_figure, to find selected figures in Australian retirement rules: rates, amounts, caps, thresholds, ages, periods and dates for the Age Pension and its means tests, superannuation and the Division 293 and 296 taxes, deeming, the Commonwealth Seniors Health Card, aged care and the Home Equity Access Scheme. Searches by keyword, category or both, and returns each match's id and current value. Each current value has an official source, the date it applies from and the date it was last checked; get_figure returns them.

{
  "type": "object",
  "properties": {
    "query": {
      "description": "Words to look for, such as \"concessional cap\" or \"deeming rate\". Up to 100 characters.",
      "type": "string",
      "maxLength": 100
    },
    "category": {
      "description": "A category id from list_categories, such as aged_care.",
      "type": "string",
      "enum": [
        "age_pension",
        "pension_income_test",
        "concession_cards",
        "deeming",
        "super",
        "super_caps",
        "super_access",
        "gov_contributions",
        "div293",
        "div296",
        "downsizer",
        "fhss",
        "aged_care",
        "home_equity"
      ]
    },
    "limit": {
      "default": 10,
      "description": "The most results to return. Default 10, maximum 50.",
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "What this site does and does not provide."
    },
    "data_release": {
      "type": "number",
      "description": "The number of the data release these values come from."
    },
    "data_hash": {
      "type": "string"
    },
    "query": {
      "type": [
        "string",
        "null"
      ]
    },
    "category": {
      "type": [
        "string",
        "null"
      ]
    },
    "total": {
      "type": "number",
      "description": "How many items matched."
    },
    "count": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean",
      "description": "True when there are more items than this result holds."
    },
    "note": {
      "type": [
        "string",
        "null"
      ]
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "display_value": {
            "type": "string"
          },
          "effective_from": {
            "description": "The date the value applies from. effective_from_basis says what the date means.",
            "type": [
              "string",
              "null"
            ]
          },
          "effective_from_basis": {
            "type": "string",
            "description": "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."
          },
          "category": {
            "type": "string"
          },
          "category_label": {
            "type": "string"
          },
          "page": {
            "type": "string"
          },
          "review_due": {
            "type": "boolean",
            "description": "True when a scheduled review day has come since the figure was last checked against its source. get_figure gives the day and a note."
          }
        },
        "required": [
          "id",
          "label",
          "display_value",
          "effective_from",
          "effective_from_basis",
          "category",
          "category_label",
          "page",
          "review_due"
        ],
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "scope",
    "data_release",
    "data_hash",
    "query",
    "category",
    "total",
    "count",
    "truncated",
    "note",
    "results"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}

Gets 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.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "The figure id, such as concessional_cap. search_figures returns ids."
    },
    "as_at": {
      "description": "A date, as YYYY-MM-DD. Leave it out for today's date in Sydney.",
      "type": "string"
    },
    "include_history": {
      "default": false,
      "description": "Also return the earlier recorded values, newest first. Default false.",
      "type": "boolean"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "What this site does and does not provide."
    },
    "data_release": {
      "type": "number",
      "description": "The number of the data release these values come from."
    },
    "data_hash": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "former_id": {
      "description": "Set when the id asked for is an earlier id of this figure.",
      "type": [
        "string",
        "null"
      ]
    },
    "label": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "category_label": {
      "type": "string"
    },
    "concept": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "dimensions": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "as_at": {
      "type": "string",
      "description": "The date the value was looked up for."
    },
    "today": {
      "type": "string",
      "description": "Today's date in Sydney when the request was answered."
    },
    "recorded": {
      "type": "boolean",
      "description": "True when a value is recorded for as_at. False when it is not: the value fields are then null and note says why."
    },
    "note": {
      "type": [
        "string",
        "null"
      ]
    },
    "value": {
      "type": [
        "number",
        "null"
      ]
    },
    "display_value": {
      "type": [
        "string",
        "null"
      ]
    },
    "unit": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "plain": {
          "type": "string"
        },
        "quantity": {
          "type": "string"
        },
        "currency": {
          "type": [
            "string",
            "null"
          ]
        },
        "per": {
          "type": [
            "string",
            "null"
          ]
        },
        "per_amount": {
          "type": [
            "number",
            "null"
          ]
        },
        "ratio_divisor": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "code",
        "plain",
        "quantity",
        "currency",
        "per",
        "per_amount",
        "ratio_divisor"
      ],
      "additionalProperties": {}
    },
    "ratio": {
      "description": "For rates, the same value as a plain ratio: 3.75 per cent is 0.0375. Otherwise null.",
      "type": [
        "number",
        "null"
      ]
    },
    "effective_from": {
      "description": "The date the value applies from. effective_from_basis says what the date means.",
      "type": [
        "string",
        "null"
      ]
    },
    "effective_from_basis": {
      "description": "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.",
      "type": [
        "string",
        "null"
      ]
    },
    "effective_to": {
      "description": "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.",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "description": "in_force: the registry's current value. superseded: an earlier value.",
      "type": [
        "string",
        "null"
      ]
    },
    "earliest_recorded": {
      "description": "The earliest date for which a value of this figure is held.",
      "type": [
        "string",
        "null"
      ]
    },
    "applies_by": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "selector": {
              "type": "string"
            },
            "text": {
              "type": "string"
            }
          },
          "required": [
            "selector",
            "text"
          ],
          "additionalProperties": {}
        },
        {
          "type": "null"
        }
      ]
    },
    "resets": {
      "type": "string"
    },
    "review_dates": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "review_due": {
      "type": "object",
      "properties": {
        "due": {
          "type": "boolean"
        },
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "as_at": {
          "type": "string"
        },
        "note": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "due",
        "from",
        "as_at",
        "note"
      ],
      "additionalProperties": {},
      "description": "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."
    },
    "upcoming": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number"
          },
          "display_value": {
            "type": "string"
          },
          "ratio": {
            "type": [
              "number",
              "null"
            ]
          },
          "effective_from": {
            "type": [
              "string",
              "null"
            ]
          },
          "effective_from_basis": {
            "type": "string"
          },
          "effective_to": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "source": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "verification": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "notes": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "value",
          "display_value",
          "ratio",
          "effective_from",
          "effective_from_basis",
          "effective_to",
          "status",
          "source",
          "verification",
          "notes"
        ],
        "additionalProperties": {}
      },
      "description": "Values set by law that are not the current value here: for a later date, or not yet confirmed in force."
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string"
          }
        },
        "required": [
          "text"
        ],
        "additionalProperties": {}
      }
    },
    "exceptions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string"
          },
          "modelled": {
            "type": "boolean"
          }
        },
        "required": [
          "text",
          "modelled"
        ],
        "additionalProperties": {}
      },
      "description": "Exceptions. One marked modelled: false is not built into any calculation on this site."
    },
    "caveats": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": {}
      }
    },
    "notes": {
      "type": [
        "string",
        "null"
      ]
    },
    "value_notes": {
      "type": [
        "string",
        "null"
      ]
    },
    "derivation": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        {
          "type": "null"
        }
      ],
      "description": "The calculation that links this figure to the figures it is worked out from, or null."
    },
    "source": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "publisher": {
              "type": "string"
            },
            "type": {
              "type": "string"
            }
          },
          "required": [
            "title",
            "publisher",
            "type"
          ],
          "additionalProperties": {}
        },
        {
          "type": "null"
        }
      ],
      "description": "The official source, by publisher and title. Its address is on the figure's Retirement Wealth page."
    },
    "verification": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string"
            },
            "checked_on": {
              "type": "string"
            }
          },
          "required": [
            "status",
            "checked_on"
          ],
          "additionalProperties": {}
        },
        {
          "type": "null"
        }
      ],
      "description": "How the value was verified and the date it was last checked against its source."
    },
    "page": {
      "type": "string",
      "description": "The figure's Retirement Wealth page: its value, conditions, change history and a link to its official source."
    },
    "citation": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "url",
        "title"
      ],
      "additionalProperties": {},
      "description": "The figure's Retirement Wealth page, as an address and a title."
    },
    "cite_as": {
      "description": "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.",
      "type": [
        "string",
        "null"
      ]
    },
    "history": {
      "description": "Recorded values, newest first.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number"
          },
          "display_value": {
            "type": "string"
          },
          "ratio": {
            "type": [
              "number",
              "null"
            ]
          },
          "effective_from": {
            "type": [
              "string",
              "null"
            ]
          },
          "effective_from_basis": {
            "type": "string"
          },
          "effective_to": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "source": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "verification": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "notes": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "value",
          "display_value",
          "ratio",
          "effective_from",
          "effective_from_basis",
          "effective_to",
          "status",
          "source",
          "verification",
          "notes"
        ],
        "additionalProperties": {}
      }
    },
    "history_total": {
      "type": "number"
    },
    "history_truncated": {
      "description": "True when history was cut short to keep the response small.",
      "type": "boolean"
    },
    "history_note": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "scope",
    "data_release",
    "data_hash",
    "id",
    "former_id",
    "label",
    "category",
    "category_label",
    "concept",
    "kind",
    "dimensions",
    "as_at",
    "today",
    "recorded",
    "note",
    "value",
    "display_value",
    "unit",
    "ratio",
    "effective_from",
    "effective_from_basis",
    "effective_to",
    "status",
    "earliest_recorded",
    "applies_by",
    "resets",
    "review_dates",
    "review_due",
    "upcoming",
    "conditions",
    "exceptions",
    "caveats",
    "notes",
    "value_notes",
    "derivation",
    "source",
    "verification",
    "page",
    "citation",
    "cite_as"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}

Lists what this site has changed in its published Australian retirement figures since a date, such as new or corrected values, earlier values added and figures added or renamed. Newest first. since filters on recorded_on, the date this site recorded the change, in Sydney. effective_from is the date the changed value applies from, where the change has one. A value can be recorded long after it began to apply.

{
  "type": "object",
  "properties": {
    "since": {
      "type": "string",
      "description": "Return changes recorded on or after this date, as YYYY-MM-DD. This is the date the change was recorded, not the date a value applies from."
    },
    "figure_id": {
      "description": "Only changes to this figure.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "types": {
      "description": "Only these kinds of change.",
      "maxItems": 13,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "figure_added",
          "figure_renamed",
          "figure_removed",
          "value_changed",
          "correction",
          "history_added",
          "future_value_added",
          "future_value_changed",
          "future_value_removed",
          "source_changed",
          "verification_changed",
          "rechecked",
          "details_changed"
        ]
      }
    },
    "limit": {
      "default": 25,
      "description": "The most changes to return. Default 25, maximum 100.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "since"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "What this site does and does not provide."
    },
    "data_release": {
      "type": "number",
      "description": "The number of the data release these values come from."
    },
    "data_hash": {
      "type": "string"
    },
    "since": {
      "type": "string"
    },
    "figure_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "types": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "total": {
      "type": "number",
      "description": "How many items matched."
    },
    "count": {
      "type": "number"
    },
    "truncated": {
      "type": "boolean",
      "description": "True when there are more items than this result holds."
    },
    "note": {
      "type": [
        "string",
        "null"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "release": {
            "type": "number"
          },
          "recorded_on": {
            "type": "string",
            "description": "The date this site recorded the change, in Sydney."
          },
          "recorded_at": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "figure_id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "effective_from": {
            "description": "The date the value applies from, where the change has one.",
            "type": [
              "string",
              "null"
            ]
          },
          "from": {
            "type": [
              "number",
              "string",
              "null"
            ]
          },
          "to": {
            "type": [
              "number",
              "string",
              "null"
            ]
          },
          "display_from": {
            "type": [
              "string",
              "null"
            ]
          },
          "display_to": {
            "type": [
              "string",
              "null"
            ]
          },
          "field": {
            "type": [
              "string",
              "null"
            ]
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "preview": {
            "type": "boolean",
            "description": "True only on a test build, for a change that is not yet published."
          }
        },
        "required": [
          "id",
          "release",
          "recorded_on",
          "recorded_at",
          "type",
          "figure_id",
          "label",
          "effective_from",
          "from",
          "to",
          "display_from",
          "display_to",
          "field",
          "fields",
          "preview"
        ],
        "additionalProperties": {}
      }
    },
    "changes": {
      "type": "string"
    }
  },
  "required": [
    "scope",
    "data_release",
    "data_hash",
    "since",
    "figure_id",
    "types",
    "total",
    "count",
    "truncated",
    "note",
    "events",
    "changes"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}

Shows which areas of Australian retirement rules the figures cover: the categories, such as Age Pension, super caps and aged care, with each one's id for search_figures and its number of figures. Also returns the data release, the newest and the oldest date on which a figure was last checked against its source, the scope statement, and links to the documentation and the JSON files.

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "What this site does and does not provide."
    },
    "data_release": {
      "type": "number",
      "description": "The number of the data release these values come from."
    },
    "data_hash": {
      "type": "string"
    },
    "data_updated": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_verified": {
      "type": "string",
      "description": "The newest date on which a figure was last checked against its source."
    },
    "oldest_verified": {
      "type": "string",
      "description": "The oldest such date."
    },
    "figure_count": {
      "type": "number"
    },
    "count": {
      "type": "number"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "count": {
            "type": "number"
          },
          "page": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "label",
          "description",
          "count",
          "page"
        ],
        "additionalProperties": {}
      }
    },
    "links": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "scope",
    "data_release",
    "data_hash",
    "data_updated",
    "last_verified",
    "oldest_verified",
    "figure_count",
    "count",
    "categories",
    "links"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": {}
}