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
Suburb - Finder

Finder field catalog

GET/v1/suburbs/finder/fieldsFree

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.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

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
FieldsResponsefields returned to you
fieldsarray of FinderFieldalways returned

Every filterable / returnable field.

GET/v1/suburbs/finder/fields
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/finder/fields' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "fields": [
      {
        "key": "grossYield",
        "label": "Gross rental yield",
        "unit": "percent"
      }
    ]
  }
}
Successful Response200
application/json