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

Dwelling structure

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

What kind of homes an area is made of: separate houses, semi-detached and townhouses, flats by height of block, and other dwellings, plus how many homes stood empty, for every suburb and council area.

Coverage: About 11,500 suburbs and localities and 545 council areas across Australia, in all states and territories (areas with too few people or homes 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/dwelling-structure.

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_occupied_dwellings, separate_house_count, separate_house_pct, semi_detached_count, semi_detached_pct, semi_detached_one_storey_count, semi_detached_one_storey_pct, semi_detached_two_plus_storeys_count, semi_detached_two_plus_storeys_pct, flat_or_apartment_count, flat_or_apartment_pct, flat_one_or_two_storey_block_count, flat_one_or_two_storey_block_pct, flat_three_storey_block_count, flat_three_storey_block_pct, flat_four_to_eight_storey_block_count, flat_four_to_eight_storey_block_pct, flat_nine_plus_storey_block_count, flat_nine_plus_storey_block_pct, flat_attached_to_house_count, flat_attached_to_house_pct, other_dwelling_count, other_dwelling_pct, caravan_count, caravan_pct, cabin_or_houseboat_count, cabin_or_houseboat_pct, improvised_home_or_tent_count, improvised_home_or_tent_pct, attached_to_shop_or_office_count, attached_to_shop_or_office_pct, structure_not_stated_count, structure_not_stated_pct, total_private_dwellings, unoccupied_count, unoccupied_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/dwelling-structure

cURL

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

Example Responses

Show schema

{
  "data": {
    "dataset": "dwelling-structure",
    "level": "lga",
    "area": "Waverley",
    "period_type": "snapshot",
    "as_of": "2021-08-10",
    "modelled": false,
    "fields": [
      {
        "field": "total_occupied_dwellings",
        "name": "Occupied private dwellings",
        "unit": "dwellings",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 27455
          }
        ]
      },
      {
        "field": "separate_house_count",
        "name": "Separate house",
        "unit": "dwellings",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 4405
          }
        ]
      },
      {
        "field": "separate_house_pct",
        "name": "Separate house: share of occupied private dwellings",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 16.04
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

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

What it is

The type of every occupied private dwelling on 10 August 2021, for every suburb and council area: separate houses, semi-detached, row, terrace and townhouses (one storey or two or more), flats and apartments by the height of the block (one or two storeys, three, four to eight, nine or more, or attached to a house), and caravans, cabins, improvised homes and homes attached to a shop or office. It also counts private dwellings that were unoccupied that night.

What it shows

Occupied dwellings by structure, each as a count and as a share of all occupied private dwellings, and unoccupied dwellings as a count and a share of all private dwellings. Counts and shares are separate fields (for example separate_house_count and separate_house_pct). Group totals (semi_detached, flat_or_apartment, other_dwelling) equal the sum of their parts within randomisation noise.

Why use it

Dwelling mix decides what you can buy or rent in a suburb and how dense it feels. Use it to find suburbs of mostly houses or mostly high-rise, to judge how much townhouse or apartment stock there is, to compare a suburb with its council area, to size the market for strata, building or removal services, or to spot holiday areas with many homes empty on a winter night.

How it is built

Structure shares use occupied private dwellings as the base. The unoccupied share uses all private dwellings, occupied and unoccupied; unoccupied means nobody was home on the night (holiday homes, homes for sale or rent, homes being renovated), not long-term vacancy. Areas with fewer than 20 dwellings in a base are left out of that part. 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 the area then, not today. To protect privacy the source lightly randomises small numbers, so a count of 0, 3 or 6 can be approximate and shares in small areas jump around: check the base field before trusting a percentage. Shares are rounded to two decimals and capped at 100.

Fields

Field	Unit	Description
`total_occupied_dwellings` Occupied private dwellings	dwellings	Occupied private dwellings in the area, the base for the structure shares.
`separate_house_count` Separate house	dwellings	Number of occupied private dwellings in the area that are: Separate house (2021 snapshot). Small counts are lightly randomised for privacy.
`separate_house_pct` Separate house: share of occupied private dwellings	%	Separate house as a percent of all occupied private dwellings in the area.
`semi_detached_count` Semi-detached, row or terrace house, townhouse (all)	dwellings	Number of occupied private dwellings in the area that are: Semi-detached, row or terrace house, townhouse (all) (2021 snapshot). Small counts are lightly randomised for privacy.
`semi_detached_pct` Semi-detached, row or terrace house, townhouse (all): share of occupied private dwellings	%	Semi-detached, row or terrace house, townhouse (all) as a percent of all occupied private dwellings in the area.
`semi_detached_one_storey_count` Semi-detached, row or terrace house, townhouse, one storey	dwellings	Number of occupied private dwellings in the area that are: Semi-detached, row or terrace house, townhouse, one storey (2021 snapshot). Small counts are lightly randomised for privacy.
`semi_detached_one_storey_pct` Semi-detached, row or terrace house, townhouse, one storey: share of occupied private dwellings	%	Semi-detached, row or terrace house, townhouse, one storey as a percent of all occupied private dwellings in the area.
`semi_detached_two_plus_storeys_count` Semi-detached, row or terrace house, townhouse, two or more storeys	dwellings	Number of occupied private dwellings in the area that are: Semi-detached, row or terrace house, townhouse, two or more storeys (2021 snapshot). Small counts are lightly randomised for privacy.
`semi_detached_two_plus_storeys_pct` Semi-detached, row or terrace house, townhouse, two or more storeys: share of occupied private dwellings	%	Semi-detached, row or terrace house, townhouse, two or more storeys as a percent of all occupied private dwellings in the area.
`flat_or_apartment_count` Flat or apartment (all)	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment (all) (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_or_apartment_pct` Flat or apartment (all): share of occupied private dwellings	%	Flat or apartment (all) as a percent of all occupied private dwellings in the area.
`flat_one_or_two_storey_block_count` Flat or apartment in a one or two storey block	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment in a one or two storey block (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_one_or_two_storey_block_pct` Flat or apartment in a one or two storey block: share of occupied private dwellings	%	Flat or apartment in a one or two storey block as a percent of all occupied private dwellings in the area.
`flat_three_storey_block_count` Flat or apartment in a three storey block	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment in a three storey block (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_three_storey_block_pct` Flat or apartment in a three storey block: share of occupied private dwellings	%	Flat or apartment in a three storey block as a percent of all occupied private dwellings in the area.
`flat_four_to_eight_storey_block_count` Flat or apartment in a four to eight storey block	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment in a four to eight storey block (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_four_to_eight_storey_block_pct` Flat or apartment in a four to eight storey block: share of occupied private dwellings	%	Flat or apartment in a four to eight storey block as a percent of all occupied private dwellings in the area.
`flat_nine_plus_storey_block_count` Flat or apartment in a nine or more storey block	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment in a nine or more storey block (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_nine_plus_storey_block_pct` Flat or apartment in a nine or more storey block: share of occupied private dwellings	%	Flat or apartment in a nine or more storey block as a percent of all occupied private dwellings in the area.
`flat_attached_to_house_count` Flat or apartment attached to a house	dwellings	Number of occupied private dwellings in the area that are: Flat or apartment attached to a house (2021 snapshot). Small counts are lightly randomised for privacy.
`flat_attached_to_house_pct` Flat or apartment attached to a house: share of occupied private dwellings	%	Flat or apartment attached to a house as a percent of all occupied private dwellings in the area.
`other_dwelling_count` Other dwelling (all)	dwellings	Number of occupied private dwellings in the area that are: Other dwelling (all) (2021 snapshot). Small counts are lightly randomised for privacy.
`other_dwelling_pct` Other dwelling (all): share of occupied private dwellings	%	Other dwelling (all) as a percent of all occupied private dwellings in the area.
`caravan_count` Caravan	dwellings	Number of occupied private dwellings in the area that are: Caravan (2021 snapshot). Small counts are lightly randomised for privacy.
`caravan_pct` Caravan: share of occupied private dwellings	%	Caravan as a percent of all occupied private dwellings in the area.
`cabin_or_houseboat_count` Cabin or houseboat	dwellings	Number of occupied private dwellings in the area that are: Cabin or houseboat (2021 snapshot). Small counts are lightly randomised for privacy.
`cabin_or_houseboat_pct` Cabin or houseboat: share of occupied private dwellings	%	Cabin or houseboat as a percent of all occupied private dwellings in the area.
`improvised_home_or_tent_count` Improvised home, tent or sleepers out	dwellings	Number of occupied private dwellings in the area that are: Improvised home, tent or sleepers out (2021 snapshot). Small counts are lightly randomised for privacy.
`improvised_home_or_tent_pct` Improvised home, tent or sleepers out: share of occupied private dwellings	%	Improvised home, tent or sleepers out as a percent of all occupied private dwellings in the area.
`attached_to_shop_or_office_count` House or flat attached to a shop, office or similar	dwellings	Number of occupied private dwellings in the area that are: House or flat attached to a shop, office or similar (2021 snapshot). Small counts are lightly randomised for privacy.
`attached_to_shop_or_office_pct` House or flat attached to a shop, office or similar: share of occupied private dwellings	%	House or flat attached to a shop, office or similar as a percent of all occupied private dwellings in the area.
`structure_not_stated_count` Dwelling structure not stated	dwellings	Number of occupied private dwellings in the area that are: Dwelling structure not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`structure_not_stated_pct` Dwelling structure not stated: share of occupied private dwellings	%	Dwelling structure not stated as a percent of all occupied private dwellings in the area.
`total_private_dwellings` Private dwellings (occupied and unoccupied)	dwellings	All private dwellings in the area, occupied or not, the base for the unoccupied share.
`unoccupied_count` Unoccupied on the night	dwellings	Number of private dwellings in the area that were: Unoccupied on the night (2021 snapshot). Small counts are lightly randomised for privacy.
`unoccupied_pct` Unoccupied on the night: share of all private dwellings	%	Unoccupied on the night as a percent of all all private dwellings in the area.