Skip to content

Latest commit

 

History

History
168 lines (120 loc) · 5.53 KB

README.md

File metadata and controls

168 lines (120 loc) · 5.53 KB
Raw

geoip2ws

Unofficial Node.js module for the Maxmind GeoIP2 Web Services.

npm Build Status Coverage Status bitHound Overall Score bitHound Dependencies

Usage

There are multiple ways to load and set up this module. All communication is done over HTTPS.

One line

require ('geoip2ws') (userId, licenseKey) (ip, callback);

Multiple calls, same account

var geoip2ws = require ('geoip2ws') (userId, licenseKey);
geoip2ws (ip1, callback);
geoip2ws (ip2, callback);

Mix products (or accounts)

var geoip2ws = require ('geoip2ws');
var insights = new geoip2ws (userId, licenseKey, 'insights');
var country = new geoip2ws (userId, licenseKey, 'country');

// precise lookup, higher cost
insights (ip, callback);

// vague lookup, lower cost
country (ip, callback);

Installation

You need a Maxmind account ID and license key with enough credits for one of their GeoIP web services. You can find both here.

npm install geoip2ws

The functions

The first function is the setup and takes these settings:

parameter type required description
userId string yes Your Maxmind account user ID
licenseKey string yes Your Maxmind account license key
service string no The service you'd like to use: insights, country, city (default)
requestTimeout integer no Socket read timeout in milliseconds to wait for reply from MaxMind 
// With arguments
var geo = require ('geoip2ws') (1234, 'abc', 'country', 2000);

// Or with an object
var geo = require ('geoip2ws') ({
  userId: 1234,
  licenseKey: 'abc',
  service: 'country',
  requestTimeout: 2000
});

The second function does the IP-address lookup and takes these arguments:

parameter type required description
service string no The service, same as above
ip string yes The IPv4 or IPv6 address to lookup
callback function yes Your callback function to receive the data 
geo ('city', '145.53.252.135', myCallback);

Callback

The callback function receives result data and errors. Unless an error occurs the data JSON will be parsed to an object. When everything is ok err is null else err is an instance of Error. It also returns API errors this same way.

function myCallback (err, data) {
  if (err) {
    console.log (err);
  } else {
    console.log (data.city.names.en);
  }
}

Example response data

Errors

error message description additional
no userId or licenseKey You did not set your credentials
invalid service The service name is invalid no credits used
invalid ip The IP-address is invalid no credits used
request failed A request error occured err.error
API error API error occured err.code and err.error

List of API errors

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/

Author

Franklin van de Meent