Hazard-overlay polygons by layer
/v1/suburbs/{suburb_name}/shapes/hazards20¢ per callHazard polygons for one layer, clipped to the suburb boundary (empty collection = hazard not present).
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: 20¢ 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
layerstringrequiredHazard layer to return.
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'.
layerstringalways returnedThe hazard layer requested.
countintegeralways returnedNumber of hazard polygons returned (0 = none of this hazard here).
geojsonobjectalways returnedGeoJSON FeatureCollection — hazard polygons clipped to the suburb boundary. Feature properties: `category` + `name` (per hazard layer), `tier` (acid-sulfate), none (landslide). Geometry is null on every Feature when the request passes `?geojson=false`.
/v1/suburbs/{suburb_name}/shapes/hazardscurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/shapes/hazards?layer=flood' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"count": 36,
"geojson": {
"features": [
{
"geometry": {
"coordinates": [
[
[
151.66,
-32.99
],
[
151.67,
-32.99
],
[
151.67,
-33
],
[
151.66,
-32.99
]
]
],
"type": "Polygon"
},
"properties": {
"category": "High Potential Bushfire Intensity"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"layer": "bushfire"
}
}