Suburb - Risks

Bushfire + flood — bundle

Natural-hazard exposure for the suburb: how much of its area sits inside a designated bushfire-prone area and inside a modelled flood overlay, each with a plain risk band and the number of distinct hazard polygons.

Pass geojson=true to get the hazard shapes themselves, clipped to the suburb boundary, in the same call. Slope, heritage, power lines and the per-property hazard counts are separate calls.

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: 11¢ per call.

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/risks/all
  • 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, each sub-risk additionally carries a geojson FeatureCollection clipped to the suburb boundary — one call returns coverage plus every risk shape (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": {
    "bushfire": {
      "area_level": "suburb",
      "area_name": "Belmont North",
      "coverage_pct": 45.72,
      "name": "Bushfire",
      "value_unit": "% of suburb area"
    },
    "flood": {
      "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.