SA4 - Profile

List SA4s

All Australian SA4s. Optional ?state= filter. Returns {sa4, state} per row. Flat cost.

Price: 3¢ per call.

get/v1/sa4/list

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/sa4/list
  • Auth: HTTP bearer

Query parameters

statestring nullable

Filter by state / territory. Optional — ~110 SA4s nationally.

Example:NSW

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": [
    {
      "sa4": "Newcastle and Lake Macquarie",
      "state": "NSW"
    }
  ]
}

Changes

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