Microburbs
Microburbs API
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
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

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
BedCountfields returned to you
bed_countintegeralways returned

Bedrooms, as advertised when the property was last on the market. Null means no listing on record ever stated one — read it as unknown, never as zero.

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
{
  "data": {
    "bed_count": 4
  }
}
Successful Response200
application/json