pulkitjalan / geoip
IP Geolocation Wrapper with Laravel Support
Installs: 504 632
Dependents: 6
Suggesters: 0
Security: 0
Stars: 85
Watchers: 9
Forks: 44
Open Issues: 0
Requires
- php: ^8.1
- geoip2/geoip2: ^3.0
- guzzlehttp/guzzle: ^7.5|^7.8
- illuminate/console: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
Requires (Dev)
- mockery/mockery: ^1.6
- pestphp/pest: ^1.20|^2.0
This package is auto-updated.
Last update: 2024-10-13 08:01:51 UTC
README
IP Geolocation Wrapper with Laravel Support
This package provides an easy way to get geolocation information from IP addresses. It supports multiple drivers including IP-API, MaxMind Database, MaxMind API, IPStack, IP2Location, and IPinfo.
Requirements
- PHP >= 8.1
Installation
Install via composer:
composer require pulkitjalan/ip-geolocation
Laravel
There is a Laravel service provider and facade available.
Add the following to the providers
array in your config/app.php
PulkitJalan\IPGeolocation\IPGeolocationServiceProvider::class
Next add the following to the aliases
array in your config/app.php
'IPGeolocation' => PulkitJalan\IPGeolocation\Facades\IPGeolocation::class
Next publish the config file:
php artisan vendor:publish --provider="PulkitJalan\IPGeolocation\IPGeolocationServiceProvider" --tag="config"
Using an older version of PHP / Laravel?
If you are on a PHP version below 8.1 or a Laravel version below 9.0, use an older version of this package.
Usage
The ipGeolocation class takes a config array as the first parameter or defaults to using the ip-api
driver.
Example:
<?php use PulkitJalan\IPGeolocation\IPGeolocation $ip = new IPGeolocation(); $lat = $ip->getLatitude(); // 51.5141 $lon = $ip->getLongitude(); // -3.1969
IP-API
To use the ip-api pro service you can set the options in your config.
Pro Example:
$config = [ 'driver' => 'ip-api', 'ip-api' => [ 'key' => 'YOUR IP-API KEY', ], ];
Maxmind Database
To use Maxmind database as the driver you can set the options in your config.
Database Example:
$config = [ 'driver' => 'maxmind_database', 'maxmind_database' => [ 'database' => '/path/to/database.mmdb', ], ];
Maxmind Api
To use Maxmind api as the driver you can set the options in your config.
Web API Example:
$config = [ 'driver' => 'maxmind_api', 'maxmind_api' => [ 'user_id' => 'YOUR MAXMIND USER ID', 'license_key' => 'YOUR MAXMIND LICENSE KEY' ], ];
IPStack
To use the ipstack as the driver set the config.
Example:
$config = [ 'driver' => 'ipstack', 'ipstack' => [ 'key' => 'YOUR IPSTACK KEY', 'secure' => true, // (optional) use https ], ];
IP2Location
To use IP2Location as the driver, set the config as follows:
Example:
$config = [ 'driver' => 'ip2location', 'ip2location' => [ 'api_key' => 'YOUR IP2LOCATION API KEY', ], ];
IPinfo
To use IPinfo as the driver, set the config as follows:
Example:
$config = [ 'driver' => 'ipinfo', 'ipinfo' => [ 'token' => 'YOUR IPINFO API TOKEN', ], ];
Laravel
To use this package in Laravel, simply update the config file in config/ip-geolocation.php
to get the same effect. The driver can be set using the IPGEOLOCATION_DRIVER
env.
Available Methods
IPGeolocation will try to determin the ip using the following http headers: HTTP_CLIENT_IP
, HTTP_X_FORWARDED_FOR
, HTTP_X_FORWARDED
, HTTP_FORWARDED_FOR
, HTTP_FORWARDED
, REMOTE_ADDR
in this order. Optionally use the setIp
method to set it.
$ip->setIp('127.0.0.1'); // Laravel IPGeolocation::setIp('127.0.0.1');
There are a number of available methods to pull out the required information. All methods will return an empty string if data is unavailable.
Get latitude
$ip->getLatitude(); // Laravel IPGeolocation::getLatitude();
Get longitude
$ip->getLongitude(); // Laravel IPGeolocation::getLongitude();
Get city
$ip->getCity(); // Laravel IPGeolocation::getCity();
Get country
$ip->getCountry(); // Laravel IPGeolocation::getCountry();
Get country code
$ip->getCountryCode(); // Laravel IPGeolocation::getCountryCode();
Get region
$ip->getRegion(); // Laravel IPGeolocation::getRegion();
Get region code
$ip->getRegionCode(); // Laravel IPGeolocation::getRegionCode();
Get postal code
$ip->getPostalCode(); // Laravel IPGeolocation::getPostalCode();
Get timezone
$ip->getTimezone(); // Laravel IPGeolocation::getTimezone();
Get isp (not supported on all drivers)
$ip->getIsp(); // Laravel IPGeolocation::getIsp();
Get all geo information
$ip->get(); // returns array // Laravel IPGeolocation::get(); // returns array
Get raw geo information
$ip->getRaw(); // different drivers will return different data types // Laravel IPGeolocation::getRaw(); // different drivers will return different data types
Update Database
There is an update command available to help with updating and installing a local ip geolocation database. The following will download and install/update the database file to /path/to/database.mmdb
. As of 30th December 2019, Maxmind requires users to create an account and use a license key to download the databases.
<?php use PulkitJalan\IPGeolocation\IPGeolocationUpdater $config = [ 'driver' => 'maxmind_database', 'maxmind_database' => [ 'database' => '/path/to/database.mmdb', 'license_key' => 'YOUR MAXMIND LICENSE KEY' ], ]; (new IPGeolocationUpdater($config))->update();
Laravel
Once you have registered the service provider (supports auto discovery), you can use the command php artisan ip-geolocation:update
Services
IP-API
IP-API is a free (or paid) service that can be used instead of the database file or the paid MaxMind service. They do have some limitations on the free service, so please review their documentation first.
MaxMind
You can use the free database from MaxMind (license key required) or their web API service. You can sign up and get a free license key here.
IPStack
IPStack is a real-time IP to geolocation API service. They offer both free and paid plans. You can find more information and sign up on their website.
IP2Location
IP2Location provides IP geolocation databases and web services. They offer various products and services, including both free and paid options. You can learn more and sign up on their website.
IPinfo
IPinfo is a comprehensive IP address data provider offering accurate geolocation, ASN, company, and other IP-related information. They provide both API and database download options. You can sign up for a free API key or explore their paid plans on their website.
License
The MIT License (MIT). Please see the License File for more information.