Suburb - Shapes

Suburb boundary polygon

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

Simplified SAL boundary polygon (GeoJSON Feature) plus centroid.

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

SuburbBoundaryfields returned to you

area_namestringalways returned

Canonical ABS SAL name.

area_levelstringalways returned

Always 'suburb'.

centroidobjectalways returned

Suburb centroid — WGS84 lat/lng.

geojsonobjectalways returned

GeoJSON Feature — the SAL boundary polygon, simplified (topology-preserving, ~10 m tolerance, 6 dp coordinates).

GET/v1/suburbs/{suburb_name}/shapes/boundary

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "centroid": {
      "lat": -32.9931,
      "lng": 151.6688
    },
    "geojson": {
      "geometry": {
        "coordinates": [
          [
            [
              151.66,
              -32.99
            ],
            [
              151.67,
              -32.99
            ],
            [
              151.67,
              -33
            ],
            [
              151.66,
              -32.99
            ]
          ]
        ],
        "type": "Polygon"
      },
      "properties": {
        "suburb": "Belmont North"
      },
      "type": "Feature"
    }
  }
}

Successful Response200

application/json