Address Suggest — Australia

Returns address suggestions for Australia. Use for autocomplete or search-as-you-type. Supports both GET (keyword in query) and POST (keyword in body) to avoid exposing search terms in URLs.

GET /address-api-v1/au/address/suggest

GET https://api.datasaras.com/address-api-v1/au/address/suggest?keyword=25+york&limit=10

Query parameters

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

POST /address-api-v1/au/address/suggest

Same behaviour as GET; use POST to send the keyword in the body so it does not appear in the URL.

POST https://api.datasaras.com/address-api-v1/au/address/suggest
Content-Type: application/json

{
  "keyword": "55 kay st",
  "limit": 10
}

Request body

Property	Type	Description
`keyword`	string	Search term. Optional.
`limit`	integer	Max results. Default 10.

Try it

Search for an address and see the API response in real time.

Loading…

Response (200 OK)

{
  "count": 2,
  "items": [
    {
      "id": "GANSW717116102",
      "address_line_1": "55 KAY ST PYRMONT NSW 2009",
      "locality": "PYRMONT",
      "state": "NSW",
      "postcode": "2009"
    }
  ]
}

Response properties

Property	Description
`count`	Number of items returned.
`items`	Array of address suggestions.
`items[].id`	Address detail PID. Use with Address Lookup for full details.
`items[].address_line_1`	Formatted address line.
`items[].locality`	Suburb or locality name.
`items[].state`	State code (e.g. NSW, VIC).
`items[].postcode`	Postcode.