Terrain at the property
/v1/properties/{gnaf_id}/environment/terrain3¢ per callGround elevation, slope and the direction the land faces at one address, with how its slope ranks against the rest of its suburb and region.
Coverage: About 16 million addresses in every state and territory. Current to 2026-10-01. Full description, field list and method: /v1/datasets/terrain-property.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
gnaf_idstringrequiredGNAF address id, e.g. `GANSW704074813` (resolve an address with /v1/geocode/address).
Query parameters
fieldsstringoptionalComma-separated subset of: elevation_m, slope_deg, aspect_deg, slope_pctile_suburb, slope_pctile_sa4, resolution_m. Omit for all.
Responses
Successful Response
datasetstringalways returnedDataset slug; describe it with /v1/datasets/{slug}.
levelstringalways returnedsuburb, lga or block.
areastringalways returnedCanonical name (or mesh-block code) of the area answered.
period_typestringalways returnedsnapshot, year, financial_year, quarter or month.
as_ofstring · datealways returnedDate the dataset is current to. Values are never withheld for age; check this instead.
modelledbooleanalways returnedTrue when the figures are estimates from a model rather than counts or measurements.
fieldsarray of DatasetFieldSeriesalways returned/v1/properties/{gnaf_id}/environment/terraincurl --request GET \
--url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/environment/terrain' \
--header 'Authorization: Bearer test'{
"data": {
"dataset": "terrain-property",
"level": "property",
"area": "GANSW704074813",
"period_type": "snapshot",
"as_of": "2026-10-01",
"modelled": false,
"fields": [
{
"field": "elevation_m",
"name": "Ground elevation",
"unit": "m",
"values": [
{
"period": "2026-10-01",
"period_start": "2026-10-01",
"value": 44.9
}
]
},
{
"field": "slope_deg",
"name": "Slope",
"unit": "deg",
"values": [
{
"period": "2026-10-01",
"period_start": "2026-10-01",
"value": 6.13
}
]
},
{
"field": "aspect_deg",
"name": "Aspect",
"unit": "deg",
"values": [
{
"period": "2026-10-01",
"period_start": "2026-10-01",
"value": 269.8
}
]
}
]
}
}About this dataset
About 16 million addresses in every state and territory. Current to 2026-10-01; refreshed yearly.
What it is
The lie of the land at a single address: how high the ground sits above sea level, how steep it is, and which way it faces.
What it shows
Ground elevation in metres; slope at the address, in degrees; aspect (the compass direction the slope faces, 0 = north, 90 = east; empty on flat land); the address's slope percentile within its suburb and within its wider region (100 = steepest); and the resolution of the elevation data behind the figures (5 m or 30 m).
Why use it
Slope changes what a block costs to build on (excavation, retaining walls, split-level designs), how it drains and whether it floods from overland flow, and how accessible it is. Aspect drives sunlight: in Australia a north-facing slope gets the most winter sun. Elevation matters for flood and storm-surge exposure, and for views.
How it is built
We sample a digital elevation model at the address point — 5 metre LiDAR-derived surfaces where they exist, a 30 metre national model elsewhere (resolution_m says which) — and compute slope and aspect from the surrounding cells. Percentiles rank the address against every address in its suburb and region. Elevation is ground level, not floor level; on 30 m data, figures describe the neighbourhood more than the individual lot. Readings below -2 m are bad samples and are not returned.
Fields
| Field | Unit | Description |
|---|---|---|
elevation_mGround elevation | m | Ground level above sea level at the address. |
slope_degSlope | deg | Land slope at the address. |
aspect_degAspect | deg | Compass direction the slope faces: 0 north, 90 east, 180 south, 270 west. |
slope_pctile_suburbSlope rank in suburb | percentile | Percentile of this address's slope among addresses in its suburb (100 = steepest). |
slope_pctile_sa4Slope rank in region | percentile | Percentile of this address's slope among addresses in its wider region (100 = steepest). |
resolution_mElevation data resolution | m | Grid size of the elevation data used: 5 (high resolution) or 30. |