Repository files navigation

This is the official PHP 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 to Geolocation data (city, region, country, postal code, latitude, and longitude)
• ASN information (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 information (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.

The package works with PHP 8 and is available usingComposer.

composer require ipinfo/ipinfo

<?phprequire_once__DIR__ .'/vendor/autoload.php';useipinfo\ipinfo\IPinfo;$access_token ='123456789abc';$client =newIPinfo($access_token);$ip_address ='216.239.36.21';$details =$client->getDetails($ip_address);echo$details->city;// Mountain Viewecho$details->loc;// 37.4056,-122.0775

TheIPinfo->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 =newIPinfo();$ip_address ='216.239.36.21';$details =$client->getDetails($ip_address);echo$details->city;// Mountain Viewecho$details->loc;// 37.4056,-122.0775

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 =newIPinfo($access_token);

IPinfo->getDetails() will return aDetails object that contains all fields listedIPinfo 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 thecountries object. See below for instructions on changing that object 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 theeu object.

$details->is_eu;// False

Details->country_flag will return the emoji and Unicode representations ofthe country's flag, as supplied by theflags object.

$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 thecountry's currency, as supplied by thecurrency object.

$details->country_currency['code'];// USD$details->country_currency['symbol'];// $

Details->continent will return the code and name of thecontinent, as supplied by thecontinents object.

$details->continent['code'];// NA$details->continent['name'];// North America

Details->latitude andDetails->longitude will return latitude and longitude, respectively, as strings.Details->loc will still return a composite string of both values.

$details->loc;// 37.4056,-122.0775$details->latitude;// 37.4056$details->longitude;// -122.0775

Details->all will return all details data as a dictionary.

$details->all;/*(    [ip] => 216.239.36.21    [hostname] => any-in-2415.1e100.net    [anycast] => 1    [city] => Mountain View    [region] => California    [country] => US    [loc] => 37.4056,-122.0775    [org] => AS15169 Google LLC    [postal] => 94043    [timezone] => America/Los_Angeles    [asn] => Array        (            [asn] => AS15169            [name] => Google LLC            [domain] => google.com            [route] => 216.239.36.0/24            [type] => hosting        )    [company] => Array        (            [name] => Google LLC            [domain] => google.com            [type] => hosting        )    [privacy] => Array        (            [vpn] =>            [proxy] =>            [tor] =>            [relay] =>            [hosting] => 1            [service] =>        )    [abuse] => Array        (            [address] => US, CA, Mountain View, 1600 Amphitheatre Parkway, 94043            [country] => US            [email] => network-abuse@google.com            [name] => Abuse            [network] => 216.239.32.0/19            [phone] => +1-650-253-0000        )    [domains] => Array        (            [ip] => 216.239.36.21            [total] => 2535948            [domains] => Array                (                    [0] => pub.dev                    [1] => virustotal.com                    [2] => blooket.com                    [3] => go.dev                    [4] => rytr.me                )        )    [country_name] => United States    [is_eu] =>    [country_flag] => Array        (            [emoji] => 🇺🇸            [unicode] => U+1F1FA U+1F1F8        )    [country_flag_url] => https://cdn.ipinfo.io/static/images/countries-flags/US.svg    [country_currency] => Array        (            [code] => USD            [symbol] => $        )    [continent] => Array        (            [code] => NA            [name] => North America        )    [latitude] => 37.4056    [longitude] => -122.0775)*/

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.

$access_token ='123456789abc';$client =newIPinfoLite($access_token);$res =$client->getDetails("8.8.8.8")$res->country_code// US$res->country// United States

In-memory caching ofDetails data is provided by default via thesymfony/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.

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

$access_token ='123456789abc';$settings = ['cache_maxsize' =>30,'cache_ttl' =>128];$client =newIPinfo($access_token,$settings);

It's possible to use a custom cache by creating a child class of theCacheInterface class and passing this into the handler object with thecache keyword argument. FYI this is known asthe Strategy Pattern.

$access_token ='123456789abc';$settings = ['cache' =>$my_fancy_custom_cache];$client =newIPinfo($access_token,$settings);

You may disable the cache by passing in acache_disabled key in the settings:

$access_token ='123456789abc';$settings = ['cache_disabled' =>true];$client =newIPinfo($access_token,$settings);

The IPinfo client constructor accepts atimeout key which is the requesttimeout in seconds.

For full flexibility, aguzzle_opts key is accepted which accepts anassociative array which is described inGuzzle Request Options.Options set here will override any custom settings set by the IPinfo clientinternally 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 =newIPinfo($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'];// AUvar_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 seethe official documentation for more information and limitations.

When looking up an IP address, the response object includes aDetails->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 thecountries object inside theIPinfo object, when creating theIPinfo object.

Thephp object must be with the following structure:

countries = ["BD" =>"Bangladesh","BE" =>"Belgium","BF" =>"Burkina Faso","BG" =>"Bulgaria"    ...]

continents = ["BD" => ["code" =>"AS","name" =>"Asia"],"BE" => ["code" =>"EU","name" =>"Europe"],"BF" => ["code" =>"AF","name" =>"Africa"],"BG" => ["code" =>"EU","name" =>"Europe"],"BA" => ["code" =>"EU","name" =>"Europe"],"BB" => ["code" =>"NA","name" =>"North America"]        ...]

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.