Microburbs
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
Property - Context

Income by mesh block — household, personal and family incomes, salaries within 1 km (by gnaf_id)

GET/v1/properties/{gnaf_id}/mesh-blocks/income20¢ per call

How much do people here earn? For every mesh block around the property: median household, personal and family income for the surrounding area, and salary, deductions and tax for the postcode.

One entry per mesh block within 1,000 m of the property under mesh_blocks, nearest first, each with its mb_code, distance_m, population and dwellings. Blocks across suburb lines are included. Values only — the polygons come from /properties/{gnaf_id}/context/mesh-blocks.

Every field carries provenance — measured (at this block), measured_wider_area (measured for the SA1 or postcode and repeated on every block in it), estimate (our model) or not_recorded (not labelled yet) — plus how, one sentence on how the number was arrived at (empty when not_recorded).

About this data ↓

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

gnaf_idstringrequired

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json
PropertyMbTopicfields returned to you
gnaf_idstringalways returned

The property, as given.

suburbstringmay be null

The property's suburb (SAL). Blocks across suburb lines are included.

statestringmay be null

State / Territory abbreviation of the property.

radius_mintegeralways returned

Radius around the property, in metres (1,000).

topicstringalways returned

Which topic this answers.

questionstringalways returned

The question this topic answers.

betabooleanalways returned

`true` when the figures behind this topic have not been validated against an independent source yet.

beta_noticestringmay be null

What is unvalidated, on beta topics only.

block_countintegeralways returned

How many mesh blocks are in `mesh_blocks`.

mesh_blocksarray of PropertyMbTopicBlockalways returned

One entry per mesh block within `radius_m`, nearest first.

notestringalways returned

How to read `provenance`.

About this data

What this is

Incomes around one address, block by block: for each mesh block within 1 km, the median household, personal and family weekly income for the surrounding SA1, and median and average salary, deductions and tax for the postcode.

What people use it for

  • Investors: judge what rent and price levels local incomes can support.
  • Retailers and service businesses: size spending power around a site.
  • Lenders and analysts: an affordability input at street scale.

Coverage

Mesh blocks nationwide (about 368,000). The 1 km radius crosses suburb lines. A field is null where we hold nothing for that block.

Tips

Every field is measured for a wider area (SA1 or postcode), so neighbouring blocks often share the same value. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/income. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.

GET/v1/properties/{gnaf_id}/mesh-blocks/income
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/income' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "gnaf_id": "GANSW704074813",
    "suburb": "Belmont North",
    "state": "NSW",
    "radius_m": 1000,
    "topic": "income",
    "question": "How much do people here earn?",
    "beta": false,
    "block_count": 102,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "area_median_household_income_weekly": {
            "value": 1787,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median household income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_personal_income_weekly": {
            "value": 691,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median personal income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_family_income_weekly": {
            "value": 1954,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median family income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "ato_median_salary": {
            "value": 62644,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_average_salary": {
            "value": 72781,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Average salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_total_deductions": {
            "value": 950,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median total deductions claimed, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_net_tax": {
            "value": 14417,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median net tax paid, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          }
        },
        "distance_m": 0
      },
      {
        "mb_code": "10434330000",
        "population": 89,
        "dwellings": 32,
        "fields": {
          "area_median_household_income_weekly": {
            "value": 1787,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median household income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_personal_income_weekly": {
            "value": 691,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median personal income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_family_income_weekly": {
            "value": 1954,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median family income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "ato_median_salary": {
            "value": 62644,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_average_salary": {
            "value": 72781,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Average salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_total_deductions": {
            "value": 950,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median total deductions claimed, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_net_tax": {
            "value": 14417,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median net tax paid, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          }
        },
        "distance_m": 15
      },
      {
        "mb_code": "10434440000",
        "population": 99,
        "dwellings": 34,
        "fields": {
          "area_median_household_income_weekly": {
            "value": 1787,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median household income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_personal_income_weekly": {
            "value": 691,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median personal income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "area_median_family_income_weekly": {
            "value": 1954,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median family income, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          },
          "ato_median_salary": {
            "value": 62644,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_average_salary": {
            "value": 72781,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Average salary or wages, tax returns lodged in the postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_total_deductions": {
            "value": 950,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median total deductions claimed, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          },
          "ato_median_net_tax": {
            "value": 14417,
            "unit": "AUD per year",
            "measured_at": "postcode",
            "label": "Median net tax paid, postcode",
            "provenance": "measured_wider_area",
            "how": "measured for the postcode, repeated on this Microburb"
          }
        },
        "distance_m": 56
      }
    ],
    "note": "Each field says how its number was arrived at. An estimate is not a measurement, and a figure measured for a wider area is not a measurement of the block."
  }
}
Successful Response200
application/json