Regional & neighbour cohort ranks
/v1/suburbs/{suburb_name}/demographics/cohorts10¢ per callHow the suburb ranks inside its SA4 region and against its touching neighbours on renter share, welfare dependency, overseas-born parents and public housing.
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
suburbstringalways returnedCanonical SAL name.
sa4objectmay be nullThe suburb's SA4 cohort.
n_neighboursintegeralways returnedTouching suburbs in the cohort.
metricsarray of CohortMetricalways returnedPer-metric comparisons.
/v1/suburbs/{suburb_name}/demographics/cohortscurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/demographics/cohorts' \
--header 'Authorization: Bearer test'{
"data": {
"metrics": [
{
"field": "mib_perc_renters",
"label": "Renter share",
"neighbours": {
"dramatic": {
"delta_pct": 258,
"suburb": "Windale",
"value_pct": 39.4
},
"highest_in_group": false,
"lowest_in_group": false,
"n": 7
},
"sa4": {
"delta_pct": 34,
"n": 135,
"percentile": 34,
"position": "bottom"
},
"value_pct": 11
}
],
"n_neighbours": 7,
"sa4": {
"cohort_size": 148,
"name": "Newcastle and Lake Macquarie"
},
"suburb": "Belmont North"
}
}