Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Microburbs Property Data API
Property - Basics
All basics — bundle
GET
/v1/properties/{gnaf_id}/basics/all23¢ per callPrice: 23¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
gnaf_idstringrequiredQuery parameters
None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.
Responses
Successful Response
application/json
BasicsAllfields returned to you
bed_countintegermay be nullBedrooms as advertised. Null = unknown, not zero.
bath_countintegermay be nullBathrooms as advertised, whole number. Null = unknown, not zero.
parking_countintegermay be nullCovered car spaces (garage/carport) as advertised — excludes open driveway and street parking. Null = unknown.
dwelling_typestringmay be nullDwelling kind in lowercase free text ('house', 'unit', 'townhouse', …), from the listing or the national address file. Not a closed set.
land_area_sqmnumbermay be nullAdvertised land size in square metres (hectares converted for you), indicative rather than surveyed. Null = not stated; usual for units.
GET
/v1/properties/{gnaf_id}/basics/allcURL
curl --request GET \
--url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/basics/all' \
--header 'Authorization: Bearer test'Example Responses
{
"data": {
"bath_count": 2,
"bed_count": 4,
"dwelling_type": "house",
"land_area_sqm": 814,
"parking_count": 5
}
}Successful Response200
application/json
