shabbirh/postcodes.io

UK postcode & geolocation API, serving up open data

UK postcode & geolocation API, serving up open data

Query for UK postcodes and geolocations over HTTP.

Postcodes.io regularly ingests and serves the ONS Postcode Directory and Ordnance Survey Open Names datasets.

Features

• Postcode lookup, resolve administrative and location data for postcodes and outward codes
• Postcode search & autocomplete
• Reverse geocode postcodes
• Nearest postcode search
• Terminated postcode search
• Outward code lookup
• Bulk postcode lookup and reverse geocoding

Usage

• Public API
• API Documentation
• 3rd Party API Clients
• Public API Service Status
• Self Hosting
• Self Hosting: Docker containers
  • Docker Hub Container Image: Postcodes.io Application
  • Docker Hub Container Image: Postcodes.io Database
• Self Hosting: Node.js and Postgresql
• Self Hosting: Database only - Download and import the raw dataset to Postgresql
• Explore
• Chat

Quick Start

Start querying UK postcode data immediately on your local machine with Docker

docker-compose up

Testing

# Run entire test suite
make test

# Launch test application container and services, and run tests from container
make test-up
make test-shell
$api-container> npm test

License

MIT