# @ideal-postcodes/openapi

> Ideal Postcodes OpenAPI v3 specifications

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

## Install

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

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.1.1 |
| Published | 2026-10-02 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ideal Postcodes |
| Maintainers | cablanchard, piotrideal |
| Keywords | Ideal Postcodes, OpenAPI, UK, Addressing, Royal, Mail, PAF |

## Links

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

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 5.1.1 (latest) — 2026-10-02
- 4.17.0-beta.1 (beta) — 2026-04-23
- 5.1.0 — 2026-09-29
- 5.0.2 — 2026-09-28
- 5.0.1 — 2026-09-22
- 5.0.0 — 2026-09-17
- 4.21.0 — 2026-08-20
- 4.20.0 — 2026-07-01
- 4.19.0 — 2026-06-23
- 4.18.1 — 2026-05-28
- 4.18.0 — 2026-05-25
- 4.17.0 — 2026-04-23
- 4.16.1 — 2026-03-26
- 4.16.0 — 2026-03-26
- 4.15.2 — 2026-02-04
- … 103 more at https://npm.io/package/@ideal-postcodes/openapi/versions

## README

# Ideal Postcodes OpenAPI

OpenAPI 3 specification for [api.ideal-postcodes.co.uk](https://api.ideal-postcodes.co.uk), with TypeScript types generated from it. Published to npm as [`@ideal-postcodes/openapi`](https://www.npmjs.com/package/@ideal-postcodes/openapi).

## Links

- [API reference](https://openapi.ideal-postcodes.co.uk), rendered from this spec
- Raw spec: [openapi.json](https://openapi.ideal-postcodes.co.uk/openapi.json), [openapi.yaml](https://openapi.ideal-postcodes.co.uk/openapi.yaml)
- [Documentation](https://docs.ideal-postcodes.co.uk)
- [Changelog](./CHANGELOG.md)

## Install

```bash
npm install @ideal-postcodes/openapi
```

## Use

```ts
import type { paths, components } from "@ideal-postcodes/openapi";

type Address = components["schemas"]["Address"];
type LookupPostcode = paths["/postcodes/{postcode}"]["get"];
```

The spec files ship inside the package at `node_modules/@ideal-postcodes/openapi/dist/openapi.json` and `dist/openapi.yaml`.

## Files

- `openapi.json`, `openapi.yaml`: the specification, stamped with the released version
- `openapi.ts`: types generated with openapi-typescript. Not hand-edited
- `aliases.ts`, `index.ts`: hand-written type aliases and the package entry point

## Source

This repository is a read-only release mirror. Each tag matches the npm version and adds one commit. There is no build here; the npm package carries the compiled output.

The spec is generated from the API source, so pull requests against these files cannot be merged directly. Open an issue or a pull request and a maintainer will apply the change upstream and release it.

For anything involving your account, keys or sensitive data, email support@ideal-postcodes.co.uk rather than opening an issue.

## Licence

See [LICENSE](./LICENSE).

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