node-maxmind

IP geo lookup using Maxmind databases, written in pure javascript with no dependencies.

GEO databases

You can download free geo databases here: http://dev.maxmind.com/geoip/geolite.

Installation

npm install maxmind

Main features

• Location lookup
• Country lookup
• Distance between two IP addresses (locations)
• Timezone lookup by IP
• Autonomous System Numbers (ASN) lookup

Usage

** see code samples in ./examples directory **

City/Location lookup

    var maxmind = require('maxmind');
    maxmind.init('/path/to/GeoLiteCity.dat');
    console.log(maxmind.getLocation("66.6.44.4"));

Country Lookup

    var maxmind = require('maxmind');
    maxmind.init('/path/to/GeoIP.dat');
    console.log(maxmind.getCountry("66.6.44.4"));

Autonomous System Numbers (ASN) lookup

    var maxmind = require('maxmind');
    maxmind.init('/path/to/GeoIPASNum.dat');
    console.log(maxmind.getOrganization("66.6.44.4"));

You can initialize module with several databases, and they will be automatically selected for particular queries. If any options given they apply for all databases you initialize.

    var maxmind = require('maxmind');
    maxmind.init(['/path/to/GeoLiteCity.dat', '/path/to/GeoIPASNum.dat']);
    // now both org and location lookups will work
    console.log(maxmind.getOrganization("66.6.44.4"));
    console.log(maxmind.getLocation("66.6.44.4"));

Caching

By default module does not use cache, and works directly with file system. Enabling cache leads to better performance, howerver consumer more memory. Currently module supports two options:

• indexCache saves in memory only the country index
• memoryCache saves in memory full database file

If you decided to enable caching you can pass it as a flag in init method:

    var maxmind = require('maxmind');
    maxmind.init('/path/to/GeoIP.dat', { indexCache: true });

Caching could significantly increase performance, refer to this camparison which was made on average laptop:

• default: 18,000 lookups / second
• indexCache: 80,000 lookups / second
• memodyCache: 130,000 lookups / second

Tests

If you want ot run tests you will need mocha installed, then just run it:

$ mocha

Disclaimer

Module is quite young and serious bugs are possible. Feel free to send pull request / bug reports.