Build with public data

Developer documentation

Start with the contract

The version 1.0.0 OpenAPI specification defines request parameters, response schemas, authentication and errors. Review the contract before integrating.

Your first lookup

  1. Read how API-key authentication is specified.
  2. Review the postcode endpoint and upstream integration preview.
  3. Download the OpenAPI specification for the complete reference.

Separate contract from preview

The explorer calls public postcodes.io only when you submit a postcode. It is not a BritDatum data response and accepts no API keys.