Area Statistics

Area statistics for a region

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.

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

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/area-stats/{region_level}/{region}/values
  • Auth: HTTP bearer

Path parameters

region_levelstring required

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

Example:SAL
regionstring required

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

Example:Belmont North

Query parameters

fieldsstring required

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

Example:Median_age_persons
modestring nullable

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

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": {
    "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
  }
}

Changes

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