Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.47 KB

README.md

File metadata and controls

78 lines (59 loc) · 2.47 KB

PostcodesIo

A simple wrapper around postcodes.io

Installation

Add this line to your application's Gemfile:

gem 'postcodes_io'

And then execute:

$ bundle

Or install it yourself as:

$ gem install postcodes_io

Usage

Require the gem

require 'PostcodesIO'

Create new instance of the Postcodes::IO

pio = Postcodes::IO.new

Lookup a postcode

postcode = pio.lookup('NN12 8TN')

Inspect the results!

postcode.longitude # -1.02144562675883
postcode.latitude # 52.0776806788868

##All available fields

name description
postcode pretty formatted postcode
quality 1-9 value of the quality of the grid reference
eastings OS grid reference
northings OS grid reference
country The code for the appropriate country
nhs_ha The health area code for the postcode
admin_county The county the postcode has been assigned
admin_district The current district/unitary authority to which the postcode has been assigned
admin_ward The current administrative/electoral area to which the postcode has been assigned
longitude The WGS84 longitude
latitude The WGS84 latitude
parliamentary_constituency he Westminster Parliamentary Constituency
european_electoral_region The European Electoral Region code
primary_care_trust The code for the Primary Care area
region former GORs
parish The smallest type of administrative area
lsoa The 2011 Census lower layer SOA code
msoa [The 2011 Census middle layer SOA (MSOA) code](The 2011 Census lower layer SOA code for England and Wales](http://www.ons.gov.uk/ons/guide-method/geography/beginner-s-guide/census/super-output-areas--soas-/index.html)
ccg Clinical Commissioning Group
nuts see here

For more details see the documentation on postcodes.io

Contributing

  1. Fork it ( https://github.com/[my-github-username]/postcodes_io/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request