Suburb - Lifestyle

Livability scores per microburb

All seven livability dimensions — affluence, lifestyle, hip, convenience, family, safety, tranquility — scored 0-100 for every microburb (mesh block) in the suburb, each with its human band. Averaging a dimension across the microburbs reproduces the suburb figure at /lifestyle/livability. Values only; polygons come from /shapes/mesh-blocks.

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

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/lifestyle/livability-map
  • 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": {
    "definition": "Seven livability dimensions scored for each mesh block ('microburb', the smallest ABS geography, ~30-60 dwellings), rescaled from the source 0-10 to 0-100. Higher is better on every dimension, safety included — it is an inverse-scaled crime score built from the same per-mesh-block crime model /crime/by-mesh-block exposes as raw rates. Averaging a dimension across the microburbs here gives the suburb figure at /lifestyle/livability. Dimensions with no score for a microburb are omitted, not zeroed.",
    "dimensions": [
      {
        "description": "Reported crime rates across personal, property, drug and public-order offences compared with the state average. Inverse-scaled, so a higher score means less predicted crime.",
        "key": "safety",
        "label": "Safety"
      }
    ],
    "metric": "livability_scores",
    "microburbs": [
      {
        "levels": {
          "affluence": "Low",
          "convenience": "Low",
          "family": "Moderate",
          "hip": "Moderate",
          "lifestyle": "Low",
          "safety": "Moderate",
          "tranquility": "Very low"
        },
        "mb": "10431160000",
        "scores": {
          "affluence": 43,
          "convenience": 46,
          "family": 52,
          "hip": 50,
          "lifestyle": 34,
          "safety": 53,
          "tranquility": 8
        },
        "street": "Floraville"
      }
    ],
    "n_microburbs": 63,
    "suburb": "Belmont North",
    "unit": "score_0_100"
  }
}

Changes

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