Suburb - Market

Capital-growth drivers

Per-indicator capital-growth attribution for the suburb.

Each row pairs the suburb's own value for an indicator with the capital-growth differential our matched studies attribute to it, in percentage points. Covers supply & demand pressure, market signals, environmental risks and demographic composition.

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

get/v1/suburbs/{suburb_name}/market/growth-drivers

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/market/growth-drivers
  • 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",
    "drivers": [
      {
        "band": "(0.999, 1.51]",
        "basis": "nat_rel",
        "category": "supply_demand",
        "direction": "positive",
        "horizon_years": 2,
        "impact_pct_per_year": 1.11,
        "indicator": "Months of Supply",
        "key": "prop_list_months_of_supply",
        "source": "thresholds_v3_prod",
        "unit": "months",
        "value": 1
      },
      {
        "band": "present",
        "basis": "matched_control",
        "category": "risks",
        "direction": "neutral",
        "horizon_years": 1,
        "impact_pct_per_year": -0.29,
        "indicator": "Contamination",
        "key": "contamination",
        "source": "dbyd_matched_cg",
        "unit": "%",
        "value": 18.19
      },
      {
        "band": "Top",
        "basis": "nat_bin",
        "category": "demographics",
        "direction": "positive",
        "horizon_years": 4,
        "impact_pct_per_year": 0.43,
        "indicator": "Cultural Integration",
        "key": "cultural_integration",
        "source": "cultural_integration_sal",
        "unit": "score_0_100",
        "value": 61.8
      }
    ]
  }
}

Changes

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