Sidebar

Mobile navigation sidebar

Developer console

Locality Lookup — Australia

Returns locality details by ID. The ID format is state-postcode-locality (e.g. NSW-2009-Pyrmont). Use the id from Locality Suggest.

Request

GET http://localhost:8383/address-api-v1/au/state-postcode-locality/{id}

Path parameters

Parameter Description
id Locality ID (format: state-postcode-locality).

Response (200 OK)

{
  "id": "NSW-2009-Pyrmont",
  "locality": "PYRMONT",
  "state": "NSW",
  "postcode": "2009"
}

Errors

404 Not Found — Locality not found for the given ID.

Example

curl -X GET "http://localhost:8383/address-api-v1/au/state-postcode-locality/NSW-2009-Pyrmont" \
  -H "x-auth-key: YOUR_API_KEY"