Microburbs
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Market

Rental vacancy rate — suburb headline

GET/v1/suburbs/{suburb_name}/market/vacancy-rate8¢ per call

Suburb-wide rental vacancy rate by property type, as a decimal fraction (0.00842 = 0.84%). Use /market/vacancy-map for the per-mesh-block surface.

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_namestringrequired

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.

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
VacancyRatefields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

houseobjectmay be null

A published figure with its position among peer suburbs.

unitobjectmay be null

A published figure with its position among peer suburbs.

as_ofstringmay be null

Date of the most recent observation (YYYY-MM-DD).

GET/v1/suburbs/{suburb_name}/market/vacancy-rate
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/vacancy-rate' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "as_of": "2026-06-28",
    "house": {
      "areas": 28,
      "rank": 9,
      "value": 0.00842
    }
  }
}
Successful Response200
application/json