Postcode profile
/v1/postcodes/{postcode}/demographics/profile5¢ per callOne-call profile of a postcode: how many suburbs it covers, population, dwellings, median age and incomes, rents, mortgages, and the mix of houses, flats and renters.
Coverage: All 2,642 postcodes we map to suburbs; population figures as at 2021-08-10. Current to 2021-08-10. Full description, field list and method: /v1/datasets/postcode-profile.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
postcodestringrequiredFour-digit postcode, e.g. `2026`.
Query parameters
fieldsstringoptionalComma-separated subset of: suburbs_count, population, private_dwellings, occupied_private_dwellings, median_age, average_household_size, median_household_income_weekly, median_personal_income_weekly, median_rent_weekly, median_mortgage_repayment_monthly, rented_share_pct, separate_house_share_pct, flat_apartment_share_pct. Omit for all.
fromstringoptionalFirst period to include: 2020, 2020-Q3, 2020-07 or 2020-07-01.
tostringoptionalLast period to include, same formats as `from`.
Responses
Successful Response
datasetstringalways returnedDataset slug; describe it with /v1/datasets/{slug}.
levelstringalways returnedsuburb, lga or block.
areastringalways returnedCanonical name (or mesh-block code) of the area answered.
period_typestringalways returnedsnapshot, year, financial_year, quarter or month.
as_ofstring · datealways returnedDate the dataset is current to. Values are never withheld for age; check this instead.
modelledbooleanalways returnedTrue when the figures are estimates from a model rather than counts or measurements.
fieldsarray of DatasetFieldSeriesalways returned/v1/postcodes/{postcode}/demographics/profilecurl --request GET \
--url 'https://api.microburbs.com.au/v1/postcodes/2280/demographics/profile' \
--header 'Authorization: Bearer test'{
"data": {
"dataset": "postcode-profile",
"level": "postcode",
"area": "2000",
"period_type": "snapshot",
"as_of": "2021-08-10",
"modelled": false,
"fields": [
{
"field": "suburbs_count",
"name": "Suburbs in the postcode",
"unit": "count",
"values": [
{
"period": "2021-08-10",
"period_start": "2021-08-10",
"value": 6
}
]
},
{
"field": "population",
"name": "Population",
"unit": "persons",
"values": [
{
"period": "2021-08-10",
"period_start": "2021-08-10",
"value": 27936
}
]
},
{
"field": "private_dwellings",
"name": "Private dwellings",
"unit": "count",
"values": [
{
"period": "2021-08-10",
"period_start": "2021-08-10",
"value": 15345
}
]
}
]
}
}About this dataset
All 2,642 postcodes we map to suburbs; population figures as at 2021-08-10. Current to 2021-08-10; refreshed at the next national population count.
What it is
The basic facts about a postcode in one call: how many suburbs it contains, how many people live there, how many homes, and the typical age, household income, rent, mortgage repayment and housing mix.
What it shows
Thirteen values per postcode: suburbs_count, population, private and occupied dwellings, median age, average household size, median household and personal income per week, median weekly rent, median monthly mortgage repayment, and the shares of homes that are rented, separate houses, or flats and apartments. Population and housing figures are as at August 2021; suburbs_count is the current number of our suburbs inside the postcode.
Why use it
Postcode is how most customers and forms identify a place, so this is the first lookup behind a postcode search box or a postcode landing page: what is this area, how big and what kind of housing. Pair it with the taxation, income-distribution and age datasets, which give the same postcode year by year.
How it is built
Postcode areas are the national postcode geography built from the 2021 population count; population figures are adjusted slightly by the producer to protect privacy, so very small postcodes can look odd. Shares are only given where the postcode has at least 20 occupied homes. Medians are left out where the source gave none (very small or non-residential postcodes). A postcode can cover several suburbs and a suburb can sit in more than one postcode.
Fields
| Field | Unit | Description |
|---|---|---|
suburbs_countSuburbs in the postcode | count | Number of our suburbs that sit in the postcode. |
populationPopulation | persons | Usual resident population of the postcode. |
private_dwellingsPrivate dwellings | count | Total private dwellings in the postcode, occupied or not. |
occupied_private_dwellingsOccupied private dwellings | count | Private dwellings with at least one usual resident. |
median_ageMedian age | years | Middle age of residents. |
average_household_sizeAverage household size | persons | Average number of people per household. |
median_household_income_weeklyMedian household income (weekly) | $ | Middle total household income per week, before tax. |
median_personal_income_weeklyMedian personal income (weekly) | $ | Middle total personal income per week of residents aged 15 and over, before tax. |
median_rent_weeklyMedian rent (weekly) | $ | Middle weekly rent paid by renting households. |
median_mortgage_repayment_monthlyMedian mortgage repayment (monthly) | $ | Middle monthly mortgage repayment of households paying off a home. |
rented_share_pctRented share | % | Percent of occupied private dwellings that are rented. |
separate_house_share_pctSeparate house share | % | Percent of occupied private dwellings that are separate houses. |
flat_apartment_share_pctFlat or apartment share | % | Percent of occupied private dwellings that are flats or apartments. |