Suburb - Finder

Finder scope regions

GET/v1/suburbs/finder/regions0¢ per call

SA4 regions grouped by state — the values accepted by states / regions on search. 0c.

Price: 0¢ per call.

Authorization

Bearer tokentest

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

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

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Successful Response

application/json

RegionsResponsefields returned to you

regionsobjectalways returned

`{state: [sa4, ...]}` — pass a state to `states` and/or an SA4 to `regions`.

GET/v1/suburbs/finder/regions

cURL

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

Example Responses

Show schema

{
  "data": {
    "regions": {
      "NSW": [
        "Sydney - City and Inner South",
        "Newcastle and Lake Macquarie"
      ]
    }
  }
}

Successful Response200

application/json