Property - Surroundings

Surrounding tenure mix (200 m)

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

ABS Census 2021 tenure shares for each mesh block around the subject.

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

SurroundingTenurefields returned to you

gnaf_pidstringalways returned

The subject property's GNAF PID.

radius_mintegeralways returned

Radius of the search box around the subject, metres.

as_ofstringalways returned

Census anchor date (YYYY-MM-DD).

mbsarray of MbTenurealways returned

Per-mesh-block tenure shares, sorted by property count desc.

GET/v1/properties/{gnaf_id}/surroundings/tenure

cURL

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

Example Responses

Show schema

{
  "data": {
    "as_of": "2021-08-10",
    "gnaf_pid": "GANSW704360755",
    "mbs": [
      {
        "mb": "10843090000",
        "mortgaged_pct": 39.9,
        "owned_outright_pct": 35.4,
        "property_count": 39,
        "public_housing_pct": 0,
        "rented_pct": 15.2
      },
      {
        "mb": "10842992000",
        "mortgaged_pct": 45.9,
        "owned_outright_pct": 36.3,
        "property_count": 21,
        "public_housing_pct": 0.6,
        "rented_pct": 6.6
      }
    ],
    "radius_m": 200
  }
}

Successful Response200

application/json