geoip-country-only v1.1.8

GeoIP-country-only

Stripped down node-geoip. Only supports country lookup and IPv4.

Software is written by Philip Tellis philip@bluesmoon.info, latest version is available at https://github.com/bluesmoon/node-geoip

This is forked from node-geoip-country.

This version relies on a postinstall hook to download the latest country data over https. It also includes a Node4-compatible iconv-lite.

This repository has rebased out all data/ files, so its size is only 890kB. node-geoip is over 170MB.

synopsis

var geoip = require('geoip-lite');

var ip = "207.97.227.239";
var geo = geoip.lookup(ip);

console.log(geo);
{ range: [ 3479299040, 3479299071 ],
  country: 'US',
  region: '' }

installation

1. get the library

$ npm install geoip-country-only

2. get the datafiles

The data files will be updated automatically on postinstall. You can update them yourself by running npm run-script updatedb (recommended on CI servers to bust cache).

API

Looking up an IP address

If you have an IP address in dotted quad notation, IPv6 colon notation, or a 32 bit unsigned integer (treated as an IPv4 address), pass it to the lookup method. Note that you should remove any [ and ] around an IPv6 address before passing it to this method.

var geo = geoip.lookup(ip);

If the IP address was found, the lookup method returns an object with the following structure:

{
   range: [ <low bound of IP block>, <high bound of IP block> ],
   country: 'XX',                 // 2 letter ISO-3166-1 country code
}

The actual values for the range array should be considered internal to geoip-lite. To get a human readable format, pass them to geoip.pretty()

If the IP address was not found, the lookup returns null

Pretty printing an IP address

If you have a 32 bit unsigned integer, or a number returned as part of the range array from the lookup method, the pretty method can be used to turn it into a human readable string.

    console.log("The IP is %s", geoip.pretty(ip));

This method returns a string if the input was in a format that geoip-lite can recognise, else it returns the input itself.

Start and stop watching for data updates

If you have a server running geoip-lite, and you want to update its geo data without a restart, you can enable the data watcher to automatically refresh in-memory geo data when a file changes in the data directory.

geoip.startWatchingDataUpdate();

This tool can be used with npm run-script updatedb to periodically update geo data on a running server.

Built-in Updater

This package contains an update script that can pull the files from MaxMind and handle the conversion from CSV. A npm script alias has been setup to make this process easy. Please keep in mind this requires internet and MaxMind rate limits that amount of downloads on their servers.

npm run-script updatedb

Caveats

This package includes the GeoLite database from MaxMind. This database is not the most accurate database available, however it is the best available for free. You can use the commercial GeoIP database from MaxMind with better accuracy by buying a license from MaxMind, and then using the conversion utility to convert it to a format that geoip-lite understands. You will need to use the .csv files from MaxMind for conversion.

References

• Documentation from MaxMind
• ISO 3166 (1 & 2) codes
• FIPS region codes

Copyright

geoip-lite is Copyright 2011-2012 Philip Tellis philip@bluesmoon.info and the latest version of the code is available at https://github.com/bluesmoon/node-geoip

License

There are two licenses for the code and data. See the LICENSE file for details.