Microburbs
Microburbs API
Open in the full API reference →
Suburb - Risks

Flood coverage

GET/v1/suburbs/{suburb_name}/risks/flood6¢ per call

Share of the suburb area covered by modelled flood overlays.

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_namestringrequired

Query parameters

geojsonbooleanoptional

When true, add a `geojson` FeatureCollection of the flood polygons clipped to the suburb boundary (default false — response unchanged).

not sent · default false

Responses

Successful Response

application/json
SuburbRiskfields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb'.

namestringalways returned

Risk overlay name — 'Bushfire' or 'Flood'.

coverage_pctnumberalways returned

Share of suburb area inside the overlay (%).

value_unitstringalways returned

Unit for coverage_pct — '% of suburb area'.

risk_bandstringmay be null

Coarse band — 'low' / 'moderate' / 'high'. Currently flood only.

geojsonobjectmay be null

GeoJSON 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 null

Clip / 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`.

GET/v1/suburbs/{suburb_name}/risks/flood
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/flood' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_name": "Belmont North",
    "area_level": "suburb",
    "name": "Flood",
    "coverage_pct": 7.2,
    "value_unit": "% of suburb area",
    "risk_band": "moderate"
  }
}
Successful Response200
application/json