Ideal Postcodes OpenAPI (v3) Specification (api.ideal-postcodes.co.uk)

Features

• OpenAPI v3 specification for api.ideal-postcodes.co.uk
• Exports API Typings

Links

• Github Repository
• API Reference
• OpenAPI v3 Raw Files: JSON
• OpenAPI v3 Raw Files: YAML
• NPM Package

Getting Started

Build Typings

npm run build

Validate Spec

npm test

Download and Access via npm

Install

npm install @ideal-postcodes/openapi

Require specs

JSON and YAML specs can be accessed at node_modules/@ideal-postcodes/openapi/dist/openapi.[json|yaml]

Licence

MIT

4.9.2 (2025-01-22)

Bug Fixes

• Release: Trigger npm release (ed7d92c)

4.9.1 (2025-01-20)

Bug Fixes

• Release: Trigger new release (d9bbada)
• Release: Trigger new release (f6782db)
• Release: Update GitHub action (4850973)

4.9.0 (2025-01-20)

Features

• Denmark: Add SDFI (6602bd5)

4.8.0 (2024-07-10)

Features

• Language: Add Assamese (as) language (7962e54)

4.7.0 (2024-05-21)

Features

• Verify: Improve documentation (dfba777)

4.7.0-beta.1 (2024-05-21)

Features

• Verify: Improve documentation (dfba777)

4.6.2 (2024-05-17)

Bug Fixes

• Keys APIs: Fix user_token, start and end params (ff4249e)

4.6.2-beta.1 (2024-05-17)

Bug Fixes

• Keys APIs: Fix user_token, start and end params (ff4249e)

4.6.1 (2024-05-16)

Bug Fixes

• Verify: Correct field names (b1b52fe)

4.6.1-beta.1 (2024-05-14)

Bug Fixes

• Verify: Correct field names (b1b52fe)

4.6.0 (2024-05-14)

Features

• Verify: Add USPS Verification API (19c08ab)

4.6.0-beta.1 (2024-05-14)

Features

• Verify: Add USPS Verification API (19c08ab)

4.5.0 (2024-04-30)

Features

• Norway: Add Kartverket dataset (33af702)

4.5.0-beta.1 (2024-04-30)

Features

• Norway: Add Kartverket dataset (33af702)

4.4.0 (2024-04-29)

Features

• Netherlands: Add Kadaster (30c03d8)

4.4.0-beta.1 (2024-04-29)

Features

• Netherlands: Add Kadaster (30c03d8)

4.3.0 (2024-02-19)

Bug Fixes

• USPS: Add missing countries (5ba5418)

Features

• Rest of World: Add additional countries (dd13654)

4.3.0-beta.2 (2024-02-19)

Bug Fixes

• USPS: Add missing countries (5ba5418)

4.3.0-beta.1 (2024-01-23)

Features

• Rest of World: Add additional countries (dd13654)

4.2.1 (2023-11-29)

Bug Fixes

• Australia: Fix GNAF schema (d61d229)

4.2.0 (2023-11-29)

Features

• Australia: Add GNAF dataset (644a8c7)

4.1.1 (2023-11-02)

Bug Fixes

• Languages: Add new supported language (af87339)

4.1.0 (2023-09-05)

Features

• Keys: Add new keys endpoint (61c71d3)

4.0.1 (2023-07-07)

Bug Fixes

• ISO Code: Update Country and Language Enums (c95bc3d)

4.0.0 (2023-07-07)

Features

• OpenAPI: Add Global Address datasets (8b23829)

BREAKING CHANGES

• OpenAPI: Some operation IDs (i.e. endpoint identifiers) have been updated to better reflect usage

3.10.0 (2023-04-26)

Features

• Phone: Separate live carrier information (118cc75)

3.9.6 (2023-03-15)

Bug Fixes

• PAF: Extends Postcode Type (77e4bfd)

3.9.5 (2023-03-14)

Bug Fixes

• AB: Require id and dataset (1792c1c)

3.9.4 (2023-03-14)

Bug Fixes

• AB Core: Add ID and dataset fields (a3f8e94)

3.9.3 (2023-03-14)

Bug Fixes

• AB Core: Add country iso (e6710d0)

3.9.2 (2023-03-13)

Bug Fixes

• AB Core: UPRNs delivered as strings (5bf31e1)

3.9.1 (2023-03-13)

Bug Fixes

• AB Core: Add to AB Core to UK endpoints (1b3af9a)

3.9.0 (2023-03-10)

Features

• AB Core: Add AddressBase core (afbd719)

3.8.0 (2023-01-26)

Features

• Cleanse: Add GBR cleanse API (00fd5ef)

3.7.1 (2023-01-20)

Bug Fixes

• Datasets: Add new dataset attributes (681881b)

3.7.0 (2023-01-18)

Features

• Phone: Add carrier information to response payload (b6b826f)

3.6.0 (2023-01-10)

Features

• Eircode: Add Eircode to postcode lookup (969c019)

3.5.1 (2022-12-28)

Bug Fixes

• Phone: Fix typo in URL (a85a556)

3.5.0 (2022-12-16)

Features

• Phone: Add phone validation (244fe91)

3.4.0 (2022-12-08)

Features

• Email: Email verification endpoint (0204f92)

3.3.0 (2022-10-26)

Bug Fixes

• Geonames: Add native data attribute (e063128)
• Geonames: Allow sub admins to be nullable (0d29ddb)
• Geonames: Nullable dem and elevation (7e247a0)
• Geonames: Require country in suggestion (dbd4566)
• Places: Fix typo (0bc36d6)
• Release: Trigger beta release (2205bd6)

Features

• Places: Expose places API (c9cd926)

3.3.0-beta.7 (2022-10-25)

Bug Fixes

• Geonames: Nullable dem and elevation (7e247a0)

3.3.0-beta.6 (2022-10-25)

Bug Fixes

• Geonames: Require country in suggestion (dbd4566)

3.3.0-beta.5 (2022-10-25)

Bug Fixes

• Geonames: Allow sub admins to be nullable (0d29ddb)

3.3.0-beta.4 (2022-10-25)

Bug Fixes

• Geonames: Add native data attribute (e063128)

3.3.0-beta.3 (2022-10-24)

Bug Fixes

• Places: Fix typo (0bc36d6)

3.3.0-beta.2 (2022-10-22)

Bug Fixes

• Release: Trigger beta release (2205bd6)

3.3.0-beta.1 (2022-10-20)

Features

• Places: Expose places API (c9cd926)

3.2.0 (2022-08-17)

Bug Fixes

• ApiKey: Add required attrs (e722fa5)

Features

• Global Addresses: Add native address formats (7fda507)

3.2.0-beta.2 (2022-08-08)

Bug Fixes

• ApiKey: Add required attrs (2ff1c16)

3.2.0-beta.1 (2022-08-03)

Features

• Global Addresses: Add native address formats (d33e770)

3.1.0 (2022-07-19)

Features

• Attributes: Add Language, Country and County Codes (#90) (842547e)

3.1.0-beta.7 (2022-07-10)

Features

• Keys: Update to keys API (cc37080)

3.1.0-beta.6 (2022-06-30)

Bug Fixes

• Bump: Increment version (40d7a02)

3.1.0-beta.5 (2022-06-27)

Bug Fixes

• ECAD: Remove ECAF ID from ECAD (2605bee)
• ECAD: Split locality address type (c3efa32)

3.1.0-beta.4 (2022-06-26)

Bug Fixes

• ECAD: Include ID (4f2a05e)

3.1.0-beta.3 (2022-06-23)

Bug Fixes

• Eircode: Add missing type to Eircbase (0983e6a)

3.1.0-beta.2 (2022-06-22)

Features

• Ireland: Add Eircode Address (1c7e992)

3.1.0-beta.1 (2022-06-12)

Features

• Attributes: Add Language, Country and County Codes (3185f34)

3.0.0 (2022-06-07)

Features

• 3.0.0: API & Dataset Updates (883abc7)
• GBR: Add reverse geocoding parameters (3d5d273)
• PAF Alias: Add PAF Alias (8b42b86)

BREAKING CHANGES

• 3.0.0: - UK Address Suggestion formats for PAF, MR, NYB and PAFW have been merged into one suggestion type for the UK
• Rename GlobalAddressSuggestion to AddressSuggestion

3.0.0-beta.3 (2022-06-02)

Features

• GBR: Add reverse geocoding parameters (3d5d273)

3.0.0-beta.2 (2022-06-01)

Features

• PAF Alias: Add PAF Alias (8b42b86)

3.0.0-beta.1 (2022-05-04)

Features

• 3.0.0: API & Dataset Updates (883abc7)

BREAKING CHANGES

• 3.0.0: - UK Address Suggestion formats for PAF, MR, NYB and PAFW have been merged into one suggestion type for the UK
• Rename GlobalAddressSuggestion to AddressSuggestion

2.1.1 (2022-05-03)

Bug Fixes

• Spec: Bump version (2454a15)

2.1.0 (2022-05-03)

Features

• UK: Add Welsh PAF responses (39d7452)

2.1.0-beta.1 (2022-04-24)

Features

• UK: Add Welsh PAF responses (39d7452)

2.0.1 (2022-04-21)

Bug Fixes

• Exports: Include TS file in package (ac9bc2c)

2.0.0 (2022-04-20)

Code Refactoring

• Intl Address: Reorganise for international addresses (ffabeb0)

BREAKING CHANGES

• Intl Address: Major version bump as a precaution

API Paths have been retagged and reorganised. This should not cause a change in functionality but we have noticed changes of this type can sometimes produce a backwards incompatible change in API interface if this package is consumed by a code generator.

1.2.0 (2022-04-05)

Bug Fixes

• USPS: Add country (2c935dd)
• USPS: Add dual data types (9491cae)
• USPS: Add USPS schema definitions (eae2cf5)
• USPS: Narrow USPS typings (c29aeaa)
• USPS: Update definitions (22d1023)

Features

• Mocks: Embed mock server (b7bb5b9)
• USPS: Resolve addresses formated to US spec (e67e728)

1.2.0-beta.4 (2022-04-03)

Bug Fixes

• USPS: Add country (2c935dd)

1.2.0-beta.3 (2022-04-03)

Bug Fixes

• USPS: Narrow USPS typings (c29aeaa)

1.2.0-beta.2 (2022-03-31)

Bug Fixes

• USPS: Add dual data types (9491cae)

1.2.0-beta.1 (2022-03-30)

Bug Fixes

• USPS: Add USPS schema definitions (eae2cf5)
• USPS: Update definitions (22d1023)

Features

• Mocks: Embed mock server (b7bb5b9)
• USPS: Resolve addresses formated to US spec (e67e728)

1.1.0-beta.6 (2022-03-29)

Bug Fixes

• USPS: Add USPS schema definitions (e9d07bf)

1.1.0-beta.5 (2022-03-28)

Features

• Mocks: Embed mock server (5e65331)
• USPS: Resolve addresses formated to US spec (4a2d71d)

1.1.0 (2022-02-08)

Bug Fixes

• Keys API: Fix typo (8a04adf)
• Postcodes: Enforce union type for postcodes response (78ae451)

Features

• USPS: Add USPS typings (887bd40)
• Version: Release beta branch (d21166e)

1.1.0-beta.4 (2022-02-02)

Bug Fixes

• Postcodes: Enforce union type for postcodes response (770576d)

1.1.0-beta.3 (2022-02-02)

Bug Fixes

• Keys API: Fix typo (0536732)

1.1.0-beta.2 (2022-02-02)

Features

• USPS: Add USPS typings (bbc7981)

1.1.0-beta.1 (2022-02-02)

Features

• Version: Release beta branch (7f13388)

1.0.2 (2021-09-28)

Bug Fixes

• Params: tags, datasets (514e9d9)

1.0.1 (2021-09-21)

Bug Fixes

• Dependant: Dependent => Dependant (98bc5b7), closes #24

1.0.0 (2021-08-30)

Features

• Rewrite: Rewrite OpenAPI Spec (d2926aa)
• Typings: Ship OpenAPI typings (994754a)

BREAKING CHANGES

• Rewrite: Full OpenAPI spec served from dist/

Changelog

Any changes, including backwards incompatible changes will be listed here

master

• Fix error response schema on /postcodes/:postcode

1.0.0 (16/04/2019)

• Initial release