Free sandbox: try any request below on the sample suburbs, no signup. For every suburb, create an API key.

Microburbs Property Data API

LGA - Area Statistics

Households and families

GET/v1/lga/{lga_name}/area-stats/households5¢ per call

Household and family make-up: lone-person, family and group households, household size, couples with and without children and one-parent families, for every suburb and council area.

Coverage: About 10,600 suburbs and localities and 545 council areas across Australia, in all states and territories (areas with too few residents for reliable figures are left out); one snapshot at 10 August 2021. Current to 2021-08-10. Full description, field list and method: /v1/datasets/households.

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

lga_namestringrequired

Council (LGA) name exactly as /v1/lga/list returns it, e.g. `Lake Macquarie`.

Query parameters

fieldsstringoptional

Comma-separated subset of: total_households, total_families, family_households_count, family_households_pct, non_family_households_count, non_family_households_pct, lone_person_households_count, lone_person_households_pct, size_1_person_count, size_1_person_pct, size_2_people_count, size_2_people_pct, size_3_people_count, size_3_people_pct, size_4_people_count, size_4_people_pct, size_5_people_count, size_5_people_pct, size_6_plus_people_count, size_6_plus_people_pct, couple_no_children_count, couple_no_children_pct, couple_with_children_count, couple_with_children_pct, one_parent_families_count, one_parent_families_pct, other_families_count, other_families_pct, couple_children_under_15_count, couple_children_under_15_pct, one_parent_children_under_15_count, one_parent_children_under_15_pct, couple_families_count, couple_families_pct. Omit for all.

fromstringoptional

First period to include: 2020, 2020-Q3, 2020-07 or 2020-07-01.

tostringoptional

Last period to include, same formats as `from`.

Responses

Successful Response

application/json

DatasetValuesfields returned to you

datasetstringalways returned

Dataset slug; describe it with /v1/datasets/{slug}.

levelstringalways returned

suburb, lga or block.

areastringalways returned

Canonical name (or mesh-block code) of the area answered.

period_typestringalways returned

snapshot, year, financial_year, quarter or month.

as_ofstring · datealways returned

Date the dataset is current to. Values are never withheld for age; check this instead.

modelledbooleanalways returned

True when the figures are estimates from a model rather than counts or measurements.

fieldsarray of DatasetFieldSeriesalways returned

GET/v1/lga/{lga_name}/area-stats/households

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/lga/Lake%20Macquarie/area-stats/households' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "dataset": "households",
    "level": "lga",
    "area": "Waverley",
    "period_type": "snapshot",
    "as_of": "2021-08-10",
    "modelled": false,
    "fields": [
      {
        "field": "total_households",
        "name": "Total households",
        "unit": "households",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 27455
          }
        ]
      },
      {
        "field": "total_families",
        "name": "Total families",
        "unit": "families",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 16776
          }
        ]
      },
      {
        "field": "family_households_count",
        "name": "Family households",
        "unit": "households",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 16587
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

About 10,600 suburbs and localities and 545 council areas across Australia, in all states and territories (areas with too few residents for reliable figures are left out); one snapshot at 10 August 2021. Current to 2021-08-10; refreshed five-yearly.

What it is

The make-up of households and families on 10 August 2021, for every suburb and council area: how many households are family, lone-person or group households, how many have one to six or more people, and how many families are couples with children, couples without, one-parent or other, with a head-count and a share for each.

What it shows

Households by type and size (base: all households) and families by type (base: all families), each as a count and a share, plus total households and total families.

Why use it

Household mix tells you who a suburb is for: young couples, families with children, retirees living alone, share houses. Use it to match a suburb to a buyer or tenant, to size demand for different dwelling types, to judge school and childcare need, or to add a household profile to a report.

How it is built

Areas with fewer than 50 residents are left out because every small number is randomised. Our 2021 area statistics, matched to our suburb and council-area names. Figures are a snapshot at 10 August 2021 (the latest full count), so they describe who lived there then, not today. To protect privacy the source lightly randomises small numbers, so a count of 0, 3 or 6 can be approximate; shares for tiny suburbs jump around, so check the total residents field before trusting a percentage. Household shares use all occupied private households as the base; family shares use all families as the base. A household can hold more than one family, so families do not equal family households. couple_with_children is all couple families minus couples with no children.

Fields

Field	Unit	Description
`total_households` Total households	households	Occupied private households counted in the area on 10 August 2021, the base for household shares.
`total_families` Total families	families	Families (couples, one-parent and other) living in private households in the area, the base for family shares.
`family_households_count` Family households	households	Number of households in the area that are: family households (2021 snapshot). Small counts are lightly randomised for privacy.
`family_households_pct` Family households: share of households	%	Family households as a percent of all households in the area.
`non_family_households_count` Non-family households	households	Number of households in the area that are: non-family households (2021 snapshot). Small counts are lightly randomised for privacy.
`non_family_households_pct` Non-family households: share of households	%	Non-family households as a percent of all households in the area.
`lone_person_households_count` Lone-person households	households	Number of households in the area that are: lone-person households (2021 snapshot). Small counts are lightly randomised for privacy.
`lone_person_households_pct` Lone-person households: share of households	%	Lone-person households as a percent of all households in the area.
`size_1_person_count` Households of 1 person	households	Number of households in the area that are: households of 1 person (2021 snapshot). Small counts are lightly randomised for privacy.
`size_1_person_pct` Households of 1 person: share of households	%	Households of 1 person as a percent of all households in the area.
`size_2_people_count` Households of 2 people	households	Number of households in the area that are: households of 2 people (2021 snapshot). Small counts are lightly randomised for privacy.
`size_2_people_pct` Households of 2 people: share of households	%	Households of 2 people as a percent of all households in the area.
`size_3_people_count` Households of 3 people	households	Number of households in the area that are: households of 3 people (2021 snapshot). Small counts are lightly randomised for privacy.
`size_3_people_pct` Households of 3 people: share of households	%	Households of 3 people as a percent of all households in the area.
`size_4_people_count` Households of 4 people	households	Number of households in the area that are: households of 4 people (2021 snapshot). Small counts are lightly randomised for privacy.
`size_4_people_pct` Households of 4 people: share of households	%	Households of 4 people as a percent of all households in the area.
`size_5_people_count` Households of 5 people	households	Number of households in the area that are: households of 5 people (2021 snapshot). Small counts are lightly randomised for privacy.
`size_5_people_pct` Households of 5 people: share of households	%	Households of 5 people as a percent of all households in the area.
`size_6_plus_people_count` Households of 6 or more people	households	Number of households in the area that are: households of 6 or more people (2021 snapshot). Small counts are lightly randomised for privacy.
`size_6_plus_people_pct` Households of 6 or more people: share of households	%	Households of 6 or more people as a percent of all households in the area.
`couple_no_children_count` Couple families with no children	families	Number of families in the area that are: couple families with no children (2021 snapshot). Small counts are lightly randomised for privacy.
`couple_no_children_pct` Couple families with no children: share of families	%	Couple families with no children as a percent of all families in the area.
`couple_with_children_count` Couple families with children	families	Number of families in the area that are: couple families with children (2021 snapshot). Small counts are lightly randomised for privacy.
`couple_with_children_pct` Couple families with children: share of families	%	Couple families with children as a percent of all families in the area.
`one_parent_families_count` One-parent families	families	Number of families in the area that are: one-parent families (2021 snapshot). Small counts are lightly randomised for privacy.
`one_parent_families_pct` One-parent families: share of families	%	One-parent families as a percent of all families in the area.
`other_families_count` Other families	families	Number of families in the area that are: other families (2021 snapshot). Small counts are lightly randomised for privacy.
`other_families_pct` Other families: share of families	%	Other families as a percent of all families in the area.
`couple_children_under_15_count` Couple families with children under 15	families	Number of families in the area that are: couple families with children under 15 (2021 snapshot). Small counts are lightly randomised for privacy.
`couple_children_under_15_pct` Couple families with children under 15: share of families	%	Couple families with children under 15 as a percent of all families in the area.
`one_parent_children_under_15_count` One-parent families with children under 15	families	Number of families in the area that are: one-parent families with children under 15 (2021 snapshot). Small counts are lightly randomised for privacy.
`one_parent_children_under_15_pct` One-parent families with children under 15: share of families	%	One-parent families with children under 15 as a percent of all families in the area.
`couple_families_count` Couple families (all)	families	Number of families in the area that are: couple families (all) (2021 snapshot). Small counts are lightly randomised for privacy.
`couple_families_pct` Couple families (all): share of families	%	Couple families (all) as a percent of all families in the area.