Skip to content

kilikilikid/postcodes.io

 
 

Repository files navigation

Postcodes.io

UK postcode & geolocation API, serving up open data

CI codecov Dependency Status DOI

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

Quick Start

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

docker-compose up

Docker Compose Demo

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

About

UK postcode & geolocation API, serving up open data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 80.7%
  • JavaScript 9.2%
  • EJS 6.6%
  • Shell 1.5%
  • CSS 1.1%
  • Makefile 0.6%
  • Dockerfile 0.3%