statsig / ip3country
IP address to 2-letter country code lookup
Installs: 177 216
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=7.0.0
Requires (Dev)
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-12-20 14:05:39 UTC
README
This is a zero-dependency, super small, IP address to 2-letter country code lookup library. There are already several libraries available, but none met our requirements for binary size and speed.
This project in its entirety is <500KB, compared to most alternatives out there that are north of 40MB (but might provide more than just countries).
The database used in this project is compacted from IP2Location. Their DB1.LITE edition is provided under CCA, with the attribution below:
NOTE
This site or product includes IP2Location LITE data available from https://lite.ip2location.com.
Usage
$ composer require statsig/ip3country
// import require_once __DIR__ . '/../vendor/autoload.php'; use ip3country\IP3Country; // Initialize $ip3c = new IP3Country(); // Lookup using ip4 str echo $ip3c->lookup("1.1.1.1"); // 'US' echo $ip3c->lookup("123.45.67.8"); // 'KR' // Lookup using numeric ip echo ip3country.lookupNumeric(2066563848)); // 'KR'
Tests
./vendor/bin/phpunit tests/TestCountries.php
Accuracy
ip3country
's accuracy is dependent on IP2Location LITE's accuracy. In our experience, for country lookups, it is accurate enough for most applications.
IP2Location publishes accuracy reports here: https://www.ip2location.com/data-accuracy
There's also this third party report available: https://www.cl.cam.ac.uk/~nz247/publications/JSAC2011-Geolocation.pdf
Name
All variants of "ip2country" were already taken in npm, so we decided to step it up.
Motivation
At Statsig, we needed a library to evaluate location-based conditions on Feature Gates (Feature Flags). We use ip3country to power country-level rollouts or A/B tests for new features.