Postcodes.io

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

Contributions and Github issues are welcome.

Documentation can be found at postcodes.io

Requirements

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

Installation

Download it

$ git clone https://github.com/ideal-postcodes/postcodes.io.git

$ cd postcodes.io/

$ npm install

Configure it

Update config/config.js with your Postgres credentials.

Import ONS Postcode Data

In order to import Ordnance Survey CSV dataset to Postgres, the specified user in config/config.js must also be superuser during the import process. You will also need to have the PostGIS extension availble.

Download the latest Office for National Statistic's "Postcode Lookup Dataset" (in CSV here). Unzip the data locally. Navigate to postcodes.io/ 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

Testing

npm test

License

MIT