Suburb - Risks

Capital-growth impact per hazard

Matched-study capital-growth impact (%/yr) for bushfire, flood, contamination, mine subsidence, aircraft noise and surface acid sulfate, scaled by the share of properties affected.

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: 12¢ per call.

get/v1/suburbs/{suburb_name}/risks/capital-growth-impact

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/risks/capital-growth-impact
  • 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": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "hazards": [
      {
        "affected_pct": 23.62,
        "coefficient_pct_per_year": 0.9,
        "color_class": "neutral",
        "impact": "+0.21%/yr",
        "impact_pct_per_year": 0.2126,
        "key": "bushfire",
        "label": "Bushfire",
        "present": true
      },
      {
        "affected_pct": 100,
        "coefficient_pct_per_year": 0.2,
        "color_class": "neutral",
        "impact": "+0.2%/yr",
        "impact_pct_per_year": 0.2,
        "key": "mine_subsidence",
        "label": "Mine subsidence",
        "present": true
      }
    ],
    "study": "Microburbs matched capital-growth study (DBYD) — treated minus control CAGR",
    "total_properties": 2727
  }
}

Changes

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