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

Surrounding cadastral parcels (200 m)

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

Cadastral parcel polygons (GeoJSON) for properties around the subject.

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

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

Responses

Successful Response

application/json
SurroundingParcelsfields 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 parcel features returned.

parcelsobjectalways returned

RFC 7946 GeoJSON FeatureCollection of parcel polygons.

GET/v1/properties/{gnaf_id}/surroundings/parcels
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/surroundings/parcels' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "count": 127,
    "gnaf_pid": "GANSW704360755",
    "parcels": {
      "features": [
        {
          "geometry": {
            "coordinates": [
              [
                [
                  [
                    151.221417,
                    -33.800987
                  ],
                  [
                    151.221318,
                    -33.801078
                  ],
                  [
                    151.221308,
                    -33.801256
                  ],
                  [
                    151.221417,
                    -33.800987
                  ]
                ]
              ]
            ],
            "type": "MultiPolygon"
          },
          "properties": {
            "gnaf_pid": "GANSW704355807",
            "is_subject": false
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "radius_m": 200
  }
}
Successful Response200
application/json