Property - Amenities

Nearby amenities

Curated amenities (supermarkets, green spaces, restaurants/cafes) within radius_m of the property, bucketed and nearest-first.

Price: 10¢ per call.

get/v1/properties/{gnaf_id}/amenities/nearby

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/amenities/nearby
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Query parameters

radius_minteger

Search radius in metres (100–5000, default 1000).

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": {
    "center_lat": -33.802479,
    "center_lng": 151.219715,
    "counts": {
      "green_spaces": 4,
      "restaurant": 11,
      "supermarket": 2
    },
    "gnaf_id": "GANSW704360755",
    "radius_m": 1000,
    "results": [
      {
        "category": "Supermarket",
        "distance_m": 240,
        "lat": -33.8011,
        "lng": 151.2216,
        "name": "Castlecrag Village"
      },
      {
        "category": "Green Spaces",
        "distance_m": 190,
        "lat": -33.8038,
        "lng": 151.218
      }
    ]
  }
}

Changes

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