Property - Surroundings

Surrounding public-housing flags (200 m)

GET/v1/properties/{gnaf_id}/surroundings/public-housing15¢ per call

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

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

SurroundingPublicHousingfields returned to you

gnaf_pidstringalways returned

The subject property's GNAF PID.

radius_mintegeralways returned

Radius of the search box around the subject, metres.

property_countintegeralways returned

Total properties inside the search box.

flagged_countintegeralways returned

How many of those the classifier flags as public housing.

flaggedarray of PublicHousingFlagalways returned

The flagged properties (empty when none).

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

cURL

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

Example Responses

Show schema

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

Successful Response200

application/json