Suburb - Forecast

Sale-price growth forecast

GET/v1/suburbs/{suburb_name}/forecast/sale100¢ per call

1-year sale-price growth forecast (low / most-likely / high).

Price: 100¢ 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

ForecastSalefields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

metricstringmay be null

Metric label, e.g. 'sale_price_growth_forecast'.

houseobjectmay be null

A point forecast with explicit uncertainty bounds + a confidence score.

unitobjectmay be null

A point forecast with explicit uncertainty bounds + a confidence score.

GET/v1/suburbs/{suburb_name}/forecast/sale

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "house": {
      "confidence": 2,
      "high": 0.0927,
      "low": 0.0379,
      "most_likely": 0.0686
    },
    "metric": "sale_price_growth_forecast",
    "unit": {
      "confidence": 2,
      "high": 0.0993,
      "low": 0.0353,
      "most_likely": 0.0762
    }
  }
}

Successful Response200

application/json