Property - Surroundings

Surrounding properties (200 m)

GET/v1/properties/{gnaf_id}/surroundings/properties15¢ per call

Every GNAF property within 200 m of the subject, with lat/lng and mesh block.

Price: 15¢ 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

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json

SurroundingPropertiesfields returned to you

gnaf_pidstringalways returned

The subject property's GNAF PID.

radius_mintegeralways returned

Radius of the search box around the subject, metres.

countintegeralways returned

Number of properties returned.

propertiesarray of SurroundingPropertyalways returned

Properties inside the box, subject included.

GET/v1/properties/{gnaf_id}/surroundings/properties

cURL

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

Example Responses

Show schema

{
  "data": {
    "count": 128,
    "gnaf_pid": "GANSW704360755",
    "properties": [
      {
        "gnaf_pid": "GANSW704355807",
        "lat": -33.80427291,
        "lng": 151.21837048,
        "address": "9 The Barbette",
        "mb": "10843130000",
        "is_subject": false
      },
      {
        "gnaf_pid": "GANSW704360755",
        "lat": -33.80247931,
        "lng": 151.21971516,
        "address": "90 The Bulwark",
        "mb": "10843090000",
        "is_subject": true
      }
    ],
    "radius_m": 200
  }
}

Successful Response200

application/json