Suburb - Shapes

Neighbouring suburb boundaries

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

Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

Price: 15¢ per call.

get/v1/suburbs/{suburb_name}/shapes/neighbours

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/shapes/neighbours
  • Auth: HTTP bearer

Path parameters

suburb_namestring required
Example:Belmont North

Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

Query parameters

geojsonboolean

When false, geometry is dropped — every Feature keeps its properties but its geometry is null. Use it to fetch the counts and per-feature attributes without the coordinates (default true — response unchanged).

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "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"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.