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

Environment by mesh block — greenery, noise, solar within 1 km (by gnaf_id)

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

Is it green and quiet? For every mesh block around the property: greenness and vegetation cover from satellite and how it has changed, a noise score, and solar panels on listings and small-scale installations.

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

How green and quiet the blocks around one address are: for each mesh block within 1 km, vegetation and green cover from satellite and how it has changed, a noise score, and solar on listings and small-scale installations.

What people use it for

  • Buyers and renters: compare leafy, quiet blocks with busier ones nearby.
  • Councils and planners: track green cover around a site.
  • Solar and energy businesses: gauge solar take-up street by street.

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

noise_score is a relative index (higher is noisier), not decibels, and is not capped at 10. For a map of noise across a suburb use /v1/suburbs/{suburb_name}/shapes/noise-heatmap. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/environment. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.

GET/v1/properties/{gnaf_id}/mesh-blocks/environment
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/environment' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "gnaf_id": "GANSW704074813",
    "suburb": "Belmont North",
    "state": "NSW",
    "radius_m": 1000,
    "topic": "environment",
    "question": "Is it green and quiet?",
    "beta": false,
    "block_count": 102,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "vegetation_index": {
            "value": 0.5,
            "unit": "index -1 to 1",
            "label": "Greenness from satellite (NDVI, 2023)",
            "provenance": "not_recorded",
            "how": ""
          },
          "green_cover_pct": {
            "value": 47.72,
            "unit": "% of ground",
            "label": "Ground covered by green vegetation",
            "provenance": "not_recorded",
            "how": ""
          },
          "vegetation_change": {
            "value": 0.03,
            "unit": "index change",
            "measured_at": "mesh_block",
            "label": "Change in greenness from satellite, 2019 to 2023",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 21.52,
            "unit": "index (higher = noisier; not capped at 10)",
            "label": "Noise score (higher = noisier)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 0,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings with solar panels",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 312.43,
            "unit": "per 1,000 dwellings",
            "label": "Small-scale solar installations",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          }
        },
        "distance_m": 0
      },
      {
        "mb_code": "10434330000",
        "population": 89,
        "dwellings": 32,
        "fields": {
          "vegetation_index": {
            "value": 0.43,
            "unit": "index -1 to 1",
            "label": "Greenness from satellite (NDVI, 2023)",
            "provenance": "not_recorded",
            "how": ""
          },
          "green_cover_pct": {
            "value": 40.52,
            "unit": "% of ground",
            "label": "Ground covered by green vegetation",
            "provenance": "not_recorded",
            "how": ""
          },
          "vegetation_change": {
            "value": 0.04,
            "unit": "index change",
            "measured_at": "mesh_block",
            "label": "Change in greenness from satellite, 2019 to 2023",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 22.15,
            "unit": "index (higher = noisier; not capped at 10)",
            "label": "Noise score (higher = noisier)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 20,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings with solar panels",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 299.85,
            "unit": "per 1,000 dwellings",
            "label": "Small-scale solar installations",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          }
        },
        "distance_m": 15
      },
      {
        "mb_code": "10434440000",
        "population": 99,
        "dwellings": 34,
        "fields": {
          "vegetation_index": {
            "value": 0.56,
            "unit": "index -1 to 1",
            "label": "Greenness from satellite (NDVI, 2023)",
            "provenance": "not_recorded",
            "how": ""
          },
          "green_cover_pct": {
            "value": 52.24,
            "unit": "% of ground",
            "label": "Ground covered by green vegetation",
            "provenance": "not_recorded",
            "how": ""
          },
          "vegetation_change": {
            "value": 0.02,
            "unit": "index change",
            "measured_at": "mesh_block",
            "label": "Change in greenness from satellite, 2019 to 2023",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 26.65,
            "unit": "index (higher = noisier; not capped at 10)",
            "label": "Noise score (higher = noisier)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 16.67,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings with solar panels",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 308.75,
            "unit": "per 1,000 dwellings",
            "label": "Small-scale solar installations",
            "provenance": "estimate",
            "how": "our estimate for 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