suburbs_risks_flood
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| geojson | No | When true, add a `geojson` FeatureCollection of the flood polygons clipped to the suburb boundary (default false — response unchanged). | |
| suburb_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The endpoint's payload, or `null` when Microburbs has no value. | |
| reason | No | Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success. | |
| message | No | Human-readable explanation. Omitted on success. | |
| available | No | `false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator. |