Free sandbox: try any request below on the sample suburbs, no signup. For every suburb, create an API key.

Microburbs Property Data API

Suburb - Environment

Terrain by mesh block (by suburb)

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

Ground elevation and slope for every residential mesh block: median, lowest and highest ground level, typical and steepest slope, and the share of homes on flat or steep land.

Coverage: All states and territories; blocks with at least three addressed properties. Current to 2026-10-01. Full description, field list and method: /v1/datasets/terrain-block.

One call returns every mesh block in the suburb.

Exact suburb identifier required. Exact official suburb name (SAL), 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.

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

suburb_namestringrequired

Exact official suburb name (SAL), 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

DatasetBlocksfields returned to you

datasetstringalways returned

Dataset slug.

suburbstringalways returned

Canonical suburb name.

as_ofstring · datealways returned

Date the dataset is current to.

modelledbooleanalways returned

True when the figures are modelled estimates.

blocksintegeralways returned

Number of mesh blocks with data.

rowsarray of DatasetBlockRowalways returned

One row per block, field and period.

GET/v1/suburbs/{suburb_name}/mesh-blocks/terrain

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/mesh-blocks/terrain' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "dataset": "terrain-block",
    "suburb": "Belmont North",
    "as_of": "2026-10-01",
    "modelled": false,
    "blocks": 65,
    "rows": [
      {
        "mb_code": "10431160000",
        "field": "elevation_median_m",
        "period": "2026-10-01",
        "value": 12.9
      },
      {
        "mb_code": "10431160000",
        "field": "elevation_min_m",
        "period": "2026-10-01",
        "value": 11
      },
      {
        "mb_code": "10431160000",
        "field": "elevation_max_m",
        "period": "2026-10-01",
        "value": 15.7
      }
    ]
  }
}

Successful Response200

application/json

About this dataset

All states and territories; blocks with at least three addressed properties. Current to 2026-10-01; refreshed yearly.

What it is

A terrain profile for each mesh block (a city block of roughly 30 to 60 homes). It summarises the ground under every address in the block: how high it sits above sea level, how much that varies across the block, and how steep the land is.

What it shows

Median, minimum and maximum ground elevation in metres; the median slope and the 90th-percentile slope in degrees; the percentage of homes on flat land (under 2 degrees) and on steep land (10 degrees or more); how many homes were measured; and the share measured from high-resolution (5 metre) elevation data rather than the coarser 30 metre model.

Why use it

Slope drives building cost (cut and fill, retaining walls, split-level designs), drainage and overland-flow risk, accessibility, and views. Elevation matters for flood and storm-surge exposure and for coastal planning. Block-level detail separates the hill-top street from the gully two blocks away, which a suburb average cannot.

How it is built

We sample a digital elevation model at every address point, using 5 metre LiDAR-derived surfaces where they exist and a 30 metre national model elsewhere, and compute slope from the surrounding cells. Address-level results are then aggregated per 2021 mesh block. Blocks with fewer than three measured addresses are left out, because a median of one or two homes is not a block statistic. Elevation is ground level, not building or floor height.

Fields

Field	Unit	Description
`elevation_median_m` Median ground elevation	m	Median ground level above sea level across the block's addresses.
`elevation_min_m` Lowest ground elevation	m	Lowest ground level among the block's addresses.
`elevation_max_m` Highest ground elevation	m	Highest ground level among the block's addresses.
`slope_median_deg` Median slope	deg	Median land slope at the block's addresses, in degrees.
`slope_p90_deg` Steep-end slope (90th percentile)	deg	Slope that 90% of the block's addresses are at or below; describes the steepest part of the block.
`flat_share_pct` Homes on flat land	%	Share of the block's addresses on land under 2 degrees.
`steep_share_pct` Homes on steep land	%	Share of the block's addresses on land of 10 degrees or more.
`properties_measured` Addresses measured	count	Number of addresses in the block with a terrain measurement.
`high_res_share_pct` High-resolution coverage	%	Share of the block's addresses measured from 5 metre elevation data rather than the 30 metre model; lower values mean coarser figures.