ip-location

Fetch the location of an IP address, host name, or your own location.

Uses freegeoip.net to query for information. freegeoip.net uses MaxMind Geolite 2.

Install

npm i --save ip-location

Usage

With Callbacks

var ipLocation = require('ip-location')

ipLocation('github.com', function (err, data) {
  console.log(data)
})

Outputs:

{ ip: '192.30.252.129',
  country_code: 'US',
  country_name: 'United States',
  region_code: 'CA',
  region_name: 'California',
  city: 'San Francisco',
  zip_code: '94107',
  time_zone: 'America/Los_Angeles',
  latitude: 37.7697,
  longitude: -122.3933,
  metro_code: 807 }

With Promises

var ipLocation = require('ip-location')

ipLocation('github.com')
.then(function (data) {
  console.dir(data)
})
.catch(function (err) {
  console.error(err)
})

Set Your Own Promise Implementation

You can set your own Promise library if you want to use Bluebird or are using Node v0.10.

var ipLocation = require('ip-location')

ipLocation.Promise = require('bluebird')

Use in Browser / or Use Own HTTP Library

If you want to use this in the browser, you must bring your own http GET library to the party. I'd recommend: xhr or fetch.

var ipLocation = require('ip-location')

ipLocation.httpGet = function (url, callback) {
  fetch(url).then(function (resp) {
    return resp.text() // don't use json()
  }).then(function (text) {
    resp.body = text // body should always be set to a string
    callback(null, resp)
  }).catch(function (err) {
    callback(err)
  })
}

Fetch Your Location

Just pass in an empty string.

ipLocation('', function (err, myLocation) {
  console.dir(myLocation)
})

Related

• ip-location-cli - Command line utility for this module.

License

MIT - Copyright (c) JP Richardson