Suburb - Hero

Neighbouring suburbs

GET/v1/suburbs/{suburb_name}/hero/neighbours5¢ per call

Nearest neighbouring suburbs with distance in km, closest first.

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

HeroNeighboursfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

neighboursarray of HeroNeighbourRowalways returned

Neighbouring suburbs ordered by distance (closest first).

GET/v1/suburbs/{suburb_name}/hero/neighbours

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "neighbours": [
      {
        "dist_km": 1,
        "sa3": "Lake Macquarie - East",
        "sal": "Floraville"
      },
      {
        "dist_km": 1.4,
        "sa3": "Lake Macquarie - East",
        "sal": "Belmont (NSW)"
      }
    ]
  }
}

Successful Response200

application/json