Microburbs
Microburbs API
Open in the full API reference →
Suburb - Lifestyle

Livability scores + regional benchmark

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

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

Price: 10¢ per call.

Authorization

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
LifestyleLivabilityfields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

n_mesh_blocksintegeralways returned

Mesh blocks the scores aggregate over.

scoresarray of LivabilityScorealways returned

One entry per dimension.

benchmarkobjectmay be null

SA4-region benchmark for comparing the suburb's scores.

GET/v1/suburbs/{suburb_name}/lifestyle/livability
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/livability' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "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
      }
    ]
  }
}
Successful Response200
application/json