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

Neighbouring suburb boundaries

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

Neighbouring suburbs as a GeoJSON FeatureCollection — each with its boundary polygon and distance in km.

Price: 15¢ 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
SuburbNeighboursfields returned to you
area_namestringalways returned

Canonical ABS SAL name of the subject suburb.

area_levelstringalways returned

Always 'suburb'.

countintegeralways returned

Number of neighbouring suburbs returned.

geojsonobjectalways returned

GeoJSON FeatureCollection — one Feature per neighbouring suburb. Properties: `suburb` (SAL name), `sa3`, `dist_km` (centroid distance in km).

GET/v1/suburbs/{suburb_name}/shapes/neighbours
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/shapes/neighbours' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "count": 2,
    "geojson": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                [
                  151.65,
                  -33.02
                ],
                [
                  151.66,
                  -33.02
                ],
                [
                  151.66,
                  -33.03
                ],
                [
                  151.65,
                  -33.02
                ]
              ]
            ],
            "type": "Polygon"
          },
          "properties": {
            "suburb": "Belmont (NSW)",
            "sa3": "Lake Macquarie - East",
            "dist_km": 1.2
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    }
  }
}
Successful Response200
application/json