Microburbs
Microburbs API
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
Geocode

Suburb autocomplete

GET/v1/geocode/suburbFree

Autocomplete a partial suburb search string against the ABS SAL list. Use this before calling /v1/suburbs/{name}/... — those endpoints require a canonical SAL name in the path.

Free.

Authorization

Request

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

Query parameters

qstringrequired

Partial suburb name.

statestringoptional

Optional state filter (NSW, VIC, ...).

Responses

Successful Response

application/json
list[SuburbCandidate]fields returned to you
Array of:
GET/v1/geocode/suburb
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/geocode/suburb?q=belmont' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": [
    {
      "area_level": "suburb",
      "area_name": "Belmont (NSW)",
      "information": {
        "lga": "Lake Macquarie",
        "poa": "2280",
        "sa2": "Belmont - Bennetts Green",
        "sa3": "Lake Macquarie - East",
        "sa4": "Newcastle and Lake Macquarie",
        "state": "New South Wales"
      }
    }
  ]
}
Successful Response200
application/json