Microburbs
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

All basics — bundle

GET/v1/properties/{gnaf_id}/basics/all23¢ per call

The physical facts about a dwelling in one call: bedrooms, bathrooms, parking spaces, dwelling type (house, unit, townhouse and so on) and land area in square metres.

Priced as the sum of the five individual calls. Ask for a single field instead if that is all you need.

Price: 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_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
BasicsAllfields returned to you
bed_countintegermay be null

Bedrooms as advertised. Null = unknown, not zero.

bath_countintegermay be null

Bathrooms as advertised, whole number. Null = unknown, not zero.

parking_countintegermay be null

Covered car spaces (garage/carport) as advertised — excludes open driveway and street parking. Null = unknown.

dwelling_typestringmay be null

Dwelling kind in lowercase free text ('house', 'unit', 'townhouse', …), from the listing or the national address file. Not a closed set.

land_area_sqmnumbermay be null

Advertised 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/all
cURL
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