Distance to the nearest city and to the nearest capital
/v1/suburbs/{suburb_name}/lifestyle/cbd3¢ per callStraight-line distance to the nearest city and to the nearest capital, in km.
Both, because they answer different questions and are often nowhere near
each other: Belmont North is 14 km from Newcastle and 108 km from Sydney.
nearest_city is usually what a buyer means by "how far is town".
The top-level city / distance_km fields are DEPRECATED. They still
describe the CAPITAL, unchanged, so existing callers are unaffected —
read capital_city or nearest_city instead.
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: 3¢ 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.
nearest_cityobjectmay be nullA named city and the straight-line distance to it.
capital_cityobjectmay be nullA named city and the straight-line distance to it.
citystringmay be nullDEPRECATED — the CAPITAL's name. Use `capital_city.name`.
distance_kmnumberalways returnedDEPRECATED — distance to the CAPITAL, not to the nearest city. Use `capital_city.distance_km`, or `nearest_city.distance_km`.
/v1/suburbs/{suburb_name}/lifestyle/cbdcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/cbd' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"capital_city": {
"distance_km": 108,
"name": "Sydney"
},
"city": "Sydney",
"distance_km": 108,
"nearest_city": {
"distance_km": 14,
"name": "Newcastle"
}
}
}