turbo-geoip-country

24.4.0 • Public • Published

turbo-geoip-country

This is an updated, performance-focused fork of node-geoip with only country data. Inspired by geoip-ultralight

This product uses GeoLite data created by MaxMind, available from https://www.maxmind.com/

💡 You would need to create an account and get a license key to update data by yourself

Build Status

How to install 🎁

npm install turbo-geoip-country --save

How to use it 🤖

const turboGeoip = require('turbo-geoip-country');

const ip = "207.97.227.239";
const country = turboGeoip.getCountry(ip);
console.log(country);
'US'

// Also it works with anonymized ip
const ip = "207.97.227.0";
const country = turboGeoip.getCountry(ip);
console.log(country);
'US'

Why turbo-geoip-country ⚡️

  • 🚀 Get country code (2 letter ISO-3166-1) by IP v4/v6
  • 🔒 Works also with anonymized IP
  • 🔥 Performance focused (see the section below)
  • ✅ Less than 19 MB memory footprint (instead of +110 MB of node-geoip)
  • ⏰ Data updated on 1st April 2024
  • 📅 Using Calendar versioning
  • 🌐 Production-ready, used by Ghostboard.io
  • ⚡️ Updated dependencies and 5 removed
  • 🤓 Code reduced and deprecations updated

Performance 🔥

💡 Based on the average performance of 10 executions of each package on a 2018 Mac Mini i7 6c12t 16GB

Metric node-geoip turbo-geoip-country delta
Startup time 47 ms 17 ms 63.83 % faster
Time to find 1 ip 7 μs/ip 4 μs/ip 42.86 % faster
IP lookups per second 139534.884 ip/s 250000.000 ip/s 44.19 % more ip/s

Test yourself node test/performance.js

Found 30000 (17030/12970) ips in 120ms (250000.000 ip/s) (4μs/ip)
Took 17 ms to startup

vs node-geoip node test/geo-lookup.js

Found 30000 (16917/13083) ips in 215ms (139534.884 ip/s) (7μs/ip)
Took 47 ms to startup

How to update the data 🔑

Run cd node_modules/turbo-geoip-country && npm run-script updatedb license_key=YOUR_LICENSE_KEY

👉 Replace YOUR_LICENSE_KEY with your license key obtained from maxmind.com. You can create a maxmind account here

💡 This takes about 1 minute

Tests ✅

Run npm t

> nodeunit test/tests.js


tests.js
✔ testLookup
✔ testDataIP4
✔ testDataIP6
✔ testUpdatedIps

OK: 7 assertions (19ms)

References

Copyright

geoip-lite is Copyright 2011-2018 Philip Tellis philip@bluesmoon.info and the latest version of the code is available at https://github.com/bluesmoon/node-geoip

License

There are two licenses for the code and data. See the LICENSE file for details.

Package Sidebar

Install

npm i turbo-geoip-country

Weekly Downloads

188

Version

24.4.0

License

Apache-2.0

Unpacked Size

14.4 MB

Total Files

11

Last publish

Collaborators

  • ghostboard