Suburb - Risks

Terrain slope profile

GET/v1/suburbs/{suburb_name}/risks/slope10¢ per call

Median / 90th-percentile property gradient and share of steep (>10°) properties.

Price: 10¢ per call.

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

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

SlopeProfilefields returned to you

area_namestringalways returned

Canonical ABS SAL suburb name.

area_levelstringalways returned

Always 'suburb'.

n_propertiesintegeralways returned

Properties with a terrain sample.

median_slope_degnumbermay be null

Median property gradient (degrees).

p90_slope_degnumbermay be null

90th-percentile property gradient (degrees).

steep_pctnumbermay be null

Share of properties steeper than the threshold (%).

steep_threshold_degnumberalways returned

Gradient threshold used for steep_pct (degrees).

GET/v1/suburbs/{suburb_name}/risks/slope

cURL

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

Example Responses

Show schema

{
  "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
  }
}

Successful Response200

application/json