PHPackages                             ipinfo/ipinfolaravel - 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. ipinfo/ipinfolaravel

ActiveLibrary

ipinfo/ipinfolaravel
====================

The official Laravel library for IPinfo, the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets. Visit our developer docs at https://ipinfo.io/developers.

v2.10.0(3mo ago)19689.1k↓15.3%40[2 issues](https://github.com/ipinfo/laravel/issues)[5 PRs](https://github.com/ipinfo/laravel/pulls)Apache-2.0PHPCI passing

Since Oct 2Pushed 3mo ago15 watchersCompare

[ Source](https://github.com/ipinfo/laravel)[ Packagist](https://packagist.org/packages/ipinfo/ipinfolaravel)[ Docs](https://github.com/ipinfo/ipinfolaravel)[ RSS](/packages/ipinfo-ipinfolaravel/feed)WikiDiscussions master Synced 1mo ago

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

[![IPinfo](https://camo.githubusercontent.com/df39f243048cc9deeddfa4ac2f142843bf11458de6dcc17a288c9a1dfad1fcc4/68747470733a2f2f6970696e666f2e696f2f7374617469632f6970696e666f2d736d616c6c2e737667)](https://ipinfo.io/) IPinfo Laravel Client Library
=====================================================================================================================================================================================================================================================

[](#-ipinfo-laravel-client-library)

This is the official Laravel client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:

- [IP geolocation](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude, and longitude)
- [ASN details](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
- [Company information](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address)
- [Carrier details](https://ipinfo.io/ip-carrier-api) (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

Check all the data we have for your IP address [here](https://ipinfo.io/what-is-my-ip).

### Getting Started

[](#getting-started)

You'll need an IPinfo API access token, which you can get by signing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup?ref=lib-Laravel).

The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see .

The library also supports the Lite API, see the [Lite API section](#lite-api) for more info.

#### Installation

[](#installation)

```
composer require ipinfo/ipinfolaravel

```

Open your application's `\app\Http\Kernel.php` file and add the following to the `Kernel::middleware` property:

```
protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\ipinfolaravel::class,
];
```

#### Quick Start

[](#quick-start)

```
Route::get('/', function (Request $request) {
    $location_text = "The IP address {$request->ipinfo->ip}.";
    return view('index', ['location' => $location_text]);
});
```

will return the following string to the `index` view:

```
"The IP address 127.0.0.1."

```

### Authentication

[](#authentication)

The IPinfo library can be authenticated with your IPinfo API token. It also works without an authentication token, but in a more limited capacity. To set your access token, add the following to your app's `\config\services.php` file and replace `{{access_token}}` with your own token:

```
'ipinfo' => [
    'access_token' => {{access_token}},
],
```

To do this in a more secure manner and avoid putting secret keys in your codebase, create an `IPINFO_SECRET` (or similar) environment variable and access this value from within `\config\services.php`, like so:

```
'ipinfo' => [
    'access_token' => env('IPINFO_SECRET'),
],
```

### Details Data

[](#details-data)

`$request->ipinfo` is a `Details` object that contains all fields listed [IPinfo developer docs](https://ipinfo.io/developers/responses#full-response) with a few minor additions. Properties can be accessed directly.

```
>>> $request->ipinfo->hostname
cpe-104-175-221-247.socal.res.rr.com
```

#### Country Name

[](#country-name)

`$request->ipinfo->country_name` will return the country name, as supplied by the `countries.json` file. See below for instructions on changing that file for use with non-English languages. `$request->ipinfo->country` will still return the country code.

```
>>> $request->ipinfo->country
US
>>> $request->ipinfo->country_name
United States
```

#### Accessing all properties

[](#accessing-all-properties)

`$request->ipinfo->all` will return all details data as an array.

```
>>> $request->ipinfo->all
{
'asn': {  'asn': 'AS20001',
           'domain': 'twcable.com',
           'name': 'Time Warner Cable Internet LLC',
           'route': '104.172.0.0/14',
           'type': 'isp'},
'city': 'Los Angeles',
'company': {   'domain': 'twcable.com',
               'name': 'Time Warner Cable Internet LLC',
               'type': 'isp'},
'country': 'US',
'country_name': 'United States',
'hostname': 'cpe-104-175-221-247.socal.res.rr.com',
'ip': '104.175.221.247',
'ip_address': IPv4Address('104.175.221.247'),
'loc': '34.0293,-118.3570',
'latitude': '34.0293',
'longitude': '-118.3570',
'phone': '323',
'postal': '90016',
'region': 'California'
}
```

### Caching

[](#caching)

In-memory caching of `Details` data is provided by default via Laravel's file-based cache. LRU (least recently used) cache-invalidation functionality has been added to the default TTL (time to live). This means that values will be cached for the specified duration; if the cache's max size is reached, cache values will be invalidated as necessary, starting with the oldest cached value.

#### Modifying cache options

[](#modifying-cache-options)

Default cache TTL and maximum size can be changed by setting values in the `$settings` argument array.

- Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
- Default TTL: 24 hours (in minutes)

```
'ipinfo' => [
    'cache_maxsize' => {{cache_maxsize}},
    'cache_ttl' => {{cache_ttl}},
],
```

#### Using a different cache

[](#using-a-different-cache)

It is possible to use a custom cache by creating a child class of the [CacheInterface](https://github.com/ipinfo/php/blob/master/src/cache/CacheInterface.php) class and setting the the `cache` config value in `\config\services.php`. FYI this is known as [the Strategy Pattern](https://sourcemaking.com/design_patterns/strategy).

```
'ipinfo' => [
    ...
    'cache' => new MyCustomCacheObject(),
],
```

### IP Selection Mechanism

[](#ip-selection-mechanism)

By default, the IP from the incoming request is used.

Since the desired IP by your system may be in other locations, the IP selection mechanism is configurable and some alternative built-in options are available.

#### Using built-in ip selectors

[](#using-built-in-ip-selectors)

##### DefaultIPSelector

[](#defaultipselector)

A [DefaultIPSelector](https://github.com/ipinfo/php/blob/master/src/iphandler/DefaultIPSelector.php) is used by default if no IP selector is provided. It returns the source IP from the incoming request.

This selector can be set explicitly by setting the `ip_selector` config value in `\config\services.php`.

```
'ipinfo' => [
    'ip_selector' => new DefaultIPSelector(),
],
```

##### OriginatingIPSelector

[](#originatingipselector)

A [OriginatingIPSelector](https://github.com/ipinfo/php/blob/master/src/iphandler/OriginatingIPSelector.php) selects an IP address by trying to extract it from the `X-Forwarded-For` header. This is not always the most reliable unless your proxy setup allows you to trust it. It will default to the source IP on the request if the header doesn't exist.

This selector can be set by setting the `ip_selector` config value in `\config\services.php`.

```
'ipinfo' => [
    'ip_selector' => new OriginatingIPSelector(),
],
```

#### Using a custom IP selector

[](#using-a-custom-ip-selector)

In case a custom IP selector is required, you may implement the [IPHandlerInterface](https://github.com/ipinfo/php/blob/master/src/iphandler/IPHandlerInterface.php) interface and set the `ip_selector` config value in `\config\services.php`.

For example:

```
'ipinfo' => [
    ...
    'ip_selector' => new CustomIPSelector(),
],
```

### Internationalization

[](#internationalization)

When looking up an IP address, the response object includes a `$request->ipinfo->country_name` property which includes the country name based on American English. It is possible to return the country name in other languages by telling the library to read from a custom file. To define a custom file, add the following to your app's `\config\services.php` file and replace `{{countries}}` with your own file path.

```
'ipinfo' => [
    ...
    'countries_file' => {{countries}},
],
```

The file must be a `.json` file with the following structure:

```
{
    {{country_code}}: {{country_name}},
    "BD": "Bangladesh",
    "BE": "Belgium",
    "BF": "Burkina Faso",
    "BG": "Bulgaria"
    ...
}

```

### Filtering

[](#filtering)

By default, `ipinfolaravel` filters out requests that have `bot` or `spider` in the user-agent. Instead of looking up IP address data for these requests, the `$request->ipinfo` attribute is set to `null`. This is to prevent you from unnecessarily using up requests on non-user traffic. This behavior can be switched off by adding the following to your app's `\config\services.php` file.

```
'ipinfo' => [
    ...
    'filter' => false,
 ],
```

To set your own filtering rules, *thereby replacing the default filter*, you can set `ipinfo.config` to your own, custom callable function which satisfies the following rules:

- Accepts one request.
- Returns *True to filter out, False to allow lookup*

To use your own filter function:

```
'ipinfo' => [
    ...
    'filter' => $customFilterFunction,
],
```

### Suppressing Exceptions

[](#suppressing-exceptions)

Laravel middleware does not allow you to catch exceptions from other middleware, so if the IPinfo middleware throws an exception, it'll be quite hard to deal with it.

We allow suppressing exceptions by specifying the `no_except` key in the config:

```
'ipinfo' => [
    ...
    'no_except' => true,
],
```

If an exception occurs when this setting is `true`, the `$request->ipinfo`object will be equal to `null`.

### Trying test application with Laravel Sail

[](#trying-test-application-with-laravel-sail)

Install Laravel Sail with:

```
cd testapp

docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/var/www/html" -w /var/www/html laravelsail/php84-composer:latest composer install --ignore-platform-reqs

./vendor/bin/sail build --no-cache

./vendor/bin/sail up
APP_KEY=$(./vendor/bin/sail artisan key:generate --show)
echo "APP_KEY=${APP_KEY}" > .env
# kill 'sail up' process

echo "IPINFO_TOKEN=" > app/.env

./vendor/bin/sail up
```

Visit . You should see a message similar to:

```
Hello world!

Details: The IP address 172.20.0.1.

```

To run tests within `testapp` while Sail is up:

```
./vendor/bin/sail phpunit
```

Lite API
--------

[](#lite-api)

The library gives the possibility to use the [Lite API](https://ipinfo.io/developers/lite-api) too, authentication with your token is still required.

The returned details are slightly different from the Core API, but it has the same configurations options.

Add the following to the `Kernel::middleware` property:

```
protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\lite\ipinfolitelaravel::class,
];
```

Core API
--------

[](#core-api)

The library also supports the [Core API](https://ipinfo.io/developers/data-types#core-data), which provides city-level geolocation with nested geo and AS objects. Authentication with your token is required.

Add the following to the `Kernel::middleware` property:

```
protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\core\ipinfocorelaravel::class,
];
```

Plus API
--------

[](#plus-api)

The library also supports the [Plus API](https://ipinfo.io/developers/data-types#plus-data), which provides enhanced data including mobile carrier info and privacy detection. Authentication with your token is required.

Add the following to the `Kernel::middleware` property:

```
protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\plus\ipinfopluslaravel::class,
];
```

Residential Proxy API
---------------------

[](#residential-proxy-api)

The library also supports the [Residential Proxy API](https://ipinfo.io/developers/residential-proxy-api), which allows you to check if an IP address is a residential proxy. Authentication with your token is required.

Add the following to the `Kernel::middleware` property:

```
protected $middleware = [
    ...
    \ipinfo\ipinfolaravel\resproxy\ipinforesproxylaravel::class,
];
```

The residential proxy details will be available through `$request->ipinfo_resproxy`:

```
Route::get('/', function (Request $request) {
    $resproxy = $request->ipinfo_resproxy;
    if ($resproxy) {
        echo $resproxy->ip;  // 175.107.211.204
        echo $resproxy->last_seen;  // 2025-01-20
        echo $resproxy->percent_days_seen;  // 0.85
        echo $resproxy->service;  // Bright Data
    }
});
```

### Other Libraries

[](#other-libraries)

There are official IPinfo client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. There are also many third-party libraries and integrations available for our API.

### About IPinfo

[](#about-ipinfo)

Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.

[![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/)

###  Health Score

60

—

FairBetter than 99% of packages

Maintenance78

Regular maintenance activity

Popularity50

Moderate usage in the ecosystem

Community26

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~190 days

Recently: every ~226 days

Total

15

Last Release

116d ago

Major Versions

v1.0.0 → v2.0.02020-11-27

### Community

Maintainers

![](https://www.gravatar.com/avatar/a93ff78d5acc7c9533f7418630a27a48a497ce2754854bc7b2c3c7de4f1752bf?d=identicon)[ipinfo-releases](/maintainers/ipinfo-releases)

---

Top Contributors

[![UmanShahzad](https://avatars.githubusercontent.com/u/10018065?v=4)](https://github.com/UmanShahzad "UmanShahzad (47 commits)")[![silvanocerza](https://avatars.githubusercontent.com/u/3314350?v=4)](https://github.com/silvanocerza "silvanocerza (24 commits)")[![jhtimmins](https://avatars.githubusercontent.com/u/4926004?v=4)](https://github.com/jhtimmins "jhtimmins (6 commits)")[![max-ipinfo](https://avatars.githubusercontent.com/u/135641228?v=4)](https://github.com/max-ipinfo "max-ipinfo (4 commits)")[![ipinfo-releases](https://avatars.githubusercontent.com/u/193542173?v=4)](https://github.com/ipinfo-releases "ipinfo-releases (3 commits)")[![abu-usama](https://avatars.githubusercontent.com/u/64308497?v=4)](https://github.com/abu-usama "abu-usama (3 commits)")[![st-polina](https://avatars.githubusercontent.com/u/41347222?v=4)](https://github.com/st-polina "st-polina (3 commits)")[![rm-Umar](https://avatars.githubusercontent.com/u/60544227?v=4)](https://github.com/rm-Umar "rm-Umar (3 commits)")[![matriphe](https://avatars.githubusercontent.com/u/277262?v=4)](https://github.com/matriphe "matriphe (2 commits)")[![abdullahdevrel](https://avatars.githubusercontent.com/u/111275753?v=4)](https://github.com/abdullahdevrel "abdullahdevrel (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![deltwalrus](https://avatars.githubusercontent.com/u/1335489?v=4)](https://github.com/deltwalrus "deltwalrus (1 commits)")

---

Tags

ip-addressip-dataip-geolocationipinfolaravellaravelipinfolaravel

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/ipinfo-ipinfolaravel/health.svg)

```
[![Health](https://phpackages.com/badges/ipinfo-ipinfolaravel/health.svg)](https://phpackages.com/packages/ipinfo-ipinfolaravel)
```

###  Alternatives

[slowlyo/owl-admin

基于 laravel、amis 开发的后台框架~

61214.2k26](/packages/slowlyo-owl-admin)[erag/laravel-disposable-email

A Laravel package to detect and block disposable email addresses.

226102.4k](/packages/erag-laravel-disposable-email)[highsolutions/eloquent-sequence

A Laravel package for easy creation and management sequence support for Eloquent models with elastic configuration.

121130.3k](/packages/highsolutions-eloquent-sequence)[glhd/linen

21135.6k](/packages/glhd-linen)[interaction-design-foundation/laravel-geoip

Support for multiple Geographical Location services.

17221.0k3](/packages/interaction-design-foundation-laravel-geoip)

PHPackages © 2026

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