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

Bedrooms

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

How many bedrooms homes have: studios through six or more, for all dwellings and separately for houses, townhouses and apartments, plus people per bedroom, for every suburb and council area.

Coverage: About 10,700 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/bedrooms.

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, studio_count, studio_pct, one_bedroom_count, one_bedroom_pct, two_bedrooms_count, two_bedrooms_pct, three_bedrooms_count, three_bedrooms_pct, four_bedrooms_count, four_bedrooms_pct, five_bedrooms_count, five_bedrooms_pct, six_plus_bedrooms_count, six_plus_bedrooms_pct, bedrooms_not_stated_count, bedrooms_not_stated_pct, total_house, house_studio_count, house_studio_pct, house_one_bedroom_count, house_one_bedroom_pct, house_two_bedrooms_count, house_two_bedrooms_pct, house_three_bedrooms_count, house_three_bedrooms_pct, house_four_bedrooms_count, house_four_bedrooms_pct, house_five_bedrooms_count, house_five_bedrooms_pct, house_six_plus_bedrooms_count, house_six_plus_bedrooms_pct, house_bedrooms_not_stated_count, house_bedrooms_not_stated_pct, total_townhouse, townhouse_studio_count, townhouse_studio_pct, townhouse_one_bedroom_count, townhouse_one_bedroom_pct, townhouse_two_bedrooms_count, townhouse_two_bedrooms_pct, townhouse_three_bedrooms_count, townhouse_three_bedrooms_pct, townhouse_four_bedrooms_count, townhouse_four_bedrooms_pct, townhouse_five_bedrooms_count, townhouse_five_bedrooms_pct, townhouse_six_plus_bedrooms_count, townhouse_six_plus_bedrooms_pct, townhouse_bedrooms_not_stated_count, townhouse_bedrooms_not_stated_pct, total_apartment, apartment_studio_count, apartment_studio_pct, apartment_one_bedroom_count, apartment_one_bedroom_pct, apartment_two_bedrooms_count, apartment_two_bedrooms_pct, apartment_three_bedrooms_count, apartment_three_bedrooms_pct, apartment_four_bedrooms_count, apartment_four_bedrooms_pct, apartment_five_bedrooms_count, apartment_five_bedrooms_pct, apartment_six_plus_bedrooms_count, apartment_six_plus_bedrooms_pct, apartment_bedrooms_not_stated_count, apartment_bedrooms_not_stated_pct, persons_per_bedroom. 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/bedrooms

cURL

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

Example Responses

Show schema

{
  "data": {
    "dataset": "bedrooms",
    "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": "studio_count",
        "name": "No bedrooms (studio or bedsitter)",
        "unit": "dwellings",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 598
          }
        ]
      },
      {
        "field": "studio_pct",
        "name": "No bedrooms (studio or bedsitter): share of occupied private dwellings",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 2.18
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

About 10,700 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 number of bedrooms in occupied private dwellings on 10 August 2021, for every suburb and council area: all dwellings together, then separate houses, semi-detached and townhouses, and flats and apartments on their own. The average number of residents per bedroom shows how crowded homes are.

What it shows

Dwellings with no bedrooms (studios) through six or more, plus not stated, each as a count and as a share of the dwellings of that type. Fields for all dwellings have no prefix (three_bedrooms_count); fields for one type carry its prefix (house_three_bedrooms_count, townhouse_two_bedrooms_pct, apartment_one_bedroom_pct). persons_per_bedroom is the average across the area's occupied dwellings.

Why use it

Bedroom mix tells you what an area can house: families need three or more, singles and couples want one or two. Use it to find suburbs with plenty of one-bedroom apartments or large family homes, to judge how scarce four-bedroom houses are, to compare apartment sizes between suburbs, to spot overcrowding, or to add a housing-stock profile to a suburb report. For prices by bedroom see the market endpoints.

How it is built

Shares use the occupied private dwellings of that type as the base, so each set adds to about 100. Townhouse fields cover semi-detached, row and terrace houses and townhouses of any height; apartment fields cover flats and apartments of every block height. Areas with fewer than 20 dwellings of a type are left out of that set, and persons_per_bedroom needs at least 20 occupied dwellings. 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 all-dwelling bedroom shares.
`studio_count` No bedrooms (studio or bedsitter)	dwellings	Number of occupied private dwellings in the area with: No bedrooms (studio or bedsitter) (2021 snapshot). Small counts are lightly randomised for privacy.
`studio_pct` No bedrooms (studio or bedsitter): share of occupied private dwellings	%	No bedrooms (studio or bedsitter) as a percent of all occupied private dwellings in the area.
`one_bedroom_count` One bedroom	dwellings	Number of occupied private dwellings in the area with: One bedroom (2021 snapshot). Small counts are lightly randomised for privacy.
`one_bedroom_pct` One bedroom: share of occupied private dwellings	%	One bedroom as a percent of all occupied private dwellings in the area.
`two_bedrooms_count` Two bedrooms	dwellings	Number of occupied private dwellings in the area with: Two bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`two_bedrooms_pct` Two bedrooms: share of occupied private dwellings	%	Two bedrooms as a percent of all occupied private dwellings in the area.
`three_bedrooms_count` Three bedrooms	dwellings	Number of occupied private dwellings in the area with: Three bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`three_bedrooms_pct` Three bedrooms: share of occupied private dwellings	%	Three bedrooms as a percent of all occupied private dwellings in the area.
`four_bedrooms_count` Four bedrooms	dwellings	Number of occupied private dwellings in the area with: Four bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`four_bedrooms_pct` Four bedrooms: share of occupied private dwellings	%	Four bedrooms as a percent of all occupied private dwellings in the area.
`five_bedrooms_count` Five bedrooms	dwellings	Number of occupied private dwellings in the area with: Five bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`five_bedrooms_pct` Five bedrooms: share of occupied private dwellings	%	Five bedrooms as a percent of all occupied private dwellings in the area.
`six_plus_bedrooms_count` Six or more bedrooms	dwellings	Number of occupied private dwellings in the area with: Six or more bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`six_plus_bedrooms_pct` Six or more bedrooms: share of occupied private dwellings	%	Six or more bedrooms as a percent of all occupied private dwellings in the area.
`bedrooms_not_stated_count` Bedrooms not stated	dwellings	Number of occupied private dwellings in the area with: Bedrooms not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`bedrooms_not_stated_pct` Bedrooms not stated: share of occupied private dwellings	%	Bedrooms not stated as a percent of all occupied private dwellings in the area.
`total_house` Occupied separate houses	dwellings	Occupied separate houses in the area, the base for the house bedroom shares.
`house_studio_count` No bedrooms (studio or bedsitter)	dwellings	Number of occupied separate houses in the area with: No bedrooms (studio or bedsitter) (2021 snapshot). Small counts are lightly randomised for privacy.
`house_studio_pct` No bedrooms (studio or bedsitter): share of occupied separate houses	%	No bedrooms (studio or bedsitter) as a percent of all occupied separate houses in the area.
`house_one_bedroom_count` One bedroom	dwellings	Number of occupied separate houses in the area with: One bedroom (2021 snapshot). Small counts are lightly randomised for privacy.
`house_one_bedroom_pct` One bedroom: share of occupied separate houses	%	One bedroom as a percent of all occupied separate houses in the area.
`house_two_bedrooms_count` Two bedrooms	dwellings	Number of occupied separate houses in the area with: Two bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`house_two_bedrooms_pct` Two bedrooms: share of occupied separate houses	%	Two bedrooms as a percent of all occupied separate houses in the area.
`house_three_bedrooms_count` Three bedrooms	dwellings	Number of occupied separate houses in the area with: Three bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`house_three_bedrooms_pct` Three bedrooms: share of occupied separate houses	%	Three bedrooms as a percent of all occupied separate houses in the area.
`house_four_bedrooms_count` Four bedrooms	dwellings	Number of occupied separate houses in the area with: Four bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`house_four_bedrooms_pct` Four bedrooms: share of occupied separate houses	%	Four bedrooms as a percent of all occupied separate houses in the area.
`house_five_bedrooms_count` Five bedrooms	dwellings	Number of occupied separate houses in the area with: Five bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`house_five_bedrooms_pct` Five bedrooms: share of occupied separate houses	%	Five bedrooms as a percent of all occupied separate houses in the area.
`house_six_plus_bedrooms_count` Six or more bedrooms	dwellings	Number of occupied separate houses in the area with: Six or more bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`house_six_plus_bedrooms_pct` Six or more bedrooms: share of occupied separate houses	%	Six or more bedrooms as a percent of all occupied separate houses in the area.
`house_bedrooms_not_stated_count` Bedrooms not stated	dwellings	Number of occupied separate houses in the area with: Bedrooms not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`house_bedrooms_not_stated_pct` Bedrooms not stated: share of occupied separate houses	%	Bedrooms not stated as a percent of all occupied separate houses in the area.
`total_townhouse` Occupied semi-detached, row or terrace houses and townhouses	dwellings	Occupied semi-detached, row or terrace houses and townhouses in the area, the base for the townhouse bedroom shares.
`townhouse_studio_count` No bedrooms (studio or bedsitter)	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: No bedrooms (studio or bedsitter) (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_studio_pct` No bedrooms (studio or bedsitter): share of occupied semi-detached, row or terrace houses and townhouses	%	No bedrooms (studio or bedsitter) as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_one_bedroom_count` One bedroom	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: One bedroom (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_one_bedroom_pct` One bedroom: share of occupied semi-detached, row or terrace houses and townhouses	%	One bedroom as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_two_bedrooms_count` Two bedrooms	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Two bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_two_bedrooms_pct` Two bedrooms: share of occupied semi-detached, row or terrace houses and townhouses	%	Two bedrooms as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_three_bedrooms_count` Three bedrooms	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Three bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_three_bedrooms_pct` Three bedrooms: share of occupied semi-detached, row or terrace houses and townhouses	%	Three bedrooms as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_four_bedrooms_count` Four bedrooms	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Four bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_four_bedrooms_pct` Four bedrooms: share of occupied semi-detached, row or terrace houses and townhouses	%	Four bedrooms as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_five_bedrooms_count` Five bedrooms	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Five bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_five_bedrooms_pct` Five bedrooms: share of occupied semi-detached, row or terrace houses and townhouses	%	Five bedrooms as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_six_plus_bedrooms_count` Six or more bedrooms	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Six or more bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_six_plus_bedrooms_pct` Six or more bedrooms: share of occupied semi-detached, row or terrace houses and townhouses	%	Six or more bedrooms as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`townhouse_bedrooms_not_stated_count` Bedrooms not stated	dwellings	Number of occupied semi-detached, row or terrace houses and townhouses in the area with: Bedrooms not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`townhouse_bedrooms_not_stated_pct` Bedrooms not stated: share of occupied semi-detached, row or terrace houses and townhouses	%	Bedrooms not stated as a percent of all occupied semi-detached, row or terrace houses and townhouses in the area.
`total_apartment` Occupied flats and apartments	dwellings	Occupied flats and apartments in the area, the base for the apartment bedroom shares.
`apartment_studio_count` No bedrooms (studio or bedsitter)	dwellings	Number of occupied flats and apartments in the area with: No bedrooms (studio or bedsitter) (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_studio_pct` No bedrooms (studio or bedsitter): share of occupied flats and apartments	%	No bedrooms (studio or bedsitter) as a percent of all occupied flats and apartments in the area.
`apartment_one_bedroom_count` One bedroom	dwellings	Number of occupied flats and apartments in the area with: One bedroom (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_one_bedroom_pct` One bedroom: share of occupied flats and apartments	%	One bedroom as a percent of all occupied flats and apartments in the area.
`apartment_two_bedrooms_count` Two bedrooms	dwellings	Number of occupied flats and apartments in the area with: Two bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_two_bedrooms_pct` Two bedrooms: share of occupied flats and apartments	%	Two bedrooms as a percent of all occupied flats and apartments in the area.
`apartment_three_bedrooms_count` Three bedrooms	dwellings	Number of occupied flats and apartments in the area with: Three bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_three_bedrooms_pct` Three bedrooms: share of occupied flats and apartments	%	Three bedrooms as a percent of all occupied flats and apartments in the area.
`apartment_four_bedrooms_count` Four bedrooms	dwellings	Number of occupied flats and apartments in the area with: Four bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_four_bedrooms_pct` Four bedrooms: share of occupied flats and apartments	%	Four bedrooms as a percent of all occupied flats and apartments in the area.
`apartment_five_bedrooms_count` Five bedrooms	dwellings	Number of occupied flats and apartments in the area with: Five bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_five_bedrooms_pct` Five bedrooms: share of occupied flats and apartments	%	Five bedrooms as a percent of all occupied flats and apartments in the area.
`apartment_six_plus_bedrooms_count` Six or more bedrooms	dwellings	Number of occupied flats and apartments in the area with: Six or more bedrooms (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_six_plus_bedrooms_pct` Six or more bedrooms: share of occupied flats and apartments	%	Six or more bedrooms as a percent of all occupied flats and apartments in the area.
`apartment_bedrooms_not_stated_count` Bedrooms not stated	dwellings	Number of occupied flats and apartments in the area with: Bedrooms not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`apartment_bedrooms_not_stated_pct` Bedrooms not stated: share of occupied flats and apartments	%	Bedrooms not stated as a percent of all occupied flats and apartments in the area.
`persons_per_bedroom` Average residents per bedroom	persons	Average number of residents per bedroom across the area's occupied private dwellings (2021 snapshot); above 1 suggests crowded homes.