area_stats_fields
Discover which statistical fields exist. Free (0c). Fuzzy, token-based
matching covers table topics and clean column labels as well as terse field
codes. Common natural-language plurals and Census synonyms are handled, so
the verbatim query=couples with children discovers the exact 2021 ABS
family-composition count fields rather than substituting the broader
census_family_households metric. Use the returned field code(s) with the
priced /area-stats/SAL/{suburb}/values route. ~17k fields available.
Price: 0¢ per call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max fields to return. | |
| query | No | Fuzzy search over ABS field names/codes, table topics and column labels (e.g. 'total population', 'couple family children', 'tenure owned outright', or 'median rent'). Omit to list. |
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. |