Suburb - Risks

Hazard item counts

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

Counts of contamination points, heritage items and erosion-prone polygons inside the suburb.

Price: 5¢ 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

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json

RiskCountsfields returned to you

area_namestringalways returned

Canonical ABS SAL suburb name.

area_levelstringalways returned

Always 'suburb'.

contamination_points_nintegeralways returned

Contamination-register points inside the suburb.

heritage_items_nintegeralways returned

Heritage items inside the suburb.

erosion_nintegeralways returned

Coastal-erosion-prone polygons intersecting the suburb.

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

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_name": "Belmont North",
    "area_level": "suburb",
    "contamination_points_n": 3,
    "heritage_items_n": 0,
    "erosion_n": 0
  }
}

Successful Response200

application/json