Property - Surroundings

Surrounding cadastral parcels (200 m)

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

Price: 25¢ per call.

get/v1/properties/{gnaf_id}/surroundings/parcels

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/surroundings/parcels
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

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

Changes

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