Locality Suggest — Australia

Returns locality suggestions (suburb, state, postcode) for Australia. Use for suburb autocomplete or locality search. Each result is a unique combination of locality, state, and postcode.

Request

GET http://localhost:8383/address-api-v1/au/state-postcode-locality/suggest?keyword=pyrmont&limit=10

Query parameters

Parameter	Type	Description
`keyword`	string	Search term. Empty returns no results.
`limit`	integer	Max results. Default 10, max 30.

Try it

Search for a locality (suburb) and see the API response in real time.

Loading…

Response (200 OK)

{
  "count": 2,
  "items": [
    {
      "id": "NSW-2009-Pyrmont",
      "locality": "PYRMONT",
      "state": "NSW",
      "postcode": "2009"
    }
  ]
}

Response properties

Property	Description
`items[].id`	Unique ID (format: state-postcode-locality). Use with Locality Lookup.
`items[].locality`	Suburb or locality name.
`items[].state`	State code (e.g. NSW, VIC).
`items[].postcode`	Postcode.

Example

curl -X GET "http://localhost:8383/address-api-v1/au/state-postcode-locality/suggest?keyword=pyrmont&limit=5" \
  -H "x-auth-key: YOUR_API_KEY"