Livability narrative sentences
/v1/suburbs/{suburb_name}/lifestyle/narrative10¢ per callOne plain-English sentence per livability dimension for the suburb.
Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.
Price: 10¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
suburb_namestringrequiredExact ABS Suburb and Locality (SAL) name, e.g. `Burwood (NSW)` — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call `GET /v1/geocode/suburb?q=<text>`, then use the exact `data[].area_name` it returns. Suburb data endpoints do not guess a state or typo-correct names.
Query parameters
Responses
Successful Response
area_namestringalways returnedSuburb (SAL) name.
area_levelstringalways returnedAlways 'suburb' for these endpoints.
sentencesobjectalways returnedOne plain-English sentence per livability dimension. A dimension is omitted when no sentence exists for it. No ``safety`` key — the upstream crime sentence is SEIFA text, deliberately excluded.
/v1/suburbs/{suburb_name}/lifestyle/narrativecurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/narrative' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"sentences": {
"affluence": "37% own outright. Only 10% hold university degrees. Household income $1,728/wk.",
"convenience": "No train nearby (9 km). Nearest supermarket: Coles (851m). Hospital 2.9 km."
}
}
}