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

    maxmindpublic

    node-maxmind Build Status

    Pure Javascript module for Geo IP lookup using Maxmind binary databases (aka mmdb or geoip2). Fastest Maxmind lookup library available - up to 17,000% faster than other libraries. Module has 100% test coverage with comprehensive test suite. It natively works with binary Maxmind database format and doesn't require any "CSV - {specific lib format}" conversions as some other modules do. Maxmind binary databases are highly optimized for size and performance so there's no point working with other than that format.

    GEO databases

    You might want to use geolite2 module with free geo databases. Alternatively, free databases available for download here. If you need better accuracy you should consider buying commercial subscription.

    Installation

    npm i maxmind

    Usage

    var maxmind = require('maxmind');
     
    maxmind.open('/path/to/GeoLite2-City.mmdb', (err, cityLookup) => {
      var city = cityLookup.get('66.6.44.4');
    });
     
    maxmind.open('/path/to/GeoOrg.mmdb', (err, orgLookup) => {
      var city = orgLookup.get('66.6.44.4');
    });
     
    // Be careful with sync version! Since mmdb files
    // are quite large (city database is about 100Mb)
    // `fs.readFileSync` blocks whole process while it
    // reads file into buffer.
     
    var cityLookup = maxmind.openSync('/path/to/GeoLite2-City.mmdb');
    var city = cityLookup.get('66.6.44.4');
     
    var orgLookup = maxmind.openSync('/path/to/GeoOrg.mmdb');
    var organization = orgLookup.get('66.6.44.4');

    V6 Support

    Module is fully compatible with IPv6. There are no differences in API between IPv4 and IPv6.

    var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb');
    var location = lookup.get('2001:4860:0:1001::3004:ef68');

    Options

    cache

    Module uses tiny-lru. You can configure its settings by doing following:

    var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', {
      cache: {
        max: 500, // Max items in cache, by default it's 6000
      }
    });
    lookup.get('1.1.1.1');

    watchForUpdates

    Supports reloading the reader when changes occur to the database that is loaded. (default false). Only supported by Node v0.5.10+.

    var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', { watchForUpdates: true });
    lookup.get('1.1.1.1');

    Also, you can specify custom hook function on database update.

    var opts = {
      watchForUpdates: true,
      watchForUpdatesHook: () => { console.log('database updated!'); },
    };
    var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', opts);
    lookup.get('1.1.1.1');

    IP addresses validation

    Module supports validation for both IPv4 and IPv6:

    maxmind.validate('66.6.44.4'); // returns true
    maxmind.validate('66.6.44.boom!'); // returns false
     
    maxmind.validate('2001:4860:0:1001::3004:ef68'); // returns true
    maxmind.validate('2001:4860:0:1001::3004:boom!'); // returns false

    GeoIP Legacy binary format

    In case you want to use legacy GeoIP binary databases you should use maxmind@0.6.

    References

    License

    MIT

    install

    npm i maxmind

    Downloadsweekly downloads

    12,903

    version

    2.6.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar