README

Resolve a visitor's country and geolocation from their IP address using swappable drivers — DB-IP Lite (default, free, no signup), MaxMind GeoLite2, ip-api, or ipinfo.

Documentation

Full documentation is available at arielmejiadev.github.io/geo-ip.

Quick Start

composer require arielmejiadev/geo-ip
php artisan geo-ip:install

This publishes the config and downloads the free DB-IP Lite database (no signup or API key needed).

Usage

One-shot lookups

use ArielMejiaDev\GeoIp\Facades\GeoIp;

GeoIp::country('8.8.8.8');       // 'United States'
GeoIp::countryCode('8.8.8.8');   // 'US'
GeoIp::city('8.8.8.8');          // 'Mountain View'
GeoIp::timezone('8.8.8.8');      // 'America/Los_Angeles'
GeoIp::coordinates('8.8.8.8');   // ['latitude' => 37.386, 'longitude' => -122.084]

Fluent API

$ip = GeoIp::of('8.8.8.8');

$ip->country();      // 'United States'
$ip->is('US');       // true
$ip->isIn(['US', 'CA', 'MX']); // true

// Conditional logic
GeoIp::of($ip)
    ->whenCountry('US', fn ($ip) => handleUs($ip))
    ->whenIn(['MX', 'CO', 'AR'], fn ($ip) => handleLatam($ip))
    ->toArray();

// From the current request
GeoIp::fromRequest()->countryCode();

Drivers

Set the driver in .env:

GEOIP_DRIVER=dbip

Testing

composer test

Set the driver to null in your test environment to avoid external calls:

<env name="GEOIP_DRIVER" value="null"/>

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• ArielMejiaDev
• All Contributors

License

The MIT License (MIT). Please see License File for more information.