maxmind/GeoIP2-nodePublic

NotificationsYou must be signed in to change notification settings
Fork23
Star260

Node.js API for GeoIP2 webservice client and database reader

License

Apache-2.0 license

260 stars 23 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,275 Commits
.github		.github
bin		bin
e2e		e2e
fixtures		fixtures
git		git
src		src
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitmodules		.gitmodules
.precious.toml		.precious.toml
.prettierignore		.prettierignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.dev.md		README.dev.md
README.md		README.md
eslint.config.mjs		eslint.config.mjs
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
prettier.config.mjs		prettier.config.mjs
tsconfig.eslint.json		tsconfig.eslint.json
tsconfig.json		tsconfig.json

Repository files navigation

MaxMind GeoIP2 Node.js API

Description

This package provides a server-side API for theGeoIP2 databases and GeoLite2databases, and a server-sideAPI for theGeoIP2 web services and GeoLite2 webservices.

This package will not work client-side.

Installation

npm install @maxmind/geoip2-node

You can also useyarn orpnpm.

IP Geolocation Usage

IP geolocation is inherently imprecise. Locations are often near the center ofthe population. Any location provided by a GeoIP2 database or web serviceshould not be used to identify a particular address or household.

Web Service Usage

To use the web service API, you must create a newWebServiceClient, usingyour MaxMindaccountID andlicenseKey as parameters. The third argument isan object holding additional option. Thetimeout option defaults to3000.Thehost option defaults togeoip.maxmind.com. Sethost togeolite.infoto use the GeoLite2 web service instead of GeoIP2. Sethost tosandbox.maxmind.com to use the Sandbox environment.

You may then call the function corresponding to a specific end point, passing itthe IP address you want to lookup.

If the request succeeds, the function's Promise will resolve with the modelfor the end point you called. This model in turn contains multiplerecords, each of which represents part of the data returned by the web service.

If the request fails, the function's Promise will reject with an error object.

See theAPI documentation formore details.

Web Service Example

Country Service

constWebServiceClient=require('@maxmind/geoip2-node').WebServiceClient;// Typescript:// import { WebServiceClient } from '@maxmind/geoip2-node';// To use the GeoLite2 web service instead of the GeoIP2 web service, set// the host to geolite.info, e.g.:// new WebServiceClient('1234', 'licenseKey', {host: 'geolite.info'});//// To use the Sandbox GeoIP2 web service instead of the production GeoIP2// web service, set the host to sandbox.maxmind.com, e.g.:// new WebServiceClient('1234', 'licenseKey', {host: 'sandbox.maxmind.com'});constclient=newWebServiceClient('1234','licenseKey');client.country('142.1.1.1').then(response=>{console.log(response.country.isoCode);// 'CA'});

City Plus Service

constWebServiceClient=require('@maxmind/geoip2-node').WebServiceClient;// Typescript:// import { WebServiceClient } from '@maxmind/geoip2-node';// To use the GeoLite2 web service instead of the GeoIP2 web service, set// the host to geolite.info, e.g.:// new WebServiceClient('1234', 'licenseKey', {host: 'geolite.info'});constclient=newWebServiceClient('1234','licenseKey');client.city('142.1.1.1').then(response=>{console.log(response.country.isoCode);// 'CA'console.log(response.postal.code);// 'M5S'});

Insights Service

constWebServiceClient=require('@maxmind/geoip2-node').WebServiceClient;// Typescript:// import { WebServiceClient } from '@maxmind/geoip2-node';// Note that the Insights web service is only supported by the GeoIP2// web service, not the GeoLite2 web service.//// To use the Sandbox GeoIP2 web service instead of the production GeoIP2// web service, set the host to sandbox.maxmind.com, e.g.:// new WebServiceClient('1234', 'licenseKey', {host: 'sandbox.maxmind.com'});constclient=newWebServiceClient('1234','licenseKey');client.insights('142.1.1.1').then(response=>{console.log(response.country.isoCode);// 'CA'console.log(response.postal.code);// 'M5S'console.log(response.traits.userType);// 'school'});

Web Service Errors

For details on the possible errors returned by the web service itself,seethe GeoIP2 web service documentation.

If the web service returns an explicit error document, the promise will be rejectedwith the following object structure:

{code:'THE_ERROR_CODE',error:'some human readable error',url:'https://geoip.maxmind.com...',}

In addition to the possible errors returned by the web service, the following errorcodes are provided:

SERVER_ERROR for 5xx level errors
HTTP_STATUS_CODE_ERROR for unexpected HTTP status codes
INVALID_RESPONSE_BODY for invalid JSON responses or unparseable response bodies
NETWORK_TIMEOUT for network request timeouts
FETCH_ERROR for internalfetch errors

Database Usage

The database reader returns a promise that resolves with a reader instance.You may then call the function corresponding to the request type (e.g.city orcountry), passing it the IP address you want to look up.

If the request succeeds, the function call will return an object for the GeoIP2lookup. The object in turn contains multiple record objects, each of whichrepresents part of the data returned by the database.

Options

We use thenode-maxmind library as thedatabase reader. As such, you have access to the sameoptions found in that libraryand can be used like this:

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';constoptions={// you can use options like `cache` or `watchForUpdates`};Reader.open('/usr/local/database.mmdb',options).then(reader=>{console.log(reader.country('1.1.1.1'));});

Using a Buffer

If you prefer to use aBuffer instead of using aPromise to open thedatabase, you can useReader.openBuffer(). Use cases include:

You want to open the database in a synchronous manner.
You want to fetch the database from an external source.

constfs=require('fs');constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';constdbBuffer=fs.readFileSync('/usr/local/city-database.mmdb');constreader=Reader.openBuffer(dbBuffer);console.log(reader.city('1.1.1.1'));

Database Examples

Anonymous IP Database Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-Anonymous-IP.mmdb').then(reader=>{constresponse=reader.anonymousIP('85.25.43.84');console.log(response.isAnonymous);// trueconsole.log(response.isAnonymousVpn);// falseconsole.log(response.isHostingProvider);// trueconsole.log(response.isPublicProxy);// falseconsole.log(response.isResidentialProxy);// falseconsole.log(response.isTorExitNode);// falseconsole.log(response.ipAddress);// '85.25.43.84'});

Anonymous Plus Database Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP-Anonymous-Plus.mmdb').then(reader=>{constresponse=reader.anonymousPlus('85.25.43.84');console.log(response.anonymizerConfidence);// 30console.log(response.isAnonymous);// trueconsole.log(response.isAnonymousVpn);// falseconsole.log(response.isHostingProvider);// trueconsole.log(response.isPublicProxy);// falseconsole.log(response.isResidentialProxy);// falseconsole.log(response.isTorExitNode);// falseconsole.log(response.ipAddress);// '85.25.43.84'console.log(response.networkLastSeen);// '2025-04-14'console.log(response.providerName);// 'FooBar VPN'});

ASN Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoLite2-ASN.mmdb').then(reader=>{constresponse=reader.asn('128.101.101.101');console.log(response.autonomousSystemNumber);// 217console.log(response.autonomousSystemOrganization);// 'University of Minnesota'});

City Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-City.mmdb').then(reader=>{constresponse=reader.city('128.101.101.101');console.log(response.country.isoCode);// 'US'console.log(response.city.names.en);// 'Minneapolis'console.log(response.postal.code);// '55407'});

Connection-Type Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-Connection-Type.mmdb').then(reader=>{constresponse=reader.connectionType('128.101.101.101');console.log(response.connectionType)// 'Cable/DSL'console.log(response.ipAddress)// '128.101.101.101'});

Country Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-Country.mmdb').then(reader=>{constresponse=reader.country('128.101.101.101');console.log(response.country.isoCode);// 'US'});

Domain Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-Domain.mmdb').then(reader=>{constresponse=reader.domain('128.101.101.101');console.log(response.domain)// 'umn.edu'console.log(response.ipAddress)// '128.101.101.101'});

Enterprise Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-Enterprise.mmdb').then(reader=>{constresponse=reader.enterprise('128.101.101.101');console.log(response.country.isoCode)// 'US'});

ISP Example

constReader=require('@maxmind/geoip2-node').Reader;// Typescript:// import { Reader } from '@maxmind/geoip2-node';Reader.open('/usr/local/share/GeoIP/GeoIP2-ISP.mmdb').then(reader=>{constresponse=reader.isp('128.101.101.101');console.log(response.autonomousSystemNumber);// 217console.log(response.autonomousSystemOrganization);// 'University of Minnesota'console.log(response.isp);// 'University of Minnesota'console.log(response.organization);// 'University of Minnesota'console.log(response.ipAddress);// '128.101.101.101'});

Database Exceptions

If the database file does not exist, is not readable, is invalid, or there is a bugin the reader, the promise will be rejected with anError with a messageexplaining the issue.

If the database file and the reader method do not match (e.g.reader.city is used with a Country database), aBadMethodCalledError willbe thrown.

If the IP address is not found in the database, anAddressNotFoundError willbe thrown.

If the IP address is not valid, aValueError will be thrown.

If the database buffer is not a valid database, anInvalidDbBufferError willbe thrown.

Values to use for Database or Object Keys

We strongly discourage you from using a value from anynames property as akey in a database or object.

These names may change between releases. Instead we recommend using one of thefollowing:

geoip2-node.CityRecord -city.geonameId
geoip2-node.ContinentRecord -continent.code orcontinent.geonameId
geoip2-node.CountryRecord and geoip2.records.RepresentedCountry -country.isoCode orcountry.geonameId
geoip2-node.SubdivisionsRecord -subdivision.isoCode orsubdivision.geonameId

What data is returned?

While many of the models contain the same basic records, the attributes whichcan be populated vary between web service end points or databases. In addition,while a model may offer a particular piece of data, MaxMind does not alwayshave every piece of data for any given IP address.

Because of these factors, it is possible for any request to return a recordwhere some or all of the attributes are unpopulated.

The only piece of data which is always returned is theipAddress attribute inthegeoip2-node.TraitsRecord record.

Integration with GeoNames

GeoNames offers web services and downloadabledatabases with data on geographical features around the world, includingpopulated places. They offer both free and paid premium data. Each featureis uniquely identified by ageonameId, which is an integer.

Many of the records returned by the GeoIP web services and databases include ageonameId field. This is the ID of a geographical feature (city, region,country, etc.) in the GeoNames database.

Some of the data that MaxMind provides is also sourced from GeoNames. We sourcethings like place names, ISO codes, and other similar data from the GeoNamespremium data set.

Reporting Data Problems

If the problem you find is that an IP address is incorrectly mapped, pleasesubmit your correction to MaxMind.

If you find some other sort of mistake, like an incorrect spelling,please checkthe GeoNames site first. Onceyou've searched for a place and found it on the GeoNames map view, thereare a number of links you can use to correct data ("move", "edit","alternate names", etc.). Once the correction is part of the GeoNamesdata set, it will be automatically incorporated into future MaxMindreleases.

If you are a paying MaxMind customer and you're not sure where to submit acorrection, pleasecontact MaxMind support for help.