Suburb - Risks

All risks — bundle

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

Price: 11¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

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, 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).

not sent · default false

Responses

Successful Response

application/json

SuburbRisksAllfields returned to you

bushfireobjectmay be null

One suburb-level risk record (bushfire or flood). `coverage_pct` is the share of the SAL covered by the modelled risk overlay. `risk_band` is a coarse low/moderate/high band — only populated for flood today; bushfire reports the raw percentage.

floodobjectmay be null

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

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/all' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "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": 7.2,
      "name": "Flood",
      "risk_band": "moderate",
      "value_unit": "% of suburb area"
    }
  }
}

Successful Response200

application/json