Area Statistics

List regions at a level

GET/v1/area-stats/regions0¢ per call

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.

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

region_levelstringrequired

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

querystringoptional

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

limitinteger1–1000optional

Max regions to return.

Responses

Successful Response

application/json

AreaStatRegionsResponsefields returned to you

region_levelstringalways returned

Region level (SAL, SA1-4, LGA, POA, GCCSA, STE, AUS).

countintegeralways returned

Number of regions returned.

regionsarray of AreaStatRegionalways returned

Regions, name-sorted.

GET/v1/area-stats/regions

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/area-stats/regions?region_level=LGA' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "count": 1,
    "region_level": "LGA",
    "regions": [
      {
        "region_code": "14750",
        "region_name": "Lake Macquarie"
      }
    ]
  }
}

Successful Response200

application/json