# @ideal-postcodes/address-finder

> Address Finder JS library backed by the Ideal Postcodes UK address search API

Latest version **5.5.1** (published 2026-10-12) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @ideal-postcodes/address-finder
pnpm add @ideal-postcodes/address-finder
yarn add @ideal-postcodes/address-finder
bun add @ideal-postcodes/address-finder
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.5.1 |
| Published | 2026-10-12 |
| First published | 2021-01-04 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0 |
| Dependencies | 3 |
| Unpacked size | 592.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ideal Postcodes |
| Maintainers | cablanchard, piotrideal |
| Keywords | UK, Address Finder, Autocomplete, Ideal, Postcodes |

## Links

- npm: https://www.npmjs.com/package/@ideal-postcodes/address-finder
- Repository: https://github.com/ideal-postcodes/feedback
- Homepage: https://docs.ideal-postcodes.co.uk
- Issues: https://github.com/ideal-postcodes/feedback/issues
- npm.io page: https://npm.io/package/@ideal-postcodes/address-finder

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ~4.18.1
- [@xstate/fsm](https://npm.io/package/@xstate/fsm.md) ~2.1.0
- [@ideal-postcodes/core-axios](https://npm.io/package/@ideal-postcodes/core-axios.md) ~4.1.10

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 5.5.1 (latest) — 2026-10-12
- 5.0.0-beta.1 (beta) — 2023-11-21
- 5.5.0 — 2026-09-28
- 5.4.6 — 2026-09-28
- 5.4.5 — 2026-09-22
- 5.4.4 — 2026-09-18
- 5.4.3 — 2026-09-17
- 5.4.2 — 2026-08-20
- 5.4.1 — 2026-07-27
- 5.4.0 — 2026-07-21
- 5.3.0 — 2026-07-13
- 5.2.16 — 2026-07-03
- 5.2.15 — 2026-06-12
- 5.2.14 — 2026-06-04
- 5.2.13 — 2026-04-29
- … 72 more at https://npm.io/package/@ideal-postcodes/address-finder/versions

## README

<h1 align="center">
  <img src="https://img.ideal-postcodes.co.uk/Address%20Finder%20Logo@3x.png" alt="Ideal Postcodes Address Finder JavaScript Library">
</h1>

> Find and autocomplete addresses with Address Finder

[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder)

`@ideal-postcodes/address-finder` is a JavaScript library that delivers address autocomplete (or address typeahead) search functionality on a webpage.

This package should be consumed by a bundler or transpiler (e.g. webpack, parcel, rollup) for minification, module resolution and specific browser support.

For a pre-bundled version of `address-finder` (minified, transpiled, polyfilled, etc) that can immediately be dropped on a webpage, use [address-finder-bundled](https://github.com/ideal-postcodes/address-finder-bundled).

![Address Finder Demo](https://img.ideal-postcodes.co.uk/address-finder.gif)

## Links

- [npm Module](https://www.npmjs.com/package/@ideal-postcodes/address-finder)
- [About Address Finder](https://ideal-postcodes.co.uk/address-finder)
- [Changelog](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder/CHANGELOG.md)

## Documentation

See our full documentation at [docs.ideal-postcodes.co.uk](https://docs.ideal-postcodes.co.uk/docs/address-finder)

## Quick Start

### Install

Add address-finder to your project via npm

```bash
npm install @ideal-postcodes/address-finder
```

### Instantiate

Instantiate Address Finder with [`AddressFinder.setup`](modules/address_finder_exports.html#setup).

```javascript
import { AddressFinder } from "@ideal-postcodes/address-finder";

const controller = AddressFinder.setup({
  apiKey: "ak_test", // API Key from your account
  // Target fields to send selected Address information
  // using CSS selectors
  outputFields: {
    line_1: "#line_1", // Address Finder will attach to line_1
    line_2: "#line_2",
    line_3: "#line_3",
    post_town: "#post_town",
    postcode: "#postcode",
  },
});
```

## Licence

Copyright &copy; IDDQD Limited

---
_Source: https://npm.io/package/@ideal-postcodes/address-finder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._