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

Building by mesh block — the homes on each block within 1 km (by gnaf_id)

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

What are the homes like? For every mesh block around the property: how many properties, the share of houses and strata, median bedrooms, bathrooms and building size, building height, and recent construction.

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

The homes around one address, block by block: for each mesh block within 1 km, how many properties it holds, the share of houses and strata, median bedrooms, bathrooms and building size, building height, and recent construction.

What people use it for

  • Buyers: see whether a street is mostly family houses, units or a mix.
  • Developers: read the existing built form and height around a site.
  • Valuers and analysts: check that comparable homes really are comparable in size and type.

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

For the planning rules that apply to the site itself use /v1/properties/{gnaf_id}/development/zoning-code. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/building. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.

GET/v1/properties/{gnaf_id}/mesh-blocks/building
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/building' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "gnaf_id": "GANSW704074813",
    "suburb": "Belmont North",
    "state": "NSW",
    "radius_m": 1000,
    "topic": "building",
    "question": "What are the homes like?",
    "beta": false,
    "block_count": 102,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "properties": {
            "value": 49,
            "unit": "count",
            "label": "Properties on this block",
            "provenance": "not_recorded",
            "how": ""
          },
          "house_pct": {
            "value": 73.47,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Houses",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "strata_pct": {
            "value": 26.53,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Strata-titled",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bedrooms": {
            "value": 2.5,
            "unit": "bedrooms",
            "measured_at": "mesh_block",
            "label": "Median bedrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bathrooms": {
            "value": 1,
            "unit": "bathrooms",
            "measured_at": "mesh_block",
            "label": "Median bathrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_building_size_sqm": {
            "unit": "square metres",
            "measured_at": "mesh_block",
            "label": "Median building size",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "max_building_height_m": {
            "value": 8.5,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Tallest building",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "mean_storeys": {
            "value": 1,
            "unit": "storeys",
            "label": "Average storeys",
            "provenance": "not_recorded",
            "how": ""
          },
          "new_construction_listed_pct": {
            "value": 0,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings described as new construction",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "construction_score": {
            "value": -0.05,
            "unit": "index",
            "measured_at": "mesh_block",
            "label": "Change in built-up surface seen from satellite, 2019 to 2023 (higher = more building)",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "distance_m": 0
      },
      {
        "mb_code": "10434330000",
        "population": 89,
        "dwellings": 32,
        "fields": {
          "properties": {
            "value": 33,
            "unit": "count",
            "label": "Properties on this block",
            "provenance": "not_recorded",
            "how": ""
          },
          "house_pct": {
            "value": 78.79,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Houses",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "strata_pct": {
            "value": 21.21,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Strata-titled",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bedrooms": {
            "value": 3,
            "unit": "bedrooms",
            "measured_at": "mesh_block",
            "label": "Median bedrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bathrooms": {
            "value": 1,
            "unit": "bathrooms",
            "measured_at": "mesh_block",
            "label": "Median bathrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_building_size_sqm": {
            "unit": "square metres",
            "measured_at": "mesh_block",
            "label": "Median building size",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "max_building_height_m": {
            "value": 8.5,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Tallest building",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "mean_storeys": {
            "value": 1,
            "unit": "storeys",
            "label": "Average storeys",
            "provenance": "not_recorded",
            "how": ""
          },
          "new_construction_listed_pct": {
            "value": 0,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings described as new construction",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "construction_score": {
            "value": -0.06,
            "unit": "index",
            "measured_at": "mesh_block",
            "label": "Change in built-up surface seen from satellite, 2019 to 2023 (higher = more building)",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "distance_m": 15
      },
      {
        "mb_code": "10434440000",
        "population": 99,
        "dwellings": 34,
        "fields": {
          "properties": {
            "value": 43,
            "unit": "count",
            "label": "Properties on this block",
            "provenance": "not_recorded",
            "how": ""
          },
          "house_pct": {
            "value": 69.77,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Houses",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "strata_pct": {
            "value": 30.23,
            "unit": "% of properties",
            "measured_at": "mesh_block",
            "label": "Strata-titled",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bedrooms": {
            "value": 3,
            "unit": "bedrooms",
            "measured_at": "mesh_block",
            "label": "Median bedrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_bathrooms": {
            "value": 2,
            "unit": "bathrooms",
            "measured_at": "mesh_block",
            "label": "Median bathrooms",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "median_building_size_sqm": {
            "value": 142,
            "unit": "square metres",
            "measured_at": "mesh_block",
            "label": "Median building size",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "max_building_height_m": {
            "value": 8.5,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Tallest building",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "mean_storeys": {
            "value": 1.24,
            "unit": "storeys",
            "label": "Average storeys",
            "provenance": "not_recorded",
            "how": ""
          },
          "new_construction_listed_pct": {
            "value": 0,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings described as new construction",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "construction_score": {
            "value": -0.03,
            "unit": "index",
            "measured_at": "mesh_block",
            "label": "Change in built-up surface seen from satellite, 2019 to 2023 (higher = more building)",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "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