Suburb - Risks

Heritage share of properties

GET/v1/suburbs/{suburb_name}/risks/heritage-share5¢ per call

Share of the suburb's properties inside a heritage polygon.

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

suburb_namestringrequired

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

HeritageSharefields returned to you

area_namestringalways returned

Canonical ABS SAL suburb name.

area_levelstringalways returned

Always 'suburb'.

heritage_pctnumberalways returned

% of properties inside a heritage polygon.

value_unitstringalways returned

Unit label ('% of properties').

GET/v1/suburbs/{suburb_name}/risks/heritage-share

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/heritage-share' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "area_name": "Belmont North",
    "area_level": "suburb",
    "heritage_pct": 10.39,
    "value_unit": "% of properties"
  }
}

Successful Response200

application/json