Suburb - Finder

Finder scope regions

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

Free.

get/v1/suburbs/finder/regions

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/finder/regions
  • Auth: HTTP bearer

Response

Successful Response

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": {
    "regions": {
      "NSW": [
        "Sydney - City and Inner South",
        "Newcastle and Lake Macquarie"
      ]
    }
  }
}

Changes

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