Area Statistics

List regions at a level

List the regions that exist at a level — every suburb, LGA, postcode, etc. Free (0c). Use it to discover the exact region names to pass to /values.

Free.

get/v1/area-stats/regions

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/area-stats/regions
  • Auth: HTTP bearer

Query parameters

region_levelstring required

Region level: SAL (suburb), SA1, SA2, SA3, SA4, LGA, POA, GCCSA, STE, AUS.

Example:SAL
querystring nullable

Filter by region name (substring, case-insensitive). Omit to list.

Example:lake
limitinteger

Max regions to return.

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": {
    "count": 1,
    "region_level": "LGA",
    "regions": [
      {
        "region_code": "14750",
        "region_name": "Lake Macquarie"
      }
    ]
  }
}

Changes

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