Months of supply
/v1/suburbs/{suburb_name}/market/months-of-supply8¢ per callHow many months the current for-sale stock would take to clear at the suburb's current sales rate. Under 2 months is a seller's market.
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: 8¢ 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.
months_of_supplynumberalways returnedMonths of for-sale stock at the current sales rate. Under 2 = a seller's market.
rankintegermay be nullPosition among peer suburbs (1 = most supply).
areasintegermay be nullSize of the peer group the rank is out of.
/v1/suburbs/{suburb_name}/market/months-of-supplycurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/months-of-supply' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"areas": 79,
"months_of_supply": 1,
"rank": 53
}
}