area_stats_values
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | SAL only: 'sa1' returns values for every SA1 in the suburb, instead of the suburb aggregate. | |
| fields | Yes | Comma-separated field codes (from /fields). Required, 1-5 per call. | |
| region | Yes | Region name (case-insensitive). For SA1, the SA1 code (SA1s are unnamed). | |
| region_level | Yes | Region level: SAL (suburb), SA1, SA2, SA3, SA4, LGA, POA, GCCSA, STE, AUS. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The endpoint's payload, or `null` when Microburbs has no value. | |
| reason | No | Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success. | |
| message | No | Human-readable explanation. Omitted on success. | |
| available | No | `false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator. |