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

Dwelling type

GET/v1/properties/{gnaf_id}/basics/dwelling-type5¢ per call

Dwelling type (house, unit, townhouse, ...).

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
DwellingTypefields returned to you
dwelling_typestringalways returned

What kind of dwelling it is — lowercase free text such as 'house', 'unit', 'townhouse', 'apartment'. Taken from the advertised listing type, falling back to the national address file's classification when no listing states one. Not a closed set: match case-insensitively and allow for values outside the common few.

GET/v1/properties/{gnaf_id}/basics/dwelling-type
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/basics/dwelling-type' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "dwelling_type": "house"
  }
}
Successful Response200
application/json