Property - Risks

Flood overlay

Modelled flood overlays within 1 km. Read on_property — a returned row means "found nearby", not "this property floods".

Price: 10¢ per call.

get/v1/properties/{gnaf_id}/risks/flood

Request

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

Path parameters

gnaf_idstring required
Example:GANSW704074813

Query parameters

geojsonboolean

When true, add a geojson FeatureCollection of the hazard polygons clipped to a 1km-radius circle around the property, plus geojson_meta (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": "Layer",
      "area_name": "Risk Layer",
      "features_within_radius": 25,
      "name": "Fire",
      "nearest_distance_m": 0,
      "on_property": true,
      "search_radius_m": 1000,
      "value": "On property"
    }
  ]
}

Changes

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