Suburb - Lifestyle

Distance to the nearest city and to the nearest capital

Straight-line distance to the nearest city and to the nearest capital, in km.

Both, because they answer different questions and are often nowhere near each other: Belmont North is 14 km from Newcastle and 108 km from Sydney. nearest_city is usually what a buyer means by "how far is town".

The top-level city / distance_km fields are DEPRECATED. They still describe the CAPITAL, unchanged, so existing callers are unaffected — read capital_city or nearest_city instead.

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: 3¢ per call.

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/lifestyle/cbd
  • 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.

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",
    "capital_city": {
      "distance_km": 108,
      "name": "Sydney"
    },
    "city": "Sydney",
    "distance_km": 108,
    "nearest_city": {
      "distance_km": 14,
      "name": "Newcastle"
    }
  }
}

Changes

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