Property - Risks

Public-housing overlay

GET/v1/properties/{gnaf_id}/risks/public-housing4¢ per call

Public-housing concentration overlay near the parcel.

Price: 4¢ 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

list[RiskRecord]fields returned to you

Array of:

area_levelstringmay be null

area_namestringmay be null

namestringmay be null

valuestringmay be null

value_unitstringmay be null

geojsonobjectmay be null

GeoJSON FeatureCollection of the hazard polygons for this overlay, ST_Intersection-clipped to a 1km-radius circle around the property and simplified for browser use. Present only when the request passes `?geojson=true`; absent (and the response byte-identical to before) otherwise.

geojson_metaobjectmay be null

Clip / simplify / truncation metadata for `geojson` (clip_method='1km_radius', radius_m, simplify tolerance, coordinate precision, feature/byte caps, and whether the size cap truncated the output). Present only with `?geojson=true`.

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

cURL

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

Example Responses

Show schema

{
  "data": [
    {
      "area_level": "Layer",
      "area_name": "Risk Layer",
      "name": "Public Housing",
      "value": "14.5%",
      "value_unit": "Properties Proportion"
    },
    {
      "area_level": "Layer",
      "area_name": "Risk Layer",
      "name": "Public Housing",
      "value": "3.4%",
      "value_unit": "Properties Proportion"
    }
  ]
}

Successful Response200

application/json