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

Classic docs

Microburbs Property Data API

Suburb - Area Statistics

Australian citizenship

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

How many residents are Australian citizens, and what share of the area that is, for 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 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/citizenship.

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_citizens_count, australian_citizens_pct, not_citizen_or_not_stated_count, not_citizen_or_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/citizenship

cURL

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

Example Responses

Show schema

{
  "data": {
    "dataset": "citizenship",
    "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_citizens_count",
        "name": "Australian citizens",
        "unit": "persons",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 7252
          }
        ]
      },
      {
        "field": "australian_citizens_pct",
        "name": "Australian citizens: share of residents",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 69.66
          }
        ]
      }
    ]
  }
}

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 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 residents who were Australian citizens on 10 August 2021, for every suburb and council area, against all residents. The remainder are residents who are not citizens (permanent residents, temporary visa holders such as students and workers, and New Zealand citizens) together with those who did not answer.

What it shows

Australian citizens as a head-count and as a share of all residents, the remainder as a count and share, and the total residents. Counts and shares are separate fields (australian_citizens_count and australian_citizens_pct).

Why use it

A low citizenship share marks suburbs with many recent migrants, international students and temporary workers. Use it to find areas where visa and settlement services, migration agents or English classes are needed, to gauge the share of residents who can vote at state and federal elections, or to add a migration profile to a suburb report. Nationally about 84% of residents are citizens. For when overseas-born residents arrived see year-of-arrival.

How it is built

The base is all residents. not_citizen_or_not_stated is the total minus citizens, so it includes residents who did not answer the question. Areas with fewer than 50 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_population` Total residents	persons	All residents counted in the area on 10 August 2021, the base for every share.
`australian_citizens_count` Australian citizens	persons	Number of residents in the area who are: Australian citizens (2021 snapshot). Small counts are lightly randomised for privacy.
`australian_citizens_pct` Australian citizens: share of residents	%	Australian citizens as a percent of all residents in the area.
`not_citizen_or_not_stated_count` Not Australian citizens, or citizenship not stated	persons	Number of residents in the area who are: Not Australian citizens, or citizenship not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`not_citizen_or_not_stated_pct` Not Australian citizens, or citizenship not stated: share of residents	%	Not Australian citizens, or citizenship not stated as a percent of all residents in the area.