Microburbs
Microburbs API
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Lifestyle

Environment by mesh block — greenery, noise, solar (by suburb)

GET/v1/suburbs/{suburb_name}/mesh-blocks/environment20¢ per call

Is it green and quiet? For every mesh block in the suburb: 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 in the suburb under mesh_blocks, each with its mb_code, population and dwellings. Values only — the matching polygons come from /shapes/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 — plus how, one sentence on how the number was arrived at.

Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

Price: 20¢ per call.

Authorization

Request

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

Path parameters

suburb_namestringrequired

Exact ABS Suburb and Locality (SAL) name, e.g. `Burwood (NSW)` — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call `GET /v1/geocode/suburb?q=<text>`, then use the exact `data[].area_name` it returns. Suburb data endpoints do not guess a state or typo-correct names.

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
SuburbMbTopicfields returned to you
suburbstringalways returned

Suburb (SAL) name, as resolved.

statestringmay be null

State / Territory abbreviation.

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 MbTopicBlockalways returned

One entry per mesh block in the suburb, ordered by `mb_code`.

notestringalways returned

How to read `provenance`.

GET/v1/suburbs/{suburb_name}/mesh-blocks/environment
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/mesh-blocks/environment' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "suburb": "Belmont North",
    "state": "NSW",
    "topic": "environment",
    "question": "Is it green and quiet?",
    "beta": false,
    "block_count": 85,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "vegetation_index": {
            "value": 0.5,
            "label": "Greenness from satellite (NDVI, 2023)",
            "unit": "index -1 to 1",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "green_cover_pct": {
            "value": 47.72,
            "label": "Ground covered by green vegetation",
            "unit": "% of ground",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "vegetation_change": {
            "value": 0.03,
            "label": "Change in greenness from satellite, 2019 to 2023",
            "unit": "index change",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 21.52,
            "label": "Noise score (higher = noisier)",
            "unit": "index 0-10",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 0,
            "label": "Listings with solar panels",
            "unit": "% of listings",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 312.43,
            "label": "Small-scale solar installations",
            "unit": "per 1,000 dwellings",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          }
        }
      },
      {
        "mb_code": "11205004200",
        "population": 189,
        "dwellings": 63,
        "fields": {
          "vegetation_index": {
            "value": 0.44,
            "label": "Greenness from satellite (NDVI, 2023)",
            "unit": "index -1 to 1",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "green_cover_pct": {
            "value": 42.76,
            "label": "Ground covered by green vegetation",
            "unit": "% of ground",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "vegetation_change": {
            "value": 0.05,
            "label": "Change in greenness from satellite, 2019 to 2023",
            "unit": "index change",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 8.7,
            "label": "Noise score (higher = noisier)",
            "unit": "index 0-10",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 66.67,
            "label": "Listings with solar panels",
            "unit": "% of listings",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 274.15,
            "label": "Small-scale solar installations",
            "unit": "per 1,000 dwellings",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          }
        }
      },
      {
        "mb_code": "10436570000",
        "population": 169,
        "dwellings": 64,
        "fields": {
          "vegetation_index": {
            "value": 0.43,
            "label": "Greenness from satellite (NDVI, 2023)",
            "unit": "index -1 to 1",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "green_cover_pct": {
            "value": 38.46,
            "label": "Ground covered by green vegetation",
            "unit": "% of ground",
            "provenance": "not_recorded",
            "how": "provenance not recorded"
          },
          "vegetation_change": {
            "value": -0.04,
            "label": "Change in greenness from satellite, 2019 to 2023",
            "unit": "index change",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "noise_score": {
            "value": 23.71,
            "label": "Noise score (higher = noisier)",
            "unit": "index 0-10",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_with_solar_pct": {
            "value": 45.45,
            "label": "Listings with solar panels",
            "unit": "% of listings",
            "provenance": "measured",
            "measured_at": "mesh_block",
            "how": "measured at this level"
          },
          "solar_installs_per_1k": {
            "value": 299.35,
            "label": "Small-scale solar installations",
            "unit": "per 1,000 dwellings",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          }
        }
      }
    ],
    "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