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

Year of arrival

GET/v1/lga/{lga_name}/area-stats/year-of-arrival5¢ per call

When overseas-born residents arrived in Australia: from before 1951 to 2021, with a recent-arrivals total, for every suburb and council area.

Coverage: About 5,200 suburbs and localities and 505 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/year-of-arrival.

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_born_overseas, arrived_2016_to_2021_count, arrived_2016_to_2021_pct, arrived_before_1951_count, arrived_before_1951_pct, arrived_1951_1960_count, arrived_1951_1960_pct, arrived_1961_1970_count, arrived_1961_1970_pct, arrived_1971_1980_count, arrived_1971_1980_pct, arrived_1981_1990_count, arrived_1981_1990_pct, arrived_1991_2000_count, arrived_1991_2000_pct, arrived_2001_2010_count, arrived_2001_2010_pct, arrived_2011_2015_count, arrived_2011_2015_pct, arrived_2016_count, arrived_2016_pct, arrived_2017_count, arrived_2017_pct, arrived_2018_count, arrived_2018_pct, arrived_2019_count, arrived_2019_pct, arrived_2020_count, arrived_2020_pct, arrived_2021_count, arrived_2021_pct, arrived_not_stated_count, arrived_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/lga/{lga_name}/area-stats/year-of-arrival

cURL

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

Example Responses

Show schema

{
  "data": {
    "dataset": "year-of-arrival",
    "level": "lga",
    "area": "Waverley",
    "period_type": "snapshot",
    "as_of": "2021-08-10",
    "modelled": false,
    "fields": [
      {
        "field": "total_born_overseas",
        "name": "Residents born overseas",
        "unit": "persons",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 28581
          }
        ]
      },
      {
        "field": "arrived_2016_to_2021_count",
        "name": "2016 to 2021 (recent arrivals)",
        "unit": "persons",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 7979
          }
        ]
      },
      {
        "field": "arrived_2016_to_2021_pct",
        "name": "2016 to 2021 (recent arrivals): share of residents born overseas",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 27.92
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

About 5,200 suburbs and localities and 505 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 year residents born overseas first arrived in Australia to live, as it stood on 10 August 2021, for every suburb and council area: decades up to 2010, then 2011 to 2015, then each year from 2016 to 2021, with a total for arrivals from 2016 on.

What it shows

Overseas-born residents by period of arrival, each as a head-count and as a share of all overseas-born residents, plus the total overseas-born. Counts and shares are separate fields (for example arrived_2011_2015_count and arrived_2011_2015_pct).

Why use it

Arrival year separates long-settled migrant suburbs from new arrival hubs. Use it to find where recent migrants and international students settle, to plan settlement, language and community services, to see how a suburb's migrant population has changed over generations, or to add a migration profile to a suburb report. For where residents were born see birthplace.

How it is built

The base is residents born overseas (people born in Australia are not in it). 2021 covers only the months before 10 August, during closed international borders, and 2020 is also low for that reason. arrived_2016_to_2021 adds 2016 through 2021. Areas with fewer than 50 overseas-born residents are left out. 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_born_overseas` Residents born overseas	persons	Residents born outside Australia, the base for every share.
`arrived_2016_to_2021_count` 2016 to 2021 (recent arrivals)	persons	Number of overseas-born residents in the area who arrived: 2016 to 2021 (recent arrivals) (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2016_to_2021_pct` 2016 to 2021 (recent arrivals): share of residents born overseas	%	2016 to 2021 (recent arrivals) as a percent of all residents born overseas in the area.
`arrived_before_1951_count` Before 1951	persons	Number of overseas-born residents in the area who arrived: Before 1951 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_before_1951_pct` Before 1951: share of residents born overseas	%	Before 1951 as a percent of all residents born overseas in the area.
`arrived_1951_1960_count` 1951 to 1960	persons	Number of overseas-born residents in the area who arrived: 1951 to 1960 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_1951_1960_pct` 1951 to 1960: share of residents born overseas	%	1951 to 1960 as a percent of all residents born overseas in the area.
`arrived_1961_1970_count` 1961 to 1970	persons	Number of overseas-born residents in the area who arrived: 1961 to 1970 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_1961_1970_pct` 1961 to 1970: share of residents born overseas	%	1961 to 1970 as a percent of all residents born overseas in the area.
`arrived_1971_1980_count` 1971 to 1980	persons	Number of overseas-born residents in the area who arrived: 1971 to 1980 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_1971_1980_pct` 1971 to 1980: share of residents born overseas	%	1971 to 1980 as a percent of all residents born overseas in the area.
`arrived_1981_1990_count` 1981 to 1990	persons	Number of overseas-born residents in the area who arrived: 1981 to 1990 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_1981_1990_pct` 1981 to 1990: share of residents born overseas	%	1981 to 1990 as a percent of all residents born overseas in the area.
`arrived_1991_2000_count` 1991 to 2000	persons	Number of overseas-born residents in the area who arrived: 1991 to 2000 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_1991_2000_pct` 1991 to 2000: share of residents born overseas	%	1991 to 2000 as a percent of all residents born overseas in the area.
`arrived_2001_2010_count` 2001 to 2010	persons	Number of overseas-born residents in the area who arrived: 2001 to 2010 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2001_2010_pct` 2001 to 2010: share of residents born overseas	%	2001 to 2010 as a percent of all residents born overseas in the area.
`arrived_2011_2015_count` 2011 to 2015	persons	Number of overseas-born residents in the area who arrived: 2011 to 2015 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2011_2015_pct` 2011 to 2015: share of residents born overseas	%	2011 to 2015 as a percent of all residents born overseas in the area.
`arrived_2016_count` 2016	persons	Number of overseas-born residents in the area who arrived: 2016 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2016_pct` 2016: share of residents born overseas	%	2016 as a percent of all residents born overseas in the area.
`arrived_2017_count` 2017	persons	Number of overseas-born residents in the area who arrived: 2017 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2017_pct` 2017: share of residents born overseas	%	2017 as a percent of all residents born overseas in the area.
`arrived_2018_count` 2018	persons	Number of overseas-born residents in the area who arrived: 2018 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2018_pct` 2018: share of residents born overseas	%	2018 as a percent of all residents born overseas in the area.
`arrived_2019_count` 2019	persons	Number of overseas-born residents in the area who arrived: 2019 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2019_pct` 2019: share of residents born overseas	%	2019 as a percent of all residents born overseas in the area.
`arrived_2020_count` 2020	persons	Number of overseas-born residents in the area who arrived: 2020 (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2020_pct` 2020: share of residents born overseas	%	2020 as a percent of all residents born overseas in the area.
`arrived_2021_count` 2021 (to 10 August)	persons	Number of overseas-born residents in the area who arrived: 2021 (to 10 August) (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_2021_pct` 2021 (to 10 August): share of residents born overseas	%	2021 (to 10 August) as a percent of all residents born overseas in the area.
`arrived_not_stated_count` Not stated	persons	Number of overseas-born residents in the area who arrived: Not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`arrived_not_stated_pct` Not stated: share of residents born overseas	%	Not stated as a percent of all residents born overseas in the area.