Suburb - Market

Bedroom stats

GET/v1/suburbs/{suburb_name}/market/bedroom-stats10¢ per call

Sales volume, median bath/car/land, and stock mix per bedroom count.

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

BedroomStatsfields returned to you

area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

bedroomsarray of BedroomStatsRowalways returned

One row per bedroom count.

GET/v1/suburbs/{suburb_name}/market/bedroom-stats

cURL

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

Example Responses

Show schema

{
  "data": {
    "area_level": "suburb",
    "area_name": "Belmont North",
    "bedrooms": [
      {
        "bedrooms": 3,
        "median_bath": 1,
        "median_car": 2,
        "median_land": 613,
        "n_sales": 4364,
        "pct_house": 88,
        "pct_townhouse": 5,
        "pct_unit": 1
      }
    ]
  }
}

Successful Response200

application/json