Geocode

Address → GNAF

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.

get/v1/geocode/address

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/geocode/address
  • Auth: HTTP bearer

Query parameters

addressstring required

Freeform address string.

Example:27 Arlington Street, Belmont North NSW

Response

Successful Response

dataGnafCandidate[] nullable

The endpoint's payload, or null when Microburbs has no value.

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": [
    {
      "abbr": "27 ARLINGTON ST BELMONT NORTH",
      "display_name": "27 Arlington Street, Belmont North",
      "id": "GANSW704074813",
      "name": "27 Arlington Street, Belmont North",
      "property_type": "house"
    }
  ]
}

Changes

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