changedOutput schema / (root)
Previous value: -{
- "properties": {
- "available": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "`false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator.",
- "title": "Available"
- },
- "data": {
- "anyOf": [
- {
- "additionalProperties": true,
- "description": "Who owns and who rents across a suburb — one headline set of shares\nplus the microburb-by-microburb detail underneath.\n\nThe suburb figures are an **unweighted average across the suburb's\nmicroburbs**, so each microburb counts equally regardless of how many\ndwellings it holds. That is close to, but not identical with, a true\ndwelling-weighted suburb share; do not expect it to reconcile exactly\nwith published Census suburb tenure counts. Same 0–100 percent scale\nand same overlapping-categories caveat as `TenureMb`.",
- "example": {
- "census_year": 2021,
- "microburbs": [
- {
- "mb": "10664530000",
- "mortgaged_pct": 41,
- "owned_outright_pct": 38.2,
- "public_housing_pct": 0.9,
- "renting_pct": 17.3,
- "street": "Marquis St"
- }
- ],
- "mortgaged_pct": 40.1,
- "n_microburbs": 71,
- "owned_outright_pct": 34.7,
- "owner_occupied_pct": 74.8,
- "public_housing_pct": 1.8,
- "renting_pct": 20.9,
- "suburb": "Belmont North",
- "tier": "Mixed"
- },
- "properties": {
- "census_year": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Reference year of the underlying ABS Census tenure inputs (currently 2021). This is not a current-year occupancy survey.",
- "title": "Census Year"
- },
- "microburbs": {
- "description": "Tenure shares for each microburb in the suburb, showing how ownership varies street by street — often the more useful signal, since a single suburb average can hide an owner-occupied pocket next to a rental-heavy one.",
- "items": {
- "additionalProperties": true,
- "description": "How the households in one microburb hold their homes — owned, being\npaid off, or rented.\n\nAll four shares are **percentages 0–100** (not fractions) of the same\ndenominator: occupied private dwellings, including those whose tenure\nwas not stated. Two things follow, and both bite people who chart these\nnaively — see `public_housing_pct` and the note on summing below.\n\nThese come from a model, not a published count: Census tenure is\npublished for larger areas and statistically downscaled to microburb\nlevel, so read a single microburb as an estimate with real uncertainty.",
- "properties": {
- "mb": {
- "description": "ABS 2021 mesh-block code identifying this microburb, as a string of digits (keep it a string — leading digits are significant and it overflows a 32-bit int).",
- "title": "Mb",
- "type": "string"
- },
- "mortgaged_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of dwellings owner-occupied but still mortgaged, as a percent 0–100. Add it to `owned_outright_pct` for total owner-occupation.",
- "title": "Mortgaged Pct"
- },
- "owned_outright_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of dwellings owned outright with no mortgage, as a percent 0–100 (34.7 = 34.7%). Typically tracks an older, longer-settled population.",
- "title": "Owned Outright Pct"
- },
- "public_housing_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of dwellings rented from a state or territory housing authority, as a percent 0–100. A subset of `renting_pct`, not a fourth category — these dwellings are counted in both fields. Stacking all four in one chart double-counts; use owned-outright + mortgaged + renting for a breakdown (which still sums slightly under 100, the remainder being other and not-stated tenures) and show public housing separately.",
- "title": "Public Housing Pct"
- },
- "renting_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Share of dwellings rented, as a percent 0–100 — all renting, private landlords and public housing together. This is the figure the suburb-level `tier` is banded on.",
- "title": "Renting Pct"
- },
- "street": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The most common street name inside the microburb, title-cased — a human handle for an area that otherwise has only a numeric code. Not a boundary or a full address, and several microburbs in a suburb can share one.",
- "title": "Street"
- }
- },
- "required": [
- "mb"
- ],
- "title": "TenureMb",
- "type": "object"
- },
- "title": "Microburbs",
- "type": "array"
- },
- "mortgaged_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Suburb-wide share owner-occupied with a mortgage, percent 0–100.",
- "title": "Mortgaged Pct"
- },
- "n_microburbs": {
- "description": "How many microburbs are listed in `microburbs`. Not the number behind the suburb figures above: very small or sparsely-populated microburbs are filtered out of the list but still counted in the suburb averages, so re-averaging `microburbs` will not exactly reproduce them.",
- "title": "N Microburbs",
- "type": "integer"
- },
- "owned_outright_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Suburb-wide share of dwellings owned outright, percent 0–100.",
- "title": "Owned Outright Pct"
- },
- "owner_occupied_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Total suburb owner-occupation rate, percent 0–100: `owned_outright_pct + mortgaged_pct`. Null unless both components are available. This is a modelled, unweighted average across microburbs, not an exact dwelling-weighted ABS SAL count.",
- "title": "Owner Occupied Pct"
- },
- "public_housing_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Suburb-wide share rented from a state/territory housing authority, percent 0–100. Included within `renting_pct`, not additional to it.",
- "title": "Public Housing Pct"
- },
- "renting_pct": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Suburb-wide share of dwellings rented, percent 0–100 — private and public renting combined. Drives `tier`.",
- "title": "Renting Pct"
- },
- "suburb": {
- "description": "The suburb these figures describe, as the canonical ABS suburb (SAL) name — the resolved form of whatever was requested.",
- "title": "Suburb",
- "type": "string"
- },
- "tier": {
- "description": "One-word read on the suburb's ownership mix, banded on `renting_pct`: 'Owner-Occupier' under 7% renters, 'Mixed' under 20%, 'Investor-Heavy' at 20% or above ('Unknown' when there is no renting share). A convenience label — the underlying percentage is the precise figure.",
- "title": "Tier",
- "type": "string"
- }
- },
- "required": [
- "suburb",
- "tier",
- "n_microburbs",
- "microburbs"
- ],
- "title": "SuburbTenure",
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The endpoint's payload, or `null` when Microburbs has no value."
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Human-readable explanation. Omitted on success.",
- "title": "Message"
- },
- "reason": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success.",
- "title": "Reason"
- }
- },
- "title": "ApiResponse[SuburbTenure]",
- "type": "object",
- "x-fastmcp-top-level-schema": "ApiResponse_SuburbTenure_"
-}New value: +null