Area Statistics

Search area-statistics 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.

Free.

get/v1/area-stats/fields

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/area-stats/fields
  • Auth: HTTP bearer

Query parameters

querystring nullable

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.

Example:couple family children
limitinteger

Max fields to return.

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": {
    "count": 1,
    "fields": [
      {
        "field_code": "Median_rent_weekly",
        "field_name": "Median rent weekly",
        "label": "Median rent ($/weekly)",
        "topic": "Selected Medians and Averages"
      }
    ]
  }
}

Changes

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