Sale-price growth forecast
/v1/suburbs/{suburb_name}/forecast/sale100¢ per call1-year sale-price growth forecast (low / most-likely / high).
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: 100¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
suburb_namestringrequiredExact 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.
Query parameters
Responses
Successful Response
area_namestringalways returnedSuburb (SAL) name.
area_levelstringalways returnedAlways 'suburb' for these endpoints.
metricstringmay be nullMetric label, e.g. 'sale_price_growth_forecast'.
houseobjectmay be nullA forecast expressed as a range rather than a single number — a most-likely outcome with a plausible low and high either side. Everywhere this shape appears the three figures are **growth over the next 12 months, as a decimal fraction**: 0.0379 means +3.79% over the year, and a negative value means a fall. Multiply by 100 to display as a percentage. Present the band, not just `most_likely` — the width between `low` and `high` is the honest part of the forecast.
unitobjectmay be nullA forecast expressed as a range rather than a single number — a most-likely outcome with a plausible low and high either side. Everywhere this shape appears the three figures are **growth over the next 12 months, as a decimal fraction**: 0.0379 means +3.79% over the year, and a negative value means a fall. Multiply by 100 to display as a percentage. Present the band, not just `most_likely` — the width between `low` and `high` is the honest part of the forecast.
/v1/suburbs/{suburb_name}/forecast/salecurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/forecast/sale' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"house": {
"confidence": 2,
"high": 0.0927,
"low": 0.0379,
"most_likely": 0.0686
},
"metric": "sale_price_growth_forecast",
"unit": {
"confidence": 2,
"high": 0.0993,
"low": 0.0353,
"most_likely": 0.0762
}
}
}