Maxmind GeoIP2 Web Services (unofficial)
Unofficial Node.js module for the Maxmind GeoIP2 Web Services.
There are multiple ways to load and set up this module. All communication is done over HTTPS.
require 'geoip2ws' userId licenseKey ip callback;
var geo = require 'geoip2ws' userId licenseKey;geo ip1 callback;geo ip2 callback;
var insights = 'geoip2ws' userId licenseKey 'insights';var country = 'geoip2ws' userId licenseKey 'country';// precise lookup, higher costinsights ip callback;// vague lookup, lower costcountry ip callback;
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 first function is the setup and takes these settings:
|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: |
|requestTimeout||integer||no||Socket read timeout in milliseconds to wait for reply from MaxMind|
// With argumentsvar geo = require 'geoip2ws' 1234 'abc' 'country' 2000;// Or with an objectvar geo = require 'geoip2ws'userId: 1234licenseKey: 'abc'service: 'country'requestTimeout: 2000;
The second function does the IP-address lookup and takes these arguments:
|service||string||no||The service, same as above|
|ip||string||yes||The IPv4 or IPv6 address to lookup|
|callback||function||yes||Your callback |
geo 'city' '220.127.116.11' myCallback;
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 an instance of
Error. It also returns API errors this same way.
if errconsole.log err;elseconsole.log datacitynamesen;
|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|
|API error||API error occured|
The source code repository has two main branches:
master is exactly the same as the latest release on npm,
develop is where all development happens and other branches and Pull Requests are merged into.
When you intent to submit a Pull Request, please code against the
You can test your code with
npm test in the source path or simply create a PR and see what happens.
https://geoip.maxmind.com: credits count, real data.
https://frankl.in: no credits, no logs, fake data.
|GEOIP2WS_USERID||Account user ID||null|
|GEOIP2WS_LICENCE||Account license key||null|
|GEOIP2WS_TIMEOUT||Wait time out in ms||5000|
|GEOIP2WS_ENDPOINT||API endpoint, i.e. http proxy|
GEOIP2WS_TIMEOUT=30000 npm test
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/