Suburb - Risks

Flood area coverage + optional polygon map

Share 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.

get/v1/suburbs/{suburb_name}/risks/flood

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/risks/flood
  • Auth: HTTP bearer

Path parameters

suburb_namestring required
Example:Belmont North

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.

Query parameters

geojsonboolean

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

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "coverage_pct": 45.72,
    "name": "Bushfire",
    "value_unit": "% of suburb area"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.