Geocode

Suburb autocomplete

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.

get/v1/geocode/suburb

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/geocode/suburb
  • Auth: HTTP bearer

Query parameters

qstring required

Partial suburb name.

Example:belmont
statestring nullable

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

Example:NSW

Response

Successful Response

dataSuburbCandidate[] nullable

The endpoint's payload, or null when Microburbs has no value.

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.