Get geolocation 🌐 information about an IP πŸ“²
Clone or download
VikramTiwari Merge pull request #31 from VikramTiwari/greenkeeper/debug-4.0.0
Update debug to the latest version πŸš€
Latest commit 951a3d9 Sep 12, 2018

README.md

geo-from-ip

Get geolocation 🌐 information about an IP πŸ“²

Build Status NPM Version NPM Download

Features

  • No frills install πŸš€
  • Downloads databases automatically during installation πŸ”‹
  • Run npm install to upgrade databases == automatic update on deployments πŸ’Ž

How to use

  • Include package in your project
npm install --save geo-from-ip
# or, if you are using yarn
yarn add --save geo-from-ip
  • Use package to get geo data from IP
const geoip = require('geo-from-ip')
console.log(geoip.allData('199.188.195.120'))

/*
{ code: { state: 'CA', country: 'US', continent: 'NA' },
  city: 'San Francisco',
  state: 'California',
  country: 'United States',
  continent: 'North America',
  postal: '94103',
  location:
   { accuracy_radius: 10,
     latitude: 37.7758,
     longitude: -122.4128,
     metro_code: 807,
     time_zone: 'America/Los_Angeles' } }
 */
  • Update database

Database will get automatically updated every time deployment happens. But if you would like to force an update, just run:

npm install
# or, if you are using yarn
yarn

Debugging / Developing

Run your code using geo-from-ip as debug flag. Look into pacakge.json for example.

Credits

Developer: πŸ‘¨β€πŸ’» Vikram Tiwari

If you found this library helpful, or learned something from it and want to thank me, consider buying me a cup of β˜•οΈ.

Database: Max-Mind

This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com