ABS geo profile
/v1/suburbs/{suburb_name}/profile3¢ per callThe suburb's upward ABS admin chain — LGA, SA2/3/4, GCCSA,
state, postcode. Use /v1/suburbs/list to discover canonical
SAL names (and filter by state / LGA / SA4 / postcode).
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
suburbstringalways returnedSuburb (SAL — ABS Suburb and Locality).
lgastringmay be nullLocal Government Area.
sa2stringmay be nullSA2 name.
sa3stringmay be nullSA3 name.
sa4stringmay be nullSA4 name.
gccsastringmay be nullGreater Capital City Statistical Area.
statestringmay be nullState / Territory.
postcodestringmay be nullPostcode (POA).
/v1/suburbs/{suburb_name}/profilecurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/profile' \
--header 'Authorization: Bearer test'{
"data": {
"gccsa": "Rest of NSW",
"lga": "Lake Macquarie",
"postcode": "2280",
"sa2": "Belmont - Bennetts Green",
"sa3": "Lake Macquarie - East",
"sa4": "Newcastle and Lake Macquarie",
"state": "New South Wales",
"suburb": "Belmont North"
}
}