State-Postcode Suggest — Australia

Returns state and postcode suggestions for Australia. Use for postcode or state autocomplete. Each result is a unique state-postcode combination.

Request

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

Parameter	Type	Description
`keyword`	string	Search term (e.g. postcode or state). Empty returns no results.
`limit`	integer	Max results. Default 10, max 30.

Search for a postcode or state and see the API response in real time.

Loading…

{
  "count": 1,
  "items": [
    {
      "id": "NSW-2145",
      "postcode": "2145",
      "state": "NSW"
    }
  ]
}

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

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