Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

cities

1.1.2 • Public • Published

Cities

Circle CI

Cities is an easy to use Node.js library to allow you to lookup a city by it's zipcode or by a set of GPS coordinates (reverse geocoding).

At the moment, this package only supports US cities only. There are plans to extend this in the next version.

Usage

Webservice

Like any node.js application.

npm install
node server.js

You can then visit http://localhost:4000 with the endpoints /gps/:lat/:lng or /zip/:zipcode to get locations.

Install

npm install cities --save

Usage

var cities = require('cities');

Lookup by GPS coordinates

cities.gps_lookup(lat, lng);

Lookup by zipcode

cities.zip_lookup(zipcode);

Lookup by state

cities.findByState('NJ')

Sample Response

A sample response or object that this module returns looks like this.

{
    zipcode: "07946",
    state_abbr: "NJ",
    latitude: "40.672823",
    longitude: "-74.52011",
    city: "Millington",
    state: "New Jersey"
}

License

MIT.

Keywords

none

install

npm i cities

Downloadsweekly downloads

207

version

1.1.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar