GET
Address autocomplete

Overview

Returns UK address suggestions for an address-entry autocomplete as the user types. Pass the partial term as q; the server proxies the Ideal Postcodes UK PAF (Postcode Address File) API and returns a list of one-line suggestions covering flat-level addresses (individual flats, not just buildings). Each item carries an opaque id — a UK PAF UDPRN — which you pass to GET /api/v1/address/details to resolve the full address plus latitude/longitude once the user picks a suggestion. The API key lives server-side; clients never see it. An all-whitespace q yields an empty list rather than an error.

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

Request body

None.

Response — 200 OK

Example response

Error responses

Side effects

None — this is a pure read that proxies a third-party lookup.

See also

curl