Suburb - Risks

Property hazard counts

Counts and shares of the suburb's properties flagged bushfire / flood / mine-subsidence / contamination / aircraft-noise / acid-sulfate.

Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

Price: 15¢ per call.

get/v1/suburbs/{suburb_name}/risks/property-hazard-counts

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/risks/property-hazard-counts
  • Auth: HTTP bearer

Path parameters

suburb_namestring required
Example:Belmont North

Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

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": {
    "acid_sulfate": {
      "any_high_count": 0,
      "any_high_pct": 0,
      "surface_high_count": 0,
      "surface_high_pct": 0
    },
    "aircraft_noise": {},
    "area_level": "suburb",
    "area_name": "Belmont North",
    "bushfire": {
      "count": 644,
      "pct": 23.62
    },
    "contamination": {
      "nearest_m": 1.7,
      "within_250m_count": 180,
      "within_250m_pct": 6.6,
      "within_500m_count": 496,
      "within_500m_pct": 18.19
    },
    "flood": {
      "count": 154,
      "pct": 5.65
    },
    "mine_subsidence": {
      "count": 2727,
      "pct": 100
    },
    "total_properties": 2727
  }
}

Changes

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