Area Statistics

Area statistics for a region

GET/v1/area-stats/{region_level}/{region}/values3¢ per call

Statistical field values for one region. Pass fields — 1 to 5 field codes (from /fields) — to fetch.

At SAL level, mode=sa1 switches from the suburb-aggregate value to a per-SA1 breakdown — every SA1 that falls inside the suburb, each with its own values.

Price: 3¢ per call.

17,000+

statistical fields, one query

Every census statistic — from median rent to how many people cycle to work — for every Australian geography: suburb, postcode, LGA, SA1–SA4, state and more. Search the whole catalogue live:

searching…

Free to search. Copy a field_code into the fields parameter below to fetch its value for any region.

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.

Path parameters

region_levelstringrequired

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

regionstringrequired

Region name (case-insensitive). For SA1, the SA1 code (SA1s are unnamed).

Query parameters

fieldsstringrequired

Comma-separated field codes (from /fields). Required, 1-5 per call.

modestringoptional

SAL only: 'sa1' returns values for every SA1 in the suburb, instead of the suburb aggregate.

Responses

Successful Response

application/json

AreaStatValuesfields returned to you

region_levelstringalways returned

Region level (SAL, SA1-4, LGA, POA, …).

region_codestringmay be null

Region code.

region_namestringmay be null

Region name (the SA1 code for SA1 — SA1s are unnamed).

yearintegermay be null

Reference year.

fieldsarray of AreaStatValueRowmay be null

Field values for the region (default mode).

modestringmay be null

'sa1' when this is a per-SA1 breakdown of a suburb.

sa1_countintegermay be null

Number of SA1s in the suburb (mode=sa1).

sa1sarray of AreaStatSa1may be null

Per-SA1 values (mode=sa1).

GET/v1/area-stats/{region_level}/{region}/values

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/area-stats/SAL/Bondi/values?fields=One_method_Bicycle_P%2CMedian_age_persons' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "fields": [
      {
        "field_code": "Median_rent_weekly",
        "field_name": "Median rent weekly",
        "label": "Median rent ($/weekly)",
        "topic": "Selected Medians and Averages",
        "value": 656
      }
    ],
    "region_code": "11303",
    "region_level": "SAL",
    "region_name": "Bondi",
    "year": 2021
  }
}

Successful Response200

application/json