Public | Automated Build

Last pushed: 3 years ago
Short Description
Short description is empty for this repo.
Full Description

Open source postcode API server using Codepoint Open and ONS Postcode Data.

Contributions and Github issues are welcome.

Documentation can be found at


  • Node 0.10
  • Postgres (>= 9.1) with PostGIS extension


Download it

$ git clone

$ cd

$ npm install && npm link

Configure Postgres

Ensure you have Postgres and with PostGIS extension availble. Create a new database and a super user.

Update config/config.js with the above Postgres credentials. Pass in a postgresql superuser for the import process (you can swap this with a user with reduced privileges later). You may update the config object for the development environment for simplicity.

Import ONS Postcode Data

Download the latest Office for National Statistic's "Postcode Lookup Dataset" (in CSV here). Unzip the data locally. Navigate to and run importons passing the path to the CSV data.

It should look something like this:

$ importons /path/to/data/ONSPD/Data/data.csv

The import process takes around 10 minutes to complete.

Run it

node server.js

// Default environment is development (NODE_ENV=development)


npm test



Docker Pull Command
Source Repository