README

FreeIPAPI driver addon for geolax/geolocate.

Installation

composer require geolax/freeipapi

That's it. The package is auto-discovered by Laravel and registers itself as the freeipapi driver.

Configuration

Add or update the driver config in config/geolocate.php:

'drivers' => [
    'freeipapi' => [
        'driver'   => 'freeipapi',
        'base_url' => env('GEOLOCATE_FREEIPAPI_URL', 'https://freeipapi.com'),
        'api_key'  => env('GEOLOCATE_FREEIPAPI_KEY'),
        'server'   => env('GEOLOCATE_FREEIPAPI_SERVER', 'free'),
        'timeout'  => 5,
    ],
],

Environment Variables

Servers

Usage

use Geolax\Geolocate\Facades\Geolocate;

$result = Geolocate::lookup('1.1.1.1');

$result->ipAddress;    // "1.1.1.1"
$result->countryName;  // "Australia"
$result->countryCode;  // "AU"
$result->cityName;     // "Sydney"
$result->latitude;     // -33.8688
$result->longitude;    // 151.209
$result->timezone;     // "Australia/Sydney"
$result->currency;     // "AUD"

FreeIPAPI-Specific Data

FreeIPAPI returns additional fields beyond the standard DTO. Access them via raw:

$result = Geolocate::lookup('1.1.1.1');

$result->raw['capital'];         // "Canberra"
$result->raw['phoneCodes'];      // [61]
$result->raw['timeZones'];       // ["Australia/Sydney", "Australia/Melbourne", ...]
$result->raw['currencies'];      // ["AUD"]
$result->raw['languages'];       // ["en"]
$result->raw['asn'];             // "13335"
$result->raw['asnOrganization']; // "Cloudflare, Inc."
$result->raw['isProxy'];         // false

Authentication (Paid Plans)

For paid/unlimited plans, set your API key:

GEOLOCATE_FREEIPAPI_KEY=your-api-key-here
GEOLOCATE_FREEIPAPI_SERVER=us

The driver automatically sends the API key as a Bearer token in the Authorization header.

Testing

composer test

Credits

• Bishwajit Adhikary
• All Contributors

License

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