Terrain slope profile
/v1/suburbs/{suburb_name}/risks/slope10¢ per callMedian / 90th-percentile property gradient and share of steep (>10°) properties.
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: 10¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
suburb_namestringrequiredExact 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
Responses
Successful Response
area_namestringalways returnedCanonical ABS SAL suburb name.
area_levelstringalways returnedAlways 'suburb'.
n_propertiesintegeralways returnedProperties with a terrain sample.
median_slope_degnumbermay be nullMedian property gradient (degrees).
p90_slope_degnumbermay be null90th-percentile property gradient (degrees).
steep_pctnumbermay be nullShare of properties steeper than the threshold (%).
steep_threshold_degnumberalways returnedGradient threshold used for steep_pct (degrees).
/v1/suburbs/{suburb_name}/risks/slopecurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/risks/slope' \
--header 'Authorization: Bearer test'{
"data": {
"area_name": "Belmont North",
"area_level": "suburb",
"n_properties": 2727,
"median_slope_deg": 4.43,
"p90_slope_deg": 8.29,
"steep_pct": 4.44,
"steep_threshold_deg": 10
}
}