Property - Basics

Dwelling type

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

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

Price: 5¢ per call.

Authorization

Bearer tokentest

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

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

house, unit, townhouse, etc.

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

Show schema

{
  "data": {
    "dwelling_type": "house"
  }
}

Successful Response200

application/json