Skip to content

Add documentation for Core and Plus bundles and resproxy #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
silvanocerza merged 1 commit into from
Jan 23, 2026
Merged

Add documentation for Core and Plus bundles and resproxy #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,14 +168,66 @@ The returned details are slightly different from the Core API.
use Geo::IPinfoLite;

$access_token = '123456789abc';
$ipinfo = Geo::IPinfo->new($access_token);
$ipinfo = Geo::IPinfoLite->new($access_token);

$ip_address = '216.239.36.21';
$details = $ipinfo->info($ip_address);
$country_code = $details->country_code; # US
$country = $details->country; # United States
```

### Core API

The library also supports the [Core API](https://ipinfo.io/developers/data-types#core-data), which provides city-level geolocation with nested geo and AS objects. Authentication with your token is required.

```perl
use Geo::IPinfoCore;

$access_token = '123456789abc';
$ipinfo = Geo::IPinfoCore->new($access_token);

$details = $ipinfo->info('8.8.8.8');
$ip = $details->ip; # 8.8.8.8
$city = $details->geo->{city}; # Mountain View
$country = $details->geo->{country}; # United States
$asn = $details->as->{asn}; # AS15169
$as_name = $details->as->{name}; # Google LLC
```

### Plus API

The library also supports the [Plus API](https://ipinfo.io/developers/data-types#plus-data), which provides enhanced data including mobile carrier info and privacy detection. Authentication with your token is required.

```perl
use Geo::IPinfoPlus;

$access_token = '123456789abc';
$ipinfo = Geo::IPinfoPlus->new($access_token);

$details = $ipinfo->info('8.8.8.8');
$ip = $details->ip; # 8.8.8.8
$city = $details->geo->{city}; # Mountain View
$mobile = $details->mobile; # mobile carrier info
$is_proxy = $details->anonymous->{is_proxy}; # false
```

### Residential Proxy API

The library also supports the [Residential Proxy API](https://ipinfo.io/developers/residential-proxy-api), which allows you to check if an IP address is a residential proxy. Authentication with your token is required.

```perl
use Geo::IPinfo;

$access_token = '123456789abc';
$ipinfo = Geo::IPinfo->new($access_token);

$resproxy = $ipinfo->get_resproxy('175.107.211.204');
$ip = $resproxy->{ip}; # 175.107.211.204
$last_seen = $resproxy->{last_seen}; # 2025-01-20
$percent_days_seen = $resproxy->{percent_days_seen}; # 0.85
$service = $resproxy->{service}; # Bright Data
```

#### Caching

In-memory caching of `Details` data is provided by default via the [Cache::LRU](https://metacpan.org/pod/Cache::LRU) package. This uses an LRU (least recently used) cache with a TTL (time to live) by default. 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.
Expand Down
Loading