Property - Amenities

Nearest transport by mode

Nearest train / tram / bus / ferry stop to the property, per mode, with distance. Widen radius_m for the nearest station beyond 1km.

Price: 5¢ per call.

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/transport/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": {
      "bus": 6,
      "ferry": 0,
      "train": 0,
      "tram": 0
    },
    "gnaf_id": "GANSW704360755",
    "nearest": {
      "bus": {
        "distance_m": 130,
        "label": "Bus stop",
        "lat": -33.8031,
        "lng": 151.2201
      }
    },
    "radius_m": 1000
  }
}

Changes

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