Stars: 200
Forks: 103
Pull Requests: 35
Issues: 29
Watchers: 31
Last Updated: 2023-09-12 07:54:49
Official PHP library for IPinfo (IP geolocation and other types of IP data)
License: Apache License 2.0
Languages: PHP
This is the official PHP client library for the IPinfo.io IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:
Check all the data we have for your IP address here.
You'll need an IPinfo API access token, which you can get by signing up for a free account at https://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 see https://ipinfo.io/pricing.
The package works with PHP 8 and is available using Composer.
composer require ipinfo/ipinfo
<?php
require_once __DIR__ . '/vendor/autoload.php';
use ipinfo\ipinfo\IPinfo;
$access_token = '123456789abc';
$client = new IPinfo($access_token);
$ip_address = '216.239.36.21';
$details = $client->getDetails($ip_address);
$details->city; // Emeryville
$details->loc; // 37.8342,-122.2900
The IPinfo->getDetails()
method accepts an IP address as an optional, positional argument. If no IP address is specified, the API will return data for the IP address from which it receives the request.
$client = new IPinfo();
$ip_address = '216.239.36.21';
$details = $client->getDetails($ip_address);
$details->city; // Emeryville
$details->loc; // 37.8342,-122.2900
The IPinfo library can be authenticated with your IPinfo API token, which is passed in as a positional argument. It also works without an authentication token, but in a more limited capacity.
$access_token = '123456789abc';
$client = new IPinfo($access_token);
IPinfo->getDetails()
will return a Details
object that contains all fields listed IPinfo developer docs with a few minor additions. Properties can be accessed directly.
$details->hostname; // cpe-104-175-221-247.socal.res.rr.com
Details->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. Details->country
will still return the country code.
$details->country; // US
$details->country_name; // United States
Details->is_eu
will return true if the country is a member of the EU, as supplied by the eu.json
file.
$details->is_eu; // False
Details->country_flag
will return the emoji and Unicode representations of
the country's flag, as supplied by the flags.json
file.
$details->country_flag['emoji']; // 🇺🇸
$details->country_flag['unicode']; // U+1F1FA U+1F1F8
Details->country_flag_url
will return a public link to the country's flag image as an SVG which can be used anywhere.
$details->country_flag_url; // https://cdn.ipinfo.io/static/images/countries-flags/US.svg
Details->country_currency
will return the code and symbol of the
country's currency, as supplied by the currency.json
file.
$details->country_currency['code']; // USD
$details->country_currency['symbol']; // $
Details->continent
will return the code and name of the
continent, as supplied by the continent.json
file.
$details->continent['code']; // NA
$details->continent['name']; // North America
Details->latitude
and Details->longitude
will return latitude and longitude, respectively, as strings. Details->loc
will still return a composite string of both values.
$details->loc; // 34.0293,-118.3570
$details->latitude; // 34.0293
$details->longitude; // -118.3570
Details->all
will return all details data as a dictionary.
$details->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',
'loc': '34.0293,-118.3570',
'latitude': '34.0293',
'longitude': '-118.3570',
'phone': '323',
'postal': '90016',
'region': 'California'
}
*/
In-memory caching of Details
data is provided by default via the symfony/cache library. 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.
$access_token = '123456789abc';
$settings = ['cache_maxsize' => 30, 'cache_ttl' => 128];
$client = new IPinfo($access_token, $settings);
It's possible to use a custom cache by creating a child class of the CacheInterface class and passing this into the handler object with the cache
keyword argument. FYI this is known as the Strategy Pattern.
$access_token = '123456789abc';
$settings = ['cache' => $my_fancy_custom_cache];
$client = new IPinfo($access_token, $settings);
You may disable the cache by passing in a cache_disabled
key in the settings:
$access_token = '123456789abc';
$settings = ['cache_disabled' => true];
$client = new IPinfo($access_token, $settings);
The IPinfo client constructor accepts a timeout
key which is the request
timeout in seconds.
For full flexibility, a guzzle_opts
key is accepted which accepts an
associative array which is described in Guzzle Request Options.
Options set here will override any custom settings set by the IPinfo client
internally in case of conflict, including headers.
Looking up a single IP at a time can be slow. It could be done concurrently from the client side, but IPinfo supports a batch endpoint to allow you to group together IPs and let us handle retrieving details for them in bulk for you.
$access_token = '123456789abc';
$client = new IPinfo($access_token);
$ips = ['1.1.1.1', '8.8.8.8', '1.2.3.4/country'];
$results = $client->getBatchDetails($ips);
echo $results['1.2.3.4/country']; // AU
var_dump($results['1.1.1.1']);
var_dump($results['8.8.8.8']);
The input size is not limited, as the interface will chunk operations for you behind the scenes.
Please see the official documentation for more information and limitations.
When looking up an IP address, the response object includes a Details->country_name
attribute which includes the country name based on American English. It is possible to return the country name in other languages by setting the countries_file
keyword argument when creating the IPinfo
object.
The file must be a .json
file with the following structure:
{
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria"
...
}
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, privacy, hosted domains and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.