Suburb - Finder

Finder field catalog

Every field you can filter / sort on, with its label and unit. 0c.

Houses and units are separate keys: the unit-prefixed ones (unitMedianPrice, unitGrossYield, unitMedianRent, …) are the apartment market, the unprefixed market keys are houses, and both can be filtered in the same query. Unit fields are NOT nationally populated — they only exist where a suburb has a unit market (roughly 13-54% of suburbs depending on the field), so a suburb with no unit market simply won't match a unit filter.

Free.

get/v1/suburbs/finder/fields

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/finder/fields
  • Auth: HTTP bearer

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": {
    "fields": [
      {
        "key": "grossYield",
        "label": "Gross rental yield",
        "unit": "percent"
      }
    ]
  }
}

Changes

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