To help you get started, we've collected the most common ways that maxmind is being used within popular public projects.

runk / node-maxmind / examples / city.js View on Github

var maxmind = require('maxmind');
maxmind.init(__dirname + '/GeoLiteCity.dat');

// The returned location object has the following properties:
// countryCode, countryName, region, city, latitude, longitude
// postalCode, metroCode, dmaCode, areaCode
console.log('Location:', maxmind.getLocation('66.6.44.4'));

View more ways to use maxmind

node-maxmind

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 using other formats.

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

import maxmind, { CityResponse } from 'maxmind';

const lookup = await maxmind.open('/path/to/GeoLite2-City.mmdb');
console.log(lookup.get('66.6.44.4')); // inferred type maxmind.CityResponse

console.log(lookup.getWithPrefixLength('66.6.44.4')); // tuple with inferred type [maxmind.CityResponse|null, number]

Sync API

You can use Reader class directly in case if you would want to instantiate it in non-async fashion. Use cases would include receiving a buffer database over network, or just reading it synchronously from disk.

import { Reader } from 'maxmind';
const buffer = fs.readFileSync('./db.mmdb');
const lookup = new Reader(buffer);
const city = lookup.get('8.8.8.8');

const [city2, prefixLength] = lookup.getWithPrefixLength('66.6.44.4');

Supported response types:

- CountryResponse
- CityResponse
- AnonymousIPResponse
- AsnResponse
- ConnectionTypeResponse
- DomainResponse
- IspResponse

IPv6 Support

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

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

Options

maxmind.open(filepath, [options])

• filepath: `` Path to the binary mmdb database file.
• options: ``
  • cache: `` Cache options. Under the bonnet module uses tiny-lru cache.
    • max: `` Max cache items to keep in memory. Default: 10_000.
  • watchForUpdates: `` Supports reloading the reader when changes occur to the database that is loaded. Default: false.
  • watchForUpdatesNonPersistent: `` Controls whether the watcher should be persistent or not. If it is persistent, a node process will be blocked in watching state if the watcher is the only thing still running in the program. Default: false.
  • watchForUpdatesHook: `` Hook function that is fired on database update. Default: null.

Does it work in browser?

Current module is designed to work in node.js environment. Check out mmdb-lib that's used under the bonnet - it's environment agnostic and does work in browser.

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

• MMDB library
• MaxMind DB file format specification https://maxmind.github.io/MaxMind-DB/
• MaxMind test/sample DB files https://github.com/maxmind/MaxMind-DB
• GeoLite2 Free Downloadable Databases https://dev.maxmind.com/geoip/geoip2/geolite2/
• Great talk about V8 performance https://www.youtube.com/watch?v=UJPdhx5zTaw
• V8 Optimization killers https://github.com/petkaantonov/bluebird/wiki/Optimization-killers
• More V8 performance tips https://www.html5rocks.com/en/tutorials/speed/v8/

License

MIT