Suburb at a glance
/v1/suburbs/{suburb_name}/hero/summary5¢ per callState, SA3/SA4, postcode, population, dwellings and centroid for the suburb.
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.
statestringmay be nullState / territory full name, e.g. 'New South Wales'.
state_abbrstringmay be nullState / territory abbreviation, e.g. 'NSW'.
sa3stringmay be nullABS SA3 region the suburb sits in.
sa4stringmay be nullABS SA4 region the suburb sits in.
postcodestringmay be nullPostcode (POA) covering the suburb.
populationintegermay be nullTotal population (sum over the suburb's mesh blocks, ABS Census).
dwellingsintegermay be nullTotal dwellings (sum over the suburb's mesh blocks, ABS Census).
latnumbermay be nullLatitude of the suburb boundary's centroid.
lngnumbermay be nullLongitude of the suburb boundary's centroid.
/v1/suburbs/{suburb_name}/hero/summarycurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/hero/summary' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"dwellings": 2453,
"lat": -33.01705,
"lng": 151.672252,
"population": 6280,
"postcode": "2280",
"sa3": "Lake Macquarie - East",
"sa4": "Newcastle and Lake Macquarie",
"state": "New South Wales",
"state_abbr": "NSW"
}
}