Suburb - Finder

Finder field catalog

GET/v1/suburbs/finder/fields0¢ per call

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

Price: 0¢ 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.

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

Show schema

{
  "data": {
    "fields": [
      {
        "key": "grossYield",
        "label": "Gross rental yield",
        "unit": "percent"
      }
    ]
  }
}

Successful Response200

application/json