Microburbs
Microburbs API
Open in the full API reference →
Suburb - Shapes

Hazard-overlay polygons by layer

GET/v1/suburbs/{suburb_name}/shapes/hazards20¢ per call

Hazard polygons for one layer, clipped to the suburb boundary (empty collection = hazard not present).

Price: 20¢ per call.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

Query parameters

layerstringrequired

Hazard layer to return.

Responses

Successful Response

application/json
SuburbHazardsfields returned to you
area_namestringalways returned

Canonical ABS SAL name.

area_levelstringalways returned

Always 'suburb'.

layerstringalways returned

The hazard layer requested.

countintegeralways returned

Number of hazard polygons returned (0 = none of this hazard here).

geojsonobjectalways returned

GeoJSON FeatureCollection — hazard polygons clipped to the suburb boundary. Feature properties: `category` + `name` (per hazard layer), `tier` (acid-sulfate), none (landslide).

GET/v1/suburbs/{suburb_name}/shapes/hazards
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/shapes/hazards?layer=bushfire' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "count": 36,
    "geojson": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                [
                  151.66,
                  -32.99
                ],
                [
                  151.67,
                  -32.99
                ],
                [
                  151.67,
                  -33
                ],
                [
                  151.66,
                  -32.99
                ]
              ]
            ],
            "type": "Polygon"
          },
          "properties": {
            "category": "High Potential Bushfire Intensity"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "layer": "bushfire"
  }
}
Successful Response200
application/json