Suburb - Profile

List suburbs

GET/v1/suburbs/list3¢ per call

List Australian suburbs (SALs). Always returns {suburb, state} per row so SAL-name collisions across states are unambiguous.

With no filter you get the first 1000 suburbs alphabetically (browser-renderable preview). Pass any of the filters to narrow: state / lga / sa4 / sa3 / postcode / q (name search). Filters combine (AND). Flat cost regardless of how many rows come back.

Price: 3¢ 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

statestringoptional

Filter by state / territory (e.g. NSW, VIC, 'New South Wales').

lgastringoptional

Filter by Local Government Area name.

sa4stringoptional

Filter by SA4 name.

sa3stringoptional

Filter by SA3 name.

postcodestringoptional

Filter by 4-digit postcode (POA).

qstringoptional

Case-insensitive substring search on suburb name.

Responses

Successful Response

application/json

list[SuburbListItem]fields returned to you

Array of:

suburbstringalways returned

Suburb (SAL) name.

statestringalways returned

State / Territory.

GET/v1/suburbs/list

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/list' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": [
    {
      "state": "New South Wales",
      "suburb": "Belmont North"
    }
  ]
}

Successful Response200

application/json