Flood area coverage + optional polygon map
/v1/suburbs/{suburb_name}/risks/flood6¢ per callShare of the suburb AREA covered by modelled flood overlays.
Area, not properties. For the share of DWELLINGS affected — the figure our
own reports headline — use
GET /v1/suburbs/{suburb_name}/risks/property-hazard-counts.
To answer where the flood zone is, pass geojson=true. The response
then includes the actual modelled flood polygons clipped to the suburb
boundary, suitable for a street map, plus truncation/simplification
metadata. Do not infer street location from coverage_pct alone.
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: 6¢ 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 true, add a `geojson` FeatureCollection of the flood polygons clipped to the suburb boundary (default false — response unchanged).
Responses
Successful Response
area_namestringalways returnedSuburb (SAL) name.
area_levelstringalways returnedAlways 'suburb'.
namestringalways returnedRisk overlay name — 'Bushfire' or 'Flood'.
coverage_pctnumberalways returnedShare of suburb area inside the overlay (%).
value_unitstringalways returnedUnit for coverage_pct — '% of suburb area'.
risk_bandstringmay be nullCoarse band — 'low' / 'moderate' / 'high'. Currently flood only.
geojsonobjectmay be nullGeoJSON FeatureCollection of the hazard polygons for this layer, ST_Intersection-clipped to the suburb boundary and simplified for browser use. Present only when the request passes `?geojson=true`; absent (and the response byte-identical to before) otherwise.
geojson_metaobjectmay be nullClip / simplify / truncation metadata for `geojson` (clip method, simplify tolerance, coordinate precision, feature cap, and whether the size cap truncated the output). Present only with `?geojson=true`.
/v1/suburbs/{suburb_name}/risks/floodcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/flood' \
--header 'Authorization: Bearer test'{
"data": {
"area_name": "Belmont North",
"area_level": "suburb",
"name": "Flood",
"coverage_pct": 7.2,
"value_unit": "% of suburb area",
"risk_band": "moderate"
}
}