Property - Basics

Bedroom count

GET/v1/properties/{gnaf_id}/basics/bed-count5¢ per call

Bedroom count from the latest matching listing.

Price: 5¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

The only values you send. Fields under Responses below are what comes back — you never pass those.

gnaf_idstringrequired

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Successful Response

application/json

BedCountfields returned to you

bed_countintegeralways returned

Number of bedrooms, or null if unknown.

GET/v1/properties/{gnaf_id}/basics/bed-count

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/basics/bed-count' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "bed_count": 4
  }
}

Successful Response200

application/json