Suburb - Market

Affordability index

GET/v1/suburbs/{suburb_name}/market/affordability5¢ per call

Microburbs affordability index for the suburb's postcode area.

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

Affordabilityfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

poastringmay be null

Postcode area (POA) the index is computed for.

indexintegermay be null

Microburbs Affordability Index, 1-100 (higher = stronger affordability-driven capital-growth outlook).

zonestringmay be null

Zone label: 'Strong Outlook' / 'Solid' / 'Cautious' / 'Headwind'.

cg_directionstringmay be null

Capital-growth direction indicator: '++' / '+' / '~' / '-' / '--'.

forecast_cg_panumbermay be null

Forecast capital growth, percent per year (4.7 = 4.7%/yr).

price_to_salarynumbermay be null

Median house price / average salary multiple.

avg_salarynumbermay be null

Average salary in the POA (AUD/yr).

welfare_pctnumbermay be null

Share of income earners on welfare (%).

pct_neg_gearingnumbermay be null

Share of taxpayers negatively gearing (%).

GET/v1/suburbs/{suburb_name}/market/affordability

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "avg_salary": 72781.3,
    "cg_direction": "-",
    "forecast_cg_pa": 4.7,
    "index": 41,
    "pct_neg_gearing": 5.99,
    "poa": "2280",
    "price_to_salary": 17.96,
    "welfare_pct": 35.25,
    "zone": "Cautious"
  }
}

Successful Response200

application/json