Property - Surroundings

Surrounding public-housing flags (200 m)

Properties around the subject flagged by the public-housing classifier.

Price: 15¢ per call.

get/v1/properties/{gnaf_id}/surroundings/public-housing

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/surroundings/public-housing
  • 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": {
    "flagged": [
      {
        "address": "3 The Bulwark",
        "gnaf_pid": "GANSW704349559",
        "lat": -33.80311,
        "lng": 151.21899,
        "ph_chance": 3
      }
    ],
    "flagged_count": 1,
    "gnaf_pid": "GANSW704360755",
    "property_count": 128,
    "radius_m": 200
  }
}

Changes

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