Microburbs
Suburb - Shapes

Noise-map regions

GET/v1/suburbs/{suburb_name}/shapes/noise-heatmap20¢ per call

Precomputed noise colour regions clipped to the suburb, plus cell-centre heat points.

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

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

Responses

Successful Response

application/json
SuburbNoiseHeatmapfields returned to you
area_namestringalways returned

Canonical ABS SAL name.

area_levelstringalways returned

Always 'suburb'.

countintegeralways returned

Number of colour-region features returned.

intensity_definitionstringalways returned

What the intensity numbers mean — a relative 0-1 noise score (composite road-traffic + noisy-POI proximity), not decibels.

geojsonobjectalways returned

GeoJSON FeatureCollection — precomputed noise colour regions clipped to the suburb polygon. Feature properties are render-ready styling: `color` (hex fill) and `fill_opacity`; the numeric intensity values live in `heat`.

heatarray of arrayalways returned

Cell-centre points inside the suburb as `[lat, lng, intensity]` triples, ready for heatmap-style rendering. `intensity` is the relative 0-1 noise score described by intensity_definition.

GET/v1/suburbs/{suburb_name}/shapes/noise-heatmap
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/shapes/noise-heatmap' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "count": 6,
    "geojson": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                [
                  151.66,
                  -32.99
                ],
                [
                  151.67,
                  -32.99
                ],
                [
                  151.67,
                  -33
                ],
                [
                  151.66,
                  -32.99
                ]
              ]
            ],
            "type": "Polygon"
          },
          "properties": {
            "color": "#990000",
            "fill_opacity": 0.7
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "heat": [
      [
        -32.9931,
        151.6688,
        0.8
      ]
    ],
    "intensity_definition": "Relative noise intensity, 0-1 (scaled composite of road-traffic and noisy-POI proximity; 1 = noisiest cell in the source grid). Not a decibel measurement."
  }
}
Successful Response200
application/json