Php

Official PHP library for IPinfo (IP geolocation and other types of IP data)

Generate Convert Improve

Install / Use

/learn @ipinfo/Php

About this skill

Quality Score

0/100

README

<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/> IPinfo PHP Client Library

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:

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 address here.

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.

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 library also supports the Lite API, see the Lite API section for more info.

Installation

The package works with PHP 8 and is available using Composer.

composer require ipinfo/ipinfo

Quick Start

<?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);

echo $details->city; // Mountain View
echo $details->loc; // 37.4056,-122.0775

Usage

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);
echo $details->city; // Mountain View
echo $details->loc; // 37.4056,-122.0775

Authentication

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);

Details Data

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

Country Name

Details->country_name will return the country name, as supplied by the countries 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

EU Country

Details->is_eu will return true if the country is a member of the EU, as supplied by the eu object.

$details->is_eu; // False

Country Flag

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

$details->country_flag['emoji']; // 🇺🇸
$details->country_flag['unicode']; // U+1F1FA U+1F1F8

Country Flag URL

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

Country Currency

Details->country_currency will return the code and symbol of the country's currency, as supplied by the currency object.

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

Continent

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

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

Longitude and Latitude

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; // 37.4056,-122.0775
$details->latitude; // 37.4056
$details->longitude; // -122.0775

Accessing all properties

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

Lite API

The library gives the possibility to use the Lite API too, authentication with your token is still required.

The returned details are slightly different from the Core API.

$access_token = '123456789abc';
$client = new IPinfoLite($access_token);

$res = $client->getDetails("8.8.8.8")
$res->country_code // US
$res->country // United States

Core API

The library also supports the Core API, which provides city-level geolocation with nested geo and AS objects. Authentication with your token is required.

use ipinfo\ipinfo\IPinfoCore;

$access_token = '123456789abc';
$client = new IPinfoCore($access_token);

$details = $client->getDetails("8.8.8.8");
echo $details->ip; // 8.8.8.8
echo $details->geo['city']; // Mountain View
echo $details->geo['country']; // United States
echo $details->as['asn']; // AS15169
echo $details->as['name']; // Google LLC

Plus API

The library also supports the Plus API, which provides enhanced data including mobile carrier info and privacy detection. Authentication with your token is required.

use ipinfo\ipinfo\IPinfoPlus;

$access_token = '123456789abc';
$client = new IPinfoPlus($access_token);

$details = $client->getDetails("8.8.8.8");
echo $details->ip; // 8.8.8.8
echo $details->geo['city']; // Mountain View
print_r($details->mobile); // mobile carrier info
echo $details->anonymous['is_proxy']; // false

Residential Proxy API

The library also supports the Residential Proxy API, which allows you to check if an IP address is a residential proxy. Authentication with your token is required.

use ipinfo\ipinfo\IPinfo;

$access_token = '123456789abc';
$client = new IPinfo($access_token);

$resproxy = $client->getResproxy("175.107.211.204");
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

Caching

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.

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 seconds)

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

Using a different cache

It's possible to use a custom cache by

Related Skills

node-connect

338.0k

Diagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps

frontend-design

83.4k

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.

openai-whisper-api

338.0k

Transcribe audio via OpenAI Audio Transcriptions API (Whisper).

commit-push-pr

83.4k

Commit, push, and open a PR