Suburb - Lifestyle

Nearest capital city + distance

GET/v1/suburbs/{suburb_name}/lifestyle/cbd3¢ per call

Nearest capital city and straight-line distance in km.

Price: 3¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

The only values you send. Fields under Responses below are what comes back — you never pass those.

suburb_namestringrequired

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Successful Response

application/json

LifestyleCbdfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

citystringmay be null

Capital city name (e.g. 'Sydney').

distance_kmnumberalways returned

Straight-line distance to the capital (km).

GET/v1/suburbs/{suburb_name}/lifestyle/cbd

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "city": "Sydney",
    "distance_km": 108
  }
}

Successful Response200

application/json