Amenity price impacts
/v1/suburbs/{suburb_name}/lifestyle/poi-impacts10¢ per callWhat the absence of petrol stations, fast food and bottle shops near sold properties was worth.
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: 10¢ 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.
n_salesintegeralways returnedRecent sales in the analysis window.
median_priceintegeralways returnedMedian sale price across those sales (AUD).
total_premiumintegeralways returnedCombined absence premium across all drivers (AUD).
driversarray of PoiImpactDriveralways returnedDrivers, largest premium first.
/v1/suburbs/{suburb_name}/lifestyle/poi-impactscurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/poi-impacts' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Castlecrag",
"drivers": [
{
"coverage_pct": 100,
"detail": "100% of 9 recent sales in Castlecrag were at properties with no petrol station nearby. Those sales cleared about $184,500 more than comparable suburbs with petrol stations, equivalent to 4.1% of the $4,500,000 median price here.",
"label": "No petrol station nearby",
"pct_of_median": 4.1,
"premium_dollars": 184500
}
],
"median_price": 4500000,
"n_sales": 9,
"total_premium": 263000
}
}