Suburb - Lifestyle

Lifestyle summary — POIs, terrain, landmarks

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

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/summary

Request

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

Changes

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