Suburb - Lifestyle

Livability scores + regional benchmark

Livability scores (0–100) per dimension, aggregated from mesh-block scores, with the SA4 benchmark.

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

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/lifestyle/livability
  • 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",
    "benchmark": {
      "n_suburbs": 149,
      "region": "Newcastle and Lake Macquarie",
      "scores": {
        "affluence": 66.9,
        "hip": 59.5,
        "lifestyle": 73.4,
        "safety": 84.8
      }
    },
    "n_mesh_blocks": 63,
    "scores": [
      {
        "key": "affluence",
        "label": "Affluence",
        "level": "Moderate",
        "value": 56
      },
      {
        "key": "lifestyle",
        "label": "Lifestyle",
        "level": "Moderate",
        "value": 72
      },
      {
        "key": "safety",
        "label": "Safety",
        "level": "High",
        "value": 76
      }
    ]
  }
}

Changes

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