Neighbouring suburbs
/v1/suburbs/{suburb_name}/hero/neighbours5¢ per callNearest neighbouring suburbs with distance in km, closest first.
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: 5¢ 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.
neighboursarray of HeroNeighbourRowalways returnedNeighbouring suburbs ordered by distance (closest first).
/v1/suburbs/{suburb_name}/hero/neighbourscurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/hero/neighbours' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"neighbours": [
{
"dist_km": 1,
"sa3": "Lake Macquarie - East",
"sal": "Floraville"
},
{
"dist_km": 1.4,
"sa3": "Lake Macquarie - East",
"sal": "Belmont (NSW)"
}
]
}
}