Property - Context

Bedroom-band price series

GET/v1/properties/{gnaf_id}/context/street-bedroom-series15¢ per call

The subject's bedroom band (bed count from listing history) and the suburb's 10-year price series for that band.

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

gnaf_idstringrequired

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

StreetBedroomSeriesfields returned to you

gnaf_idstringalways returned

Subject property GNAF id.

suburbstringalways returned

Suburb (SAL) the series is for.

bedroomsintegeralways returned

Subject bed count — MAX(bedrooms) across every listing snapshot on record for the GNAF.

property_typestringalways returned

Subject property type bucket.

band_labelstringalways returned

Human label, e.g. "4-bed house".

latest_valuenumbermay be null

Most recent series value (AUD).

latest_datestringmay be null

Date of the most recent series point (YYYY-MM-DD).

seriesarray of BandSeriesPointalways returned

10-year monthly median price series for the band.

GET/v1/properties/{gnaf_id}/context/street-bedroom-series

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/context/street-bedroom-series' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "band_label": "4-bed house",
    "bedrooms": 4,
    "gnaf_id": "GANSW704360755",
    "latest_date": "2026-06-28",
    "latest_value": 4400000,
    "property_type": "house",
    "series": [
      {
        "date": "2026-06-28",
        "value": 4400000
      }
    ],
    "suburb": "Castlecrag"
  }
}

Successful Response200

application/json