Repository files navigation

This is the official Laravel client library for theIPinfo.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 (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 information (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)

Check all the data we have for your IP addresshere.

You'll need an IPinfo API access token, which you can get by signing up for a free account athttps://ipinfo.io/signup.

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 seehttps://ipinfo.io/pricing.

The library also supports the Lite API, see theLite API section for more info.

composer require ipinfo/ipinfolaravel

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

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

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

will return the following string to theindex view:

"The IP address 127.0.0.1."

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 anIPINFO_SECRET (or similar) environment variable and access this value from within\config\services.php, like so:

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

$request->ipinfo is aDetails object that contains all fields listedIPinfo developer docs with a few minor additions. Properties can be accessed directly.

>>>$request->ipinfo->hostnamecpe-104-175-221-247.socal.res.rr.com

$request->ipinfo->country_name will return the country name, as supplied by thecountries.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->countryUS>>>$request->ipinfo->country_nameUnited States

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

>>>$request->ipinfo->all{'asn': {'asn':'AS20001','domain':'twcable.com','name':'Time Warner Cable InternetLLC','route':'104.172.0.0/14','type':'isp'},'city':'Los Angeles','company': {'domain':'twcable.com','name':'Time Warner Cable InternetLLC','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'}

In-memory caching ofDetails 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.

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

It is possible to use a custom cache by creating a child class of theCacheInterface class and setting the thecache config value in\config\services.php. FYI this is known asthe Strategy Pattern.

'ipinfo' => [    ...'cache' =>newMyCustomCacheObject(),],

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.

ADefaultIPSelector 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 theip_selector config value in\config\services.php.

'ipinfo' => ['ip_selector' =>newDefaultIPSelector(),],

AOriginatingIPSelector selects an IP address by trying to extract it from theX-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 theip_selector config value in\config\services.php.

'ipinfo' => ['ip_selector' =>newOriginatingIPSelector(),],

In case a custom IP selector is required, you may implement theIPHandlerInterface interface and set theip_selector config value in\config\services.php.

For example:

'ipinfo' => [    ...'ip_selector' =>newCustomIPSelector(),],

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"    ...}

By default,ipinfolaravel filters out requests that havebot orspider in the user-agent. Instead of looking up IP address data for these requests, the$request->ipinfo attribute is set tonull. 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 setipinfo.config to your own, custom callable function which satisfies the following rules:

• Accepts one request.
• ReturnsTrue to filter out, False to allow lookup

To use your own filter function:

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

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

We allow suppressing exceptions by specifying theno_except key in theconfig:

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

If an exception occurs when this setting istrue, the$request->ipinfoobject will be equal tonull.

Install Laravel Sail with:

cd testappdocker 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 upAPP_KEY=$(./vendor/bin/sail artisan key:generate --show)echo"APP_KEY=${APP_KEY}"> .env# kill 'sail up' processecho"IPINFO_TOKEN=<YOUR_TOKEN>"> app/.env./vendor/bin/sail up

Visithttp://0.0.0.0:80. You should see a message similar to:

Hello world!Details: The IP address 172.20.0.1.

To run tests withintestapp while Sail is up:

./vendor/bin/sail phpunit

The library gives the possibility to use theLite 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 theKernel::middleware property:

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

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.

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.