Skip to content

UK postcode & geolocation API, serving up open data

License

Notifications You must be signed in to change notification settings

commonknowledge/postcodes.io-future

This branch is 111 commits behind ideal-postcodes/postcodes.io:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

babb3ea · Aug 29, 2023
Aug 25, 2022
Aug 25, 2022
Aug 24, 2023
Aug 25, 2022
Jan 4, 2023
Aug 24, 2023
Aug 24, 2023
Aug 29, 2023
Oct 29, 2018
Mar 23, 2019
Dec 9, 2020
Dec 9, 2020
Dec 16, 2022
Aug 24, 2023
Aug 25, 2022
Dec 7, 2018
Sep 29, 2017
Dec 9, 2020
Jun 25, 2023
Dec 9, 2020
Aug 24, 2023
Jun 10, 2023
Mar 11, 2023
Dec 9, 2020
Dec 9, 2020

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

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages

  • TypeScript 81.3%
  • JavaScript 9.8%
  • EJS 5.5%
  • Shell 1.4%
  • CSS 1.1%
  • Makefile 0.6%
  • Dockerfile 0.3%