Geocode

Suburb autocomplete

GET/v1/geocode/suburb1¢ per call

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.

Price: 1¢ 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.

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

Show schema

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