PHPackages                             makidizajnerica/laravel-geolocation - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. makidizajnerica/laravel-geolocation

ActiveLibrary[Framework](/categories/framework)

makidizajnerica/laravel-geolocation
===================================

GeoLocation package for Laravel.

v2.0.1(3y ago)111.5k↑260%MITPHPPHP >=8.0

Since Aug 13Pushed 3y ago1 watchersCompare

[ Source](https://github.com/MakiDizajnerica/laravel-geolocation)[ Packagist](https://packagist.org/packages/makidizajnerica/laravel-geolocation)[ Docs](https://github.com/MakiDizajnerica/laravel-geolocation)[ RSS](/packages/makidizajnerica-laravel-geolocation/feed)WikiDiscussions main Synced today

READMEChangelog (5)Dependencies (3)Versions (6)Used By (0)

[![Laravel GeoLocation Logo](/art/logo.png)](/art/logo.png)

Laravel GeoLocation
===================

[](#laravel-geolocation)

Laravel package to get the details about region, city, country, timezone, currency, etc. for a given IP address.

Installation
------------

[](#installation)

```
composer require makidizajnerica/laravel-geolocation
```

As for registering Service Provider, it is not necessary, Laravel will auto load provider using Package Discovery.

Usage
-----

[](#usage)

### Using Facade

[](#using-facade)

Return value of the `MakiDizajnerica\GeoLocation\Facades\GeoLocation::lookup()` is the instance of `Illuminate\Support\Collection`. To find out more about Laravel Collections head to [Collections - Laravel](https://laravel.com/docs/8.x/collections).

```
use MakiDizajnerica\GeoLocation\Facades\GeoLocation;

$collection = GeoLocation::lookup('8.8.4.4');

echo $collection->get('success');
// true

echo $collection->get('ip');
// 8.8.4.4

echo $collection->get('continent');
// North America

echo $collection->get('continentCode');
// NA

echo $collection->get('country');
// United States

echo $collection->get('countryCode');
// US

echo $collection->get('countryFlag');
// https://cdn.ipwhois.io/flags/us.svg

echo $collection->get('countryCapital');
// Washington

echo $collection->get('region');
// California

echo $collection->get('city');
// Mountain View

echo $collection->get('timezone');
// America/Los_Angeles

echo $collection->get('timezoneName');
// Pacific Standard Time

echo $collection->get('currency');
// US Dollar

echo $collection->get('currencyCode');
// USD

echo $collection->get('currencySymbol');
// $

echo $collection->get('latitude');
// 37.3860517

echo $collection->get('longitude');
// -122.0838511

var_dump($collection->toArray());
// Array
// (
//     [success] => 1
//     [ip] => 8.8.4.4
//     [continent] => North America
//     [continentCode] => NA
//     [country] => United States
//     [countryCode] => US
//     [countryFlag] => https://cdn.ipwhois.io/flags/us.svg
//     [countryCapital] => Washington
//     [region] => California
//     [city] => Mountain View
//     [timezone] => America/Los_Angeles
//     [timezoneName] => Pacific Standard Time
//     [currency] => US Dollar
//     [currencyCode] => USD
//     [currencySymbol] => $
//     [latitude] => 37.3860517
//     [longitude] => -122.0838511
// )
```

You can also switch driver on runtime using:

```
use MakiDizajnerica\GeoLocation\Facades\GeoLocation;

$collection = GeoLocation::driver('geoplugin')->lookup('8.8.4.4');
```

Package comes with several predefined drivers, some of them require `API_KEY` to work. You can register those keys inside `.env` file:

```
ABSTRACTAPI_KEY=*****
IPDATA_KEY=*****
```

Predefined drivers:

DriverURLipwhois **\[default\]**geopluginabstractapiipdata*Depending on the driver that is used it is possible to get different results.*

### Request Macro

[](#request-macro)

Inside your controller `Illuminate\Http\Request $request` will have `geolocation()` method available:

```
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/', function (Request $request) {

    dd($request->geolocation()->toArray());

    return view('welcome');
});

// Array
// (
//     [success] => 1
//     [ip] => 8.8.4.4
//     [continent] => North America
//     [continentCode] => NA
//     [country] => United States
//     [countryCode] => US
//     [countryFlag] => https://cdn.ipwhois.io/flags/us.svg
//     [countryCapital] => Washington
//     [region] => California
//     [city] => Mountain View
//     [timezone] => America/Los_Angeles
//     [timezoneName] => Pacific Standard Time
//     [currency] => US Dollar
//     [currencyCode] => USD
//     [currencySymbol] => $
//     [latitude] => 37.3860517
//     [longitude] => -122.0838511
// )
```

Publishing Config File
----------------------

[](#publishing-config-file)

To publish `geolocation.php` config file use command:

```
php artisan vendor:publish --tag=geolocation-config
```

Creating Custom Driver
----------------------

[](#creating-custom-driver)

When creating custom driver, be sure to extend `MakiDizajnerica\GeoLocation\GeoLocationDriver` class. Then define two methods `lookup()` and `format()`:

```
use MakiDizajnerica\GeoLocation\GeoLocationDriver;

class CustomDriver extends GeoLocationDriver
{
    public function lookup($ipAddress): array
    {
        //
    }

    public function format(array $data): array
    {
        return [
            //
        ];
    }
}
```

Method `lookup($ipAddress)` accepts one parametar of type `string` that represents IP address. Inside this method you write request logic (sending request, checking response etc.), after that you just need to return response data as array. If request is not successful for some reason, you may throw `MakiDizajnerica\GeoLocation\Exceptions\GeoLocationDriverException` that will be picked up and reported inside log files.

Method `format($data)` accepts one parametar of type `array` that represents your response data returned from `lookup()` method, here you can format data as array with your own set of key/value pairs.

Inside `CustomDriver` class you will have two methods available, `options()` and `apiEndpoint()`.

Method `options($key)` accepts one parametar `$key` of type `string` and returns driver option based on provided `$key`.

Method `apiEndpoint($ipAddress)` accepts one parametar `$ipAddress` of type `string` and returns formatted api endpoint url with passed `$ipAddress`.

If you plan to use Laravel's built in `Illuminate\Support\Facades\Http` Http Client, you can use `MakiDizajnerica\GeoLocation\Support\HandlingHttpResponse` trait inside your `CustomDriver` class:

```
use Illuminate\Support\Facades\Http;
use MakiDizajnerica\GeoLocation\GeoLocationDriver;
use MakiDizajnerica\GeoLocation\Support\HandlingHttpResponse;

class CustomDriver extends GeoLocationDriver
{
    use HandlingHttpResponse;

    public function lookup($ipAddress): array
    {
        $response = Http::get($this->apiEndpoint($ipAddress));

        $data = $this->decodeResponseData(
            $this->checkResponse($response)
        );

        return $data;
    }

    public function format(array $data): array
    {
        return [
            'ip' => $data['ip'],
            'continent' => $data['continent'],
            'country' => $data['country'],
            'region' => $data['region'],
            'city' => $data['city'],
            'timezone' => $data['timezone'],
            'currency' => $data['currency'],
        ];
    }
}
```

Method `checkResponse(Response $response)` accepts one parameter of type `Illuminate\Http\Client\Response`, then returns that response if it was successful, or otherwise throws `MakiDizajnerica\GeoLocation\Exceptions\GeoLocationDriverException`.

Method `decodeResponseData(Response $response)` accepts one parameter of type `Illuminate\Http\Client\Response`, then tries to json decode that response and return array containing response data, or empty array on fail.

Then when you wrote lookup logic and formatted data, you need to register your driver inside `config/geolocation.php` config file:

```
'drivers' => [

    'customdriver' => [
        'driver' => \CustomDriver::class,
        'api_endpoint' => 'custom-endpoint.com',
        'query_params' => [

            'ip' => '{ip}'

        ],
    ],

]
```

`{ip}` is placeholder where actual IP address will be placed on `apiEndpoint()` call. You can put placeholder either in `api_endpoint`:

```
'api_endpoint' => 'custom-endpoint.com/{ip}'
```

or inside `query_params` like shown above:

```
'query_params' => [

    'ip' => '{ip}'

]
```

You can also define any other placeholder wraped inside curly brackets like so:

```
'query_params' => [

    'ip' => '{ip}'
    'lang' => '{lang}'

]
```

Then on runtime pass array containing that placeholder as key as second parameter to `driver()` method:

```
use MakiDizajnerica\GeoLocation\Facades\GeoLocation;

$collection = GeoLocation::driver('customdriver', ['lang' => 'en'])->lookup('8.8.4.4');
```

So when you call `apiEndpoint()` method inside your driver lookup method, the return value should look something like this:

```
echo $this->apiEndpoint('8.8.4.4');
// custom-endpoint.com?ip=8.8.4.4&lang=en
```

Author
------

[](#author)

**Nemanja Marijanovic** ()

Licence
-------

[](#licence)

Copyright © 2021, Nemanja Marijanovic

All rights reserved.

For the full copyright and license information, please view the LICENSE file that was distributed within the source root of this package.

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity27

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity60

Established project with proven stability

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~85 days

Total

5

Last Release

1444d ago

Major Versions

v1.1.1 → v2.0.02022-07-21

PHP version history (3 changes)v1.0.0PHP >=7.2

v1.1.0PHP >=7.4

v2.0.0PHP >=8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/7fe5cef566b020e21270218eee0e8c87e188e30bb1b9048a2f90749fe9a441ce?d=identicon)[MakiDizajnerica](/maintainers/MakiDizajnerica)

---

Tags

phpframeworklaravelgeolocationIPlocationcountrycitycontinentip-addressdetails

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/makidizajnerica-laravel-geolocation/health.svg)

```
[![Health](https://phpackages.com/badges/makidizajnerica-laravel-geolocation/health.svg)](https://phpackages.com/packages/makidizajnerica-laravel-geolocation)
```

###  Alternatives

[laravel/laravel

The skeleton application for the Laravel framework.

84.5k63.2M1.0k](/packages/laravel-laravel)[unopim/unopim

UnoPim Laravel PIM

10.5k2.4k](/packages/unopim-unopim)[nasirkhan/laravel-starter

A CMS like modular Laravel starter project.

1.4k2.7k](/packages/nasirkhan-laravel-starter)[codewithdennis/larament

Larament is a time-saving starter kit to quickly launch Laravel 13.x projects. It includes FilamentPHP 5.x pre-installed and configured, along with additional tools and features to streamline your development workflow.

3991.8k](/packages/codewithdennis-larament)[kompo/kompo

Laravel & Vue.js FullStack Components for Rapid Application Development

12014.8k49](/packages/kompo-kompo)[ecotone/laravel

Ecotone for Laravel — CQRS, Event Sourcing, Sagas, Durable Workflows, and Outbox on top of Laravel Queue, via PHP attributes.

21318.6k3](/packages/ecotone-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)