Suburb - Market

Rental vacancy — per mesh block

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

Calibrated rental-vacancy rate for each mesh block in the suburb.

Price: 10¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

suburb_namestringrequired

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

VacancyMapfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

mbsarray of VacancyMbalways returned

Per-mesh-block vacancy rates.

GET/v1/suburbs/{suburb_name}/market/vacancy-map

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/vacancy-map' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "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
      }
    ]
  }
}

Successful Response200

application/json