Suburb - Lifestyle

Lifestyle summary — POIs, terrain, landmarks

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

POI category breakdown, terrain scalars, nearest train/shop and beach/hospital flags.

Price: 10¢ per call.

Authorization

Bearer tokentest

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

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

LifestyleSummaryfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

total_poisintegeralways returned

Total POIs across all categories.

poi_categoriesarray of PoiCategoryBreakdownalways returned

Per-category POI counts, largest first.

terrainobjectmay be null

Pre-aggregated terrain scalars across the suburb's properties.

nearest_trainobjectmay be null

Nearest train station to the suburb centroid.

nearest_shopobjectmay be null

Nearest major shop / shopping centre to the suburb centroid.

has_beachbooleanalways returned

A beach exists within ~50 km.

nearest_beach_kmnumbermay be null

Distance to the nearest beach (km); null when none within ~50 km.

has_hospitalbooleanalways returned

A hospital exists within ~50 km.

nearest_hospital_kmnumbermay be null

Distance to the nearest hospital (km); null when none within ~50 km.

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

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "has_beach": true,
    "has_hospital": true,
    "nearest_beach_km": 1.5,
    "nearest_hospital_km": 1.4,
    "nearest_shop": {
      "category": "Supermarket",
      "dist_km": 1.2,
      "name": "Coles"
    },
    "nearest_train": {
      "dist_km": 1.4,
      "name": "Jewells railway station"
    },
    "poi_categories": [
      {
        "category": "Education",
        "count": 9,
        "top_subtypes": [
          {
            "count": 5,
            "label": "School"
          },
          {
            "count": 3,
            "label": "Childcare"
          },
          {
            "count": 1,
            "label": "Preschool"
          }
        ]
      }
    ],
    "terrain": {
      "aspect_compass": "SE",
      "avg_aspect_deg": 149,
      "median_elevation_m": 26,
      "median_slope_deg": 5.6,
      "n_flat": 698,
      "n_moderate": 830,
      "n_properties": 1759,
      "n_steep": 231,
      "pct_steep": 13
    },
    "total_pois": 43
  }
}

Successful Response200

application/json