Property - Basics

All basics — bundle

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.

get/v1/properties/{gnaf_id}/basics/all

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/basics/all
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "data": {
    "bath_count": 2,
    "bed_count": 4,
    "dwelling_type": "house",
    "land_area_sqm": 814,
    "parking_count": 5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.