WebService::IPAPI - Perl library for using IPAPI, https://ipapi.com.
use WebService::IPAPI; my $ipapi = WebService::IPAPI->new(api_key => 'foobar'); $ipapi->query('8.8.8.8'); # Only for Pro plan. $ipapi->query(['8.8.8.8', '8.8.4.4']);
WebService::IPAPI is Perl library for obtaining information on IPv4 or IPv6 address.
Source repo at https://github.com/kianmeng/webservice-ipapi.
How to contribute? Follow through the CONTRIBUTING.md document to setup your development environment.
Construct a new WebService::IPAPI instance.
Compulsory. The API access key used to make request through web service.
Optional. The API subscription plan used when accessing the API. There are four subscription plans: free, standard, business, and business_pro. By default, the subscription plan is 'free'. The main difference between free and non-free subscription plans are HTTPS encryption protocol support and additional information.
# The API request URL is http://api.ipapi.com/api/ my $ipapi = WebService::IPAPI->new(api_key => 'foo'); print $ipapi->api_url; # The API request URL is https://api.ipapi.com/api/ my $ipapi = WebService::IPAPI->new(api_key => 'foo', api_plan => 'paid'); print $ipapi->api_url;
The default API hostname and path. The protocol depends on the subscription plan.
Query and get an IP address information. Optionally you can add more settings to adjust the output.
my $ipapi = WebService::IPAPI->new(api_key => 'foobar'); $ipapi->query('8.8.8.8'); # With optional parameters. $ipapi->query('8.8.8.8', {hostname => 1, security => 1, output => 'xml'});
Only for Paid subscription plan. Query and get multiple IP addresses information. Optionally you can add more settings to adjust the output.
my $ipapi = WebService::IPAPI->new(api_key => 'foobar', api_plan => 'paid'); $ipapi->query(['8.8.8.8', '8.8.4.4']); # With optional parameters. $ipapi->query(['8.8.8.8', '8.8.4.4'], {language => 'zh'});
Look up the IP address details of the client which made the web service call. Optionally you can add more settings to adjust the output.
my $ipapi = WebService::IPAPI->new(api_key => 'foobar'); $ipapi->check(); # With optional parameters. $ipapi->check({hostname => 1, security => 1, output => xml});
This software is Copyright (c) 2019 by Kian Meng, Ang.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
Kian Meng, Ang <kianmeng@users.noreply.github.com>
To install WebService::IPAPI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::IPAPI
CPAN shell
perl -MCPAN -e shell install WebService::IPAPI
For more information on module installation, please visit the detailed CPAN module installation guide.