SDKs
To add address search to a web form, use a library rather than an SDK. Address Finder adds address autocomplete and Postcode Lookup adds a postcode search. Both come in React versions: Address Finder for React and Postcode Lookup for React. The libraries provide the interface, keyboard support and accessibility, then fill in your address fields.
When should I use an SDK?
Use an SDK when you need:
- Every current API endpoint. Address search, postcode and UPRN lookup and address cleanse, plus key, licensee and configuration management.
- Programmatic access. Call the API from your own code, such as a server, a script or a data pipeline.
- A custom integration. Build your own interface or workflow where the libraries do not fit.
For a one-off call, fetch with the API reference is enough.
Which SDKs are available?
TypeScript
@ideal-postcodes/sdk wraps every current API operation in a typed function over native fetch. It runs in browsers and Node.js 22 or later.
npm install @ideal-postcodes/sdk