Hazard item counts
/v1/suburbs/{suburb_name}/risks/counts5¢ per callCounts of contamination points, heritage items and erosion-prone polygons inside the suburb.
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: 5¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
suburb_namestringrequiredExact 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
Responses
Successful Response
area_namestringalways returnedCanonical ABS SAL suburb name.
area_levelstringalways returnedAlways 'suburb'.
contamination_points_nintegeralways returnedContamination-register points inside the suburb.
heritage_items_nintegeralways returnedHeritage items inside the suburb.
erosion_nintegeralways returnedCoastal-erosion-prone polygons intersecting the suburb.
/v1/suburbs/{suburb_name}/risks/countscurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/counts' \
--header 'Authorization: Bearer test'{
"data": {
"area_name": "Belmont North",
"area_level": "suburb",
"contamination_points_n": 3,
"heritage_items_n": 0,
"erosion_n": 0
}
}