Suburb - Lifestyle

POIs / amenities in the suburb (pubs, cafes, gyms, schools, …)

Every named venue / amenity in the suburb as GeoJSON Point features, plus a per-category count.

Each point carries name, a broad category (Restaurant / Cafe, Shopping, Health, Entertainment, Sport & Fitness, Education, …) and a finer subtype (e.g. pub, bar, cafe, restaurant, gym, supermarket, school, pharmacy). This is the endpoint for "what / how many <venue type> are in this suburb" and "name the pubs / cafes / gyms in X" — filter or count the features on subtype, and read real venue names from name. The top-level categories array gives the broad-category counts without walking the list.

Unpaged by default. Big suburbs are big — Sydney is ~3.7 MB of features — so pass limit/offset (or narrow with category) when you don't need them all. count and categories always describe the whole suburb, so paging never hides the totals. Flat price per call regardless of page size.

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

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

Request

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

Query parameters

limitinteger nullable

Features to return (default: all).

offsetinteger

Feature offset — page with limit.

categorystring nullable

Only this display category (e.g. Shopping). Case-insensitive.

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",
    "categories": [
      {
        "category": "Shopping",
        "count": 32
      },
      {
        "category": "Sport & Fitness",
        "count": 26
      }
    ],
    "count": 177,
    "pois": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              151.66231,
              -33.02463
            ],
            "type": "Point"
          },
          "properties": {
            "name": "Ampol Foodary",
            "category": "Shopping",
            "subtype": "newsagent",
            "dim": "convenience"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    }
  }
}

Changes

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