Property - Amenities

Nearest transport by mode

GET/v1/properties/{gnaf_id}/transport/nearby5¢ per call

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.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

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

TransportNearbyfields 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 mode within the radius (train / tram / bus / ferry).

nearestobjectalways returned

Nearest stop per mode; null when none falls inside the radius.

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

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/transport/nearby' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "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
  }
}

Successful Response200

application/json