Search

Suggest addresses, suburbs and places as someone types

Two characters minimum: below that the endpoint returns an empty list rather than matching most of the table.

Debounce by at least 150ms in the client. Each request is a unit, and firing on every keystroke spends them for no better answer.

A result whose kind is address is a resolved G-NAF record, not a string: it carries gnaf_pid, coordinates, and components holding the address split into G-NAF's own fields. Store the pid against your own record and the two systems agree they mean the same door, whatever either of you does to the formatting afterwards.

Address matching is a prefix of the street line, so type it the way it is written: the number first, then the street. A unit in front is understood and resolves to the unit's own record, not the building's: 3/90 Bay Road returns the pid of unit 3, and 90 Bay Road returns the pid of the parcel. unit 3, u3, apt 3 and 3 90 are read the same way. A suburb name or a postcode alone matches suburbs, not addresses.

get/v1/typeahead

Request

  • Base URL: https://api.locio.com.au
  • URL: https://api.locio.com.au/v1/typeahead
  • Auth: HTTP bearer

Query parameters

qstring required
limitinteger

Response

Matches, best first.

generated_atstring date-time

Example response

{
  "data": [
    {
      "gnaf_pid": "GAVIC411711441",
      "components": {
        "building_name": "Piermont Resort",
        "flat_type": "Shop",
        "flat_number": "3",
        "level_type": "Level",
        "level_number": "3",
        "number_first": "145",
        "number_first_suffix": "A",
        "number_last": "437",
        "street_name": "Sydney",
        "street_type": "Road",
        "street_suffix": "West",
        "locality_name": "Coburg",
        "state": "VIC",
        "postcode": "3058",
        "lot_number": "3"
      }
    }
  ]
}

Changes

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