AddressFinder REST API Reference

Public lookup API only. Admin routes were migrated out of this service.

GET/health

Service/index readiness check. No auth required.

{"status":"ok","active_version":"...","records_path":"...","fast_index_ready":true,"max_search_limit":25,"max_postcode_results":200}

GET/v1/search

Search by postcode or address text. Requires x-api-key.

curl -H "x-api-key: <your_api_key>" \
  "http://localhost:8080/v1/search?q=SW1A%201AA&limit=25&welsh=true"

GET/v1/postcodes/{postcode}

Expand exact postcode to addresses. Requires x-api-key.

curl -H "x-api-key: <your_api_key>" \
  "http://localhost:8080/v1/postcodes/SW1A%201AA?welsh=true"

GET/v1/udprn/{udprn}

Find address records by exact UDPRN. Requires x-api-key.

curl -H "x-api-key: <your_api_key>" \
  "http://localhost:8080/v1/udprn/100021064176"

GET/v1/address/{id}

Fetch single address by internal ID. Requires x-api-key.

curl -H "x-api-key: <your_api_key>" \
  "http://localhost:8080/v1/address/28989476"