Rental vacancy — per mesh block
/v1/suburbs/{suburb_name}/market/vacancy-map10¢ per callCalibrated rental-vacancy rate for each mesh block in the suburb.
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.
mbsarray of VacancyMbalways returnedPer-mesh-block vacancy rates.
/v1/suburbs/{suburb_name}/market/vacancy-mapcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/vacancy-map' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"mbs": [
{
"has_listings": true,
"mb": "10431160000",
"rental_listings": 15,
"rental_stock": 23.3,
"vacancy_pct": 0.74
}
]
}
}