Property - Title

Neighbours

Adjoining-parcel neighbours, enriched with address + property type + bed/bath/garage from the latest matching listing.

Price: 30¢ per call.

get/v1/properties/{gnaf_id}/neighbours

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/neighbours
  • 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": {
    "neighbours": [
      {
        "address": "3 TAMAR STREET",
        "gnaf_pid": "GANSW704083204",
        "property_type": "house"
      },
      {
        "address": "16 HARRISON STREET",
        "gnaf_pid": "GANSW704073018",
        "property_type": "house"
      },
      {
        "address": "14 HARRISON STREET",
        "gnaf_pid": "GANSW704073016",
        "property_type": "house"
      }
    ]
  }
}

Changes

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