Geocode

Address → GNAF

GET/v1/geocode/address1¢ per call

Resolve a freeform address string to candidate G-NAF identifiers.

Use this before calling any /v1/properties/{gnaf_id}/... route — those endpoints require a GNAF in the path. Returns up to 10 candidates, ranked by Meilisearch score.

Price: 1¢ 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

addressstringrequired

Freeform address string.

Required — set a value before sending.

Responses

Successful Response

application/json

list[GnafCandidate]fields returned to you

Array of:

GET/v1/geocode/address

Missing required parameter: address — set it on the left to send.

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/geocode/address' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": [
    {
      "abbr": "27 ARLINGTON ST BELMONT NORTH",
      "display_name": "27 Arlington Street, Belmont North",
      "id": "GANSW704074813",
      "name": "27 Arlington Street, Belmont North",
      "property_type": "house"
    }
  ]
}

Successful Response200

application/json