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

Mortgage repayments

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

What home-owners with a mortgage pay each month: repayments in 11 bands from under $300 to $4,000 or more, and the median monthly repayment, for every suburb and council area.

Coverage: About 7,200 suburbs and localities and 498 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/mortgage-repayments.

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_mortgaged_households, mortgage_0_299_count, mortgage_0_299_pct, mortgage_300_449_count, mortgage_300_449_pct, mortgage_450_599_count, mortgage_450_599_pct, mortgage_600_799_count, mortgage_600_799_pct, mortgage_800_999_count, mortgage_800_999_pct, mortgage_1000_1399_count, mortgage_1000_1399_pct, mortgage_1400_1799_count, mortgage_1400_1799_pct, mortgage_1800_2399_count, mortgage_1800_2399_pct, mortgage_2400_2999_count, mortgage_2400_2999_pct, mortgage_3000_3999_count, mortgage_3000_3999_pct, mortgage_4000_plus_count, mortgage_4000_plus_pct, mortgage_not_stated_count, mortgage_not_stated_pct, median_mortgage_monthly. 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/mortgage-repayments

cURL

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

Example Responses

Show schema

{
  "data": {
    "dataset": "mortgage-repayments",
    "level": "lga",
    "area": "Waverley",
    "period_type": "snapshot",
    "as_of": "2021-08-10",
    "modelled": false,
    "fields": [
      {
        "field": "total_mortgaged_households",
        "name": "Households with a mortgage",
        "unit": "households",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 6542
          }
        ]
      },
      {
        "field": "mortgage_0_299_count",
        "name": "$0 to $299 a month",
        "unit": "households",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 388
          }
        ]
      },
      {
        "field": "mortgage_0_299_pct",
        "name": "$0 to $299 a month: share of households with a mortgage",
        "unit": "%",
        "values": [
          {
            "period": "2021-08-10",
            "period_start": "2021-08-10",
            "value": 5.93
          }
        ]
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

About 7,200 suburbs and localities and 498 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

Monthly mortgage repayments made by households who owned their home with a mortgage on 10 August 2021, for every suburb and council area, as counts in repayment bands and the median.

What it shows

Mortgaged households by monthly repayment band, each as a count and as a share of all households with a mortgage, plus the total and the median monthly repayment in dollars. Counts and shares are separate fields (for example mortgage_2400_2999_count and mortgage_2400_2999_pct).

Why use it

Repayments show how stretched a suburb's buyers are and how recently they bought: new buyers carry big loans, long-time owners small ones. Use it to compare repayment burdens between suburbs, to size a market for refinancing or financial advice, to judge how sensitive an area is to interest-rate rises, or to add a home-owner profile to a suburb report. For a ready-made stress measure see the market mortgage-stress endpoint.

How it is built

The base is occupied private dwellings owned with a mortgage (including those being bought under a shared-equity or rent-buy scheme). The median is over households that stated their repayment. Repayments are as paid in August 2021, when interest rates were at a record low, so they understate what the same loans cost after the 2022 to 2023 rate rises. Areas with fewer than 20 mortgaged households are left out, median included. 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_mortgaged_households` Households with a mortgage	households	Occupied private dwellings owned with a mortgage, the base for every share.
`mortgage_0_299_count` $0 to $299 a month	households	Number of households with a mortgage in the area repaying: $0 to $299 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_0_299_pct` $0 to $299 a month: share of households with a mortgage	%	$0 to $299 a month as a percent of all households with a mortgage in the area.
`mortgage_300_449_count` $300 to $449 a month	households	Number of households with a mortgage in the area repaying: $300 to $449 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_300_449_pct` $300 to $449 a month: share of households with a mortgage	%	$300 to $449 a month as a percent of all households with a mortgage in the area.
`mortgage_450_599_count` $450 to $599 a month	households	Number of households with a mortgage in the area repaying: $450 to $599 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_450_599_pct` $450 to $599 a month: share of households with a mortgage	%	$450 to $599 a month as a percent of all households with a mortgage in the area.
`mortgage_600_799_count` $600 to $799 a month	households	Number of households with a mortgage in the area repaying: $600 to $799 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_600_799_pct` $600 to $799 a month: share of households with a mortgage	%	$600 to $799 a month as a percent of all households with a mortgage in the area.
`mortgage_800_999_count` $800 to $999 a month	households	Number of households with a mortgage in the area repaying: $800 to $999 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_800_999_pct` $800 to $999 a month: share of households with a mortgage	%	$800 to $999 a month as a percent of all households with a mortgage in the area.
`mortgage_1000_1399_count` $1,000 to $1,399 a month	households	Number of households with a mortgage in the area repaying: $1,000 to $1,399 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_1000_1399_pct` $1,000 to $1,399 a month: share of households with a mortgage	%	$1,000 to $1,399 a month as a percent of all households with a mortgage in the area.
`mortgage_1400_1799_count` $1,400 to $1,799 a month	households	Number of households with a mortgage in the area repaying: $1,400 to $1,799 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_1400_1799_pct` $1,400 to $1,799 a month: share of households with a mortgage	%	$1,400 to $1,799 a month as a percent of all households with a mortgage in the area.
`mortgage_1800_2399_count` $1,800 to $2,399 a month	households	Number of households with a mortgage in the area repaying: $1,800 to $2,399 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_1800_2399_pct` $1,800 to $2,399 a month: share of households with a mortgage	%	$1,800 to $2,399 a month as a percent of all households with a mortgage in the area.
`mortgage_2400_2999_count` $2,400 to $2,999 a month	households	Number of households with a mortgage in the area repaying: $2,400 to $2,999 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_2400_2999_pct` $2,400 to $2,999 a month: share of households with a mortgage	%	$2,400 to $2,999 a month as a percent of all households with a mortgage in the area.
`mortgage_3000_3999_count` $3,000 to $3,999 a month	households	Number of households with a mortgage in the area repaying: $3,000 to $3,999 a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_3000_3999_pct` $3,000 to $3,999 a month: share of households with a mortgage	%	$3,000 to $3,999 a month as a percent of all households with a mortgage in the area.
`mortgage_4000_plus_count` $4,000 or more a month	households	Number of households with a mortgage in the area repaying: $4,000 or more a month (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_4000_plus_pct` $4,000 or more a month: share of households with a mortgage	%	$4,000 or more a month as a percent of all households with a mortgage in the area.
`mortgage_not_stated_count` Repayment not stated	households	Number of households with a mortgage in the area repaying: Repayment not stated (2021 snapshot). Small counts are lightly randomised for privacy.
`mortgage_not_stated_pct` Repayment not stated: share of households with a mortgage	%	Repayment not stated as a percent of all households with a mortgage in the area.
`median_mortgage_monthly` Median monthly mortgage repayment	AUD per month	Median monthly mortgage repayment of households paying off their home, in dollars (2021 snapshot, not inflation-adjusted).