Microburbs
Microburbs API
Open in the full API reference →
Property - Amenities

Nearby amenities

GET/v1/properties/{gnaf_id}/amenities/nearby10¢ per call

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

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

gnaf_idstringrequired

Query parameters

radius_minteger100–5000optional

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

Responses

Successful Response

application/json
AmenitiesNearbyfields returned to you
gnaf_idstringalways returned

GNAF property identifier.

center_latnumberalways returned

Property latitude (WGS84).

center_lngnumberalways returned

Property longitude (WGS84).

radius_mintegeralways returned

Search radius applied, metres.

countsobjectalways returned

Count per bucket within the radius (exact, pre-cap).

resultsarray of AmenityRowalways returned

Amenities, nearest first (capped at 80).

GET/v1/properties/{gnaf_id}/amenities/nearby
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/amenities/nearby' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "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
      }
    ]
  }
}
Successful Response200
application/json