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

Microburbs Property Data API

Suburb - Area Statistics

Ancestry

GET/v1/suburbs/{suburb_name}/area-stats/ancestry5¢ per call

Where each ancestry group lives: counts and shares for 29 ancestries (English, Irish, Chinese, Indian, Lebanese and more) in every suburb and council area.

Coverage: About 11,000 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/ancestry.

Exact suburb identifier required. Exact official suburb name (SAL), e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

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

suburb_namestringrequired

Exact official suburb name (SAL), e.g. `Burwood (NSW)` — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call `GET /v1/geocode/suburb?q=<text>`, then use the exact `data[].area_name` it returns. Suburb data endpoints do not guess a state or typo-correct names.

Query parameters

fieldsstringoptional

Comma-separated subset of: total_population, australian_count, australian_pct, aboriginal_count, aboriginal_pct, english_count, english_pct, irish_count, irish_pct, scottish_count, scottish_pct, welsh_count, welsh_pct, german_count, german_pct, dutch_count, dutch_pct, french_count, french_pct, italian_count, italian_pct, greek_count, greek_pct, maltese_count, maltese_pct, spanish_count, spanish_pct, polish_count, polish_pct, russian_count, russian_pct, hungarian_count, hungarian_pct, croatian_count, croatian_pct, serbian_count, serbian_pct, macedonian_count, macedonian_pct, chinese_count, chinese_pct, indian_count, indian_pct, filipino_count, filipino_pct, vietnamese_count, vietnamese_pct, korean_count, korean_pct, sri_lankan_count, sri_lankan_pct, lebanese_count, lebanese_pct, south_african_count, south_african_pct, new_zealander_count, new_zealander_pct, maori_count, maori_pct, samoan_count, samoan_pct, other_ancestry_count, other_ancestry_pct, not_stated_count, not_stated_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/suburbs/{suburb_name}/area-stats/ancestry

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/area-stats/ancestry' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "dataset": "ancestry",
    "level": "suburb",
    "area": "Bondi",
    "period_type": "snapshot",
    "as_of": "2021-08-10",
    "modelled": false,
    "fields": [
      {
        "field": "total_population",
        "name": "Total residents",
        "unit": "persons",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 10411
          }
        ]
      },
      {
        "field": "australian_count",
        "name": "Australian: residents",
        "unit": "persons",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 1948
          }
        ]
      },
      {
        "field": "australian_pct",
        "name": "Australian: share of residents",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 18.71
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

About 11,000 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 ancestries residents reported on 10 August 2021, for every suburb and council area. People could give up to two ancestries, so each ancestry is the number of residents who named it at all. There are 29 named ancestries plus other and not stated, each as a head-count and a share of residents.

What it shows

Residents by ancestry (for example chinese_count, chinese_pct, lebanese_pct) and the total number of residents. Because a person can name two ancestries, the shares add to more than 100 percent.

Why use it

Ancestry shows where communities are concentrated, which drives language needs, cultural events, specialist retail and food, community services and marketing. Use it to answer "where do Greek, Vietnamese, Indian or Italian Australians live", to build a heat map by ancestry, or to enrich a suburb profile. For where residents were born see birthplace; for languages at home see languages.

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. Ancestry is self-described and multi-response, so it differs from birthplace: an Australian-born resident can have Greek ancestry. The long tail of smaller ancestries is grouped under other_ancestry, so shares for the 29 named groups can sit below the true diversity of an area.

Fields

Field	Unit	Description
`total_population` Total residents	persons	All residents counted in the area on 10 August 2021, the base for every share in this dataset.
`australian_count` Australian: residents	persons	Number of residents who gave Australian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`australian_pct` Australian: share of residents	%	Residents giving Australian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`aboriginal_count` Australian Aboriginal: residents	persons	Number of residents who gave Australian Aboriginal as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`aboriginal_pct` Australian Aboriginal: share of residents	%	Residents giving Australian Aboriginal ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`english_count` English: residents	persons	Number of residents who gave English as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`english_pct` English: share of residents	%	Residents giving English ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`irish_count` Irish: residents	persons	Number of residents who gave Irish as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`irish_pct` Irish: share of residents	%	Residents giving Irish ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`scottish_count` Scottish: residents	persons	Number of residents who gave Scottish as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`scottish_pct` Scottish: share of residents	%	Residents giving Scottish ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`welsh_count` Welsh: residents	persons	Number of residents who gave Welsh as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`welsh_pct` Welsh: share of residents	%	Residents giving Welsh ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`german_count` German: residents	persons	Number of residents who gave German as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`german_pct` German: share of residents	%	Residents giving German ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`dutch_count` Dutch: residents	persons	Number of residents who gave Dutch as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`dutch_pct` Dutch: share of residents	%	Residents giving Dutch ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`french_count` French: residents	persons	Number of residents who gave French as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`french_pct` French: share of residents	%	Residents giving French ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`italian_count` Italian: residents	persons	Number of residents who gave Italian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`italian_pct` Italian: share of residents	%	Residents giving Italian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`greek_count` Greek: residents	persons	Number of residents who gave Greek as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`greek_pct` Greek: share of residents	%	Residents giving Greek ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`maltese_count` Maltese: residents	persons	Number of residents who gave Maltese as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`maltese_pct` Maltese: share of residents	%	Residents giving Maltese ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`spanish_count` Spanish: residents	persons	Number of residents who gave Spanish as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`spanish_pct` Spanish: share of residents	%	Residents giving Spanish ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`polish_count` Polish: residents	persons	Number of residents who gave Polish as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`polish_pct` Polish: share of residents	%	Residents giving Polish ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`russian_count` Russian: residents	persons	Number of residents who gave Russian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`russian_pct` Russian: share of residents	%	Residents giving Russian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`hungarian_count` Hungarian: residents	persons	Number of residents who gave Hungarian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`hungarian_pct` Hungarian: share of residents	%	Residents giving Hungarian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`croatian_count` Croatian: residents	persons	Number of residents who gave Croatian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`croatian_pct` Croatian: share of residents	%	Residents giving Croatian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`serbian_count` Serbian: residents	persons	Number of residents who gave Serbian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`serbian_pct` Serbian: share of residents	%	Residents giving Serbian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`macedonian_count` Macedonian: residents	persons	Number of residents who gave Macedonian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`macedonian_pct` Macedonian: share of residents	%	Residents giving Macedonian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`chinese_count` Chinese: residents	persons	Number of residents who gave Chinese as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`chinese_pct` Chinese: share of residents	%	Residents giving Chinese ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`indian_count` Indian: residents	persons	Number of residents who gave Indian as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`indian_pct` Indian: share of residents	%	Residents giving Indian ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`filipino_count` Filipino: residents	persons	Number of residents who gave Filipino as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`filipino_pct` Filipino: share of residents	%	Residents giving Filipino ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`vietnamese_count` Vietnamese: residents	persons	Number of residents who gave Vietnamese as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`vietnamese_pct` Vietnamese: share of residents	%	Residents giving Vietnamese ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`korean_count` Korean: residents	persons	Number of residents who gave Korean as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`korean_pct` Korean: share of residents	%	Residents giving Korean ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`sri_lankan_count` Sri Lankan: residents	persons	Number of residents who gave Sri Lankan as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`sri_lankan_pct` Sri Lankan: share of residents	%	Residents giving Sri Lankan ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`lebanese_count` Lebanese: residents	persons	Number of residents who gave Lebanese as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`lebanese_pct` Lebanese: share of residents	%	Residents giving Lebanese ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`south_african_count` South African: residents	persons	Number of residents who gave South African as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`south_african_pct` South African: share of residents	%	Residents giving South African ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`new_zealander_count` New Zealander: residents	persons	Number of residents who gave New Zealander as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`new_zealander_pct` New Zealander: share of residents	%	Residents giving New Zealander ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`maori_count` Maori: residents	persons	Number of residents who gave Maori as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`maori_pct` Maori: share of residents	%	Residents giving Maori ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`samoan_count` Samoan: residents	persons	Number of residents who gave Samoan as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`samoan_pct` Samoan: share of residents	%	Residents giving Samoan ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`other_ancestry_count` Other ancestry (not listed separately): residents	persons	Number of residents who gave Other ancestry (not listed separately) as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`other_ancestry_pct` Other ancestry (not listed separately): share of residents	%	Residents giving Other ancestry (not listed separately) ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.
`not_stated_count` Ancestry not stated: residents	persons	Number of residents who gave Ancestry not stated as one of their (up to two) ancestries (2021 snapshot). People with two ancestries are counted in both, so groups overlap and do not add to the population. Small counts are lightly randomised for privacy.
`not_stated_pct` Ancestry not stated: share of residents	%	Residents giving Ancestry not stated ancestry as a percent of all residents. Because each person can give two answers, shares across ancestries add to more than 100%.