Providence WA Address Lookup API

Private Western Australian address lookup service backed by the May 2026 G-NAF GDA2020 dataset.

Operational

Endpoints

GET /api/address?q={query}&limit=10
GET /api/address/{gnaf_pid}
GET /api/localities?q={prefix}&postcode={prefix}&limit=10
GET /api/postcodes?q={prefix}&locality={prefix}&limit=10
GET /api/reverse?lat={latitude}&lon={longitude}&radius=1000&limit=5
GET /api/meta

Parameter	Use
`q`	Search text or prefix. Address search requires at least 3 characters.
`limit`	Optional result count from 1 to 20. Default is 10.
`postcode`	Optional postcode prefix filter for address and locality searches.
`locality`	Optional locality prefix filter for address and postcode searches.
`street`	Optional street-address prefix filter for address searches.
`lat`, `lon`	Required coordinates for reverse lookup.
`radius`	Reverse lookup radius in metres, from 50 to 10000. Default is 1000.

Authentication

This API requires a server-side API key. Do not call it directly from browser JavaScript.

X-API-Key: <server-side key>

Example Request

curl -H "X-API-Key: <server-side key>" \
  "https://addlookup.providence.wa.edu.au/api/address?q=50%20william%20street%20perth&limit=5"

Structured Search Examples

curl -H "X-API-Key: <server-side key>" \
  "https://addlookup.providence.wa.edu.au/api/address?q=william&locality=perth&postcode=6000"

curl -H "X-API-Key: <server-side key>" \
  "https://addlookup.providence.wa.edu.au/api/address/GAWA_146658352"

curl -H "X-API-Key: <server-side key>" \
  "https://addlookup.providence.wa.edu.au/api/reverse?lat=-31.9540766&lon=115.8571107&radius=250"

Example Response

{
  "query": "50 william street perth",
  "count": 1,
  "results": [
    {
      "gnaf_pid": "GAWA_146658352",
      "display_address": "50 WILLIAM STREET PERTH WA 6000",
      "street_address": "50 WILLIAM STREET",
      "locality_name": "PERTH",
      "state": "WA",
      "postcode": "6000",
      "latitude": "-31.9540766",
      "longitude": "115.8571107"
    }
  ]
}

Browser Use

Browser forms should use their own backend proxy. The Providence employment form calls https://jobs.providence.wa.edu.au/api/address.php, which adds the API key server-side.

Fallback Requirement

Address lookup is assistive only. Any consuming form must allow manual address entry and correction.