Suburb - Shapes

Busy-road segments

GET/v1/suburbs/{suburb_name}/shapes/busy-roads10¢ per call

Busy-road line segments clipped to the suburb — the report's road-noise exposure proxy.

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

SuburbBusyRoadsfields returned to you

area_namestringalways returned

Canonical ABS SAL name.

area_levelstringalways returned

Always 'suburb'.

countintegeralways returned

Number of road-segment features returned.

geojsonobjectalways returned

GeoJSON FeatureCollection — line geometries of busy road segments clipped to the suburb boundary. Properties: `road_class` (OSM fclass, e.g. motorway/primary/secondary).

GET/v1/suburbs/{suburb_name}/shapes/busy-roads

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "count": 71,
    "geojson": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                151.66,
                -32.99
              ],
              [
                151.67,
                -33
              ]
            ],
            "type": "LineString"
          },
          "properties": {
            "road_class": "primary"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    }
  }
}

Successful Response200

application/json