Livability scores per microburb
/v1/suburbs/{suburb_name}/lifestyle/livability-map20¢ per callAll seven livability dimensions — affluence, lifestyle, hip,
convenience, family, safety, tranquility — scored 0-100 for every
microburb (mesh block) in the suburb, each with its human band. Averaging
a dimension across the microburbs reproduces the suburb figure at
/lifestyle/livability. Values only; polygons come from
/shapes/mesh-blocks.
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: 20¢ 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
suburbstringalways returnedCanonical SAL name.
metricstringalways returnedAlways 'livability_scores'.
unitstringalways returnedAlways 'score_0_100'.
definitionstringalways returnedHow the scores are derived.
dimensionsarray of LivabilityDimensionalways returnedThe seven dimensions, with what each measures.
n_microburbsintegeralways returnedMicroburbs with at least one score.
microburbsarray of LivabilityMbalways returnedPer-microburb scores, ordered by mesh-block code.
/v1/suburbs/{suburb_name}/lifestyle/livability-mapcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/livability-map' \
--header 'Authorization: Bearer test'{
"data": {
"suburb": "Belmont North",
"metric": "livability_scores",
"unit": "score_0_100",
"definition": "Seven livability dimensions scored for each mesh block ('microburb', the smallest ABS geography, ~30-60 dwellings), rescaled from the source 0-10 to 0-100. Higher is better on every dimension, safety included — it is an inverse-scaled crime score built from the same per-mesh-block crime model /crime/by-mesh-block exposes as raw rates. Averaging a dimension across the microburbs here gives the suburb figure at /lifestyle/livability. Dimensions with no score for a microburb are omitted, not zeroed.",
"dimensions": [
{
"key": "safety",
"label": "Safety",
"description": "Reported crime rates across personal, property, drug and public-order offences compared with the state average. Inverse-scaled, so a higher score means less predicted crime."
}
],
"n_microburbs": 63,
"microburbs": [
{
"mb": "10431160000",
"street": "Floraville",
"scores": {
"affluence": 43,
"lifestyle": 34,
"hip": 50,
"convenience": 46,
"family": 52,
"safety": 53,
"tranquility": 8
},
"levels": {
"affluence": "Low",
"lifestyle": "Low",
"hip": "Moderate",
"convenience": "Low",
"family": "Moderate",
"safety": "Moderate",
"tranquility": "Very low"
}
}
]
}
}