Suburb boundary polygon
/v1/suburbs/{suburb_name}/shapes/boundary10¢ per callSimplified SAL boundary polygon (GeoJSON Feature) plus centroid.
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
geojsonbooleanoptionalWhen false, geometry is dropped — every Feature keeps its `properties` but its `geometry` is null. Use it to fetch the counts and per-feature attributes without the coordinates (default true — response unchanged).
Responses
Successful Response
area_namestringalways returnedCanonical ABS SAL name.
area_levelstringalways returnedAlways 'suburb'.
centroidobjectalways returnedSuburb centroid — WGS84 lat/lng.
geojsonobjectalways returnedGeoJSON Feature — the SAL boundary polygon, simplified (topology-preserving, ~10 m tolerance, 6 dp coordinates). Geometry is null on every Feature when the request passes `?geojson=false`.
/v1/suburbs/{suburb_name}/shapes/boundarycurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/shapes/boundary' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"centroid": {
"lat": -32.9931,
"lng": 151.6688
},
"geojson": {
"geometry": {
"coordinates": [
[
[
151.66,
-32.99
],
[
151.67,
-32.99
],
[
151.67,
-33
],
[
151.66,
-32.99
]
]
],
"type": "Polygon"
},
"properties": {
"suburb": "Belmont North"
},
"type": "Feature"
}
}
}