Livability scores + regional benchmark
/v1/suburbs/{suburb_name}/lifestyle/livability10¢ per callLivability scores (0–100) per dimension, aggregated from mesh-block scores, with the SA4 benchmark.
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.
n_mesh_blocksintegeralways returnedMesh blocks the scores aggregate over.
scoresarray of LivabilityScorealways returnedOne entry per dimension.
benchmarkobjectmay be nullSA4-region benchmark for comparing the suburb's scores.
/v1/suburbs/{suburb_name}/lifestyle/livabilitycurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/livability' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"benchmark": {
"n_suburbs": 149,
"region": "Newcastle and Lake Macquarie",
"scores": {
"affluence": 66.9,
"hip": 59.5,
"lifestyle": 73.4,
"safety": 84.8
}
},
"n_mesh_blocks": 63,
"scores": [
{
"key": "affluence",
"label": "Affluence",
"level": "Moderate",
"value": 56
},
{
"key": "lifestyle",
"label": "Lifestyle",
"level": "Moderate",
"value": 72
},
{
"key": "safety",
"label": "Safety",
"level": "High",
"value": 76
}
]
}
}