PHPackages                             hardmode/laravelipinfo - 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. [API Development](/categories/api)
4. /
5. hardmode/laravelipinfo

ActiveLibrary[API Development](/categories/api)

hardmode/laravelipinfo
======================

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.

v1.0.x-dev(6y ago)05Apache-2.0PHPCI failing

Since May 9Pushed 6y ago1 watchersCompare

[ Source](https://github.com/HardMode2015/laravelipinfo)[ Packagist](https://packagist.org/packages/hardmode/laravelipinfo)[ Docs](https://github.com/ipinfo/laravelipinfo)[ RSS](/packages/hardmode-laravelipinfo/feed)WikiDiscussions v1.0 Synced today

READMEChangelogDependencies (6)Versions (2)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 lookup your own IP address, or get any of the following details for an IP:

- IP geolocation (city, region, country, postal code, latitude and longitude)
- ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
- Company details (the name and domain of the business that uses the IP address)
- Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

### Getting Started

[](#getting-started)

You'll need an IPinfo API access token, which you can get by singing 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 [https://ipinfo.io/pricing](https://ipinfo.io/pricing?ref=lib-Laravel).

#### Installation

[](#installation)

```
composer require hardmode/laravelipinfo

```

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

```
protected $middleware = [
  ...
  \hardmode\laravelipinfo\laravelipinfo::class,
  ];

```

#### Quick Start

[](#quick-start)

```
Route::get('/', function (Request $request) {
    $location_text = "The IP address {$request->ipinfo->ip} is located in the city of {$request->ipinfo->city}."

    return view('index', ['location' => $location_text]);
});

```

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

```
"The IP address 216.239.36.21 is located in the city of Emeryville."

```

### 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/Interface.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(),
],

```

### 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,
],

```

### 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 and IP type data sets. Our API handles over 12 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

20

—

LowBetter than 13% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Unknown

Total

1

Last Release

2245d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/17118764?v=4)[Foo](/maintainers/HardMode2015)[@HardMode2015](https://github.com/HardMode2015)

---

Top Contributors

[![HardMode2015](https://avatars.githubusercontent.com/u/17118764?v=4)](https://github.com/HardMode2015 "HardMode2015 (8 commits)")

---

Tags

laravellaravelipinfo

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/hardmode-laravelipinfo/health.svg)

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

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

815320.5k3](/packages/defstudio-telegraph)[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.

19996.9k](/packages/ipinfo-ipinfolaravel)[neuron-core/neuron-laravel

Official Neuron AI Laravel SDK.

11337.8k1](/packages/neuron-core-neuron-laravel)[riclep/laravel-storyblok

A Laravel wrapper around the Storyblok API to provide a familiar experience for Laravel devs

6279.6k5](/packages/riclep-laravel-storyblok)[simplestats-io/laravel-client

Analytics for Laravel. Track visitors, registrations, and payments. Discover which channels actually drive revenue, not just traffic. Server-side, GDPR compliant, ad-blocker proof.

5019.3k](/packages/simplestats-io-laravel-client)

PHPackages © 2026

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