https://github.com/ideal-postcodes/postcodes.io

UK postcode & geolocation API, serving up open data
https://github.com/ideal-postcodes/postcodes.io

Last synced: about 1 month ago
JSON representation

UK postcode & geolocation API, serving up open data

• Host: GitHub
• URL: https://github.com/ideal-postcodes/postcodes.io
• Owner: ideal-postcodes
• License: mit
• Created: 2014-01-17T01:48:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-28T20:45:57.000Z (6 months ago)
• Last Synced: 2024-05-29T06:41:43.297Z (6 months ago)
• Language: TypeScript
• Homepage: https://postcodes.io
• Size: 123 MB
• Stars: 1,197
• Watchers: 27
• Forks: 238
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



> UK postcode & geolocation API, serving up open data

![CI](https://github.com/ideal-postcodes/postcodes.io/workflows/CI/badge.svg)

[![DOI](https://zenodo.org/badge/15987081.svg)](https://zenodo.org/badge/latestdoi/15987081)

Query for UK postcodes and geolocations over HTTP.

Postcodes.io regularly ingests and serves the [ONS Postcode Directory](https://geoportal.statistics.gov.uk/search?collection=Dataset&sort=-created&tags=onspd) and [Ordnance Survey Open Names](https://www.ordnancesurvey.co.uk/products/os-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](https://postcodes.io)

- [API Documentation](https://postcodes.io/docs)

- [3rd Party API Clients](https://postcodes.io/about)

- [Public API Service Status](https://status.ideal-postcodes.co.uk)

- [Self Hosting: Docker containers](https://postcodes.io/docs#docker-install)

  - [Docker Hub Container Image: Postcodes.io Application](https://hub.docker.com/r/idealpostcodes/postcodes.io)

  - [Docker Hub Container Image: Postcodes.io Database](https://hub.docker.com/r/idealpostcodes/postcodes.io.db)

## Quick Start

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

```bash

docker-compose up

```



  



## Testing

```bash

# 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