https://github.com/kianmeng/webservice-ipapi

The Perl helper library for IP API, https://ipapi.com
https://github.com/kianmeng/webservice-ipapi

api cpan geoip ipv4 ipv6 perl

Last synced: about 1 month ago
JSON representation

The Perl helper library for IP API, https://ipapi.com

• Host: GitHub
• URL: https://github.com/kianmeng/webservice-ipapi
• Owner: kianmeng
• License: other
• Created: 2019-01-13T07:50:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T13:39:42.000Z (over 5 years ago)
• Last Synced: 2024-06-11T18:05:02.360Z (7 months ago)
• Topics: api, cpan, geoip, ipv4, ipv6, perl
• Language: Perl
• Size: 25.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Cpan license](https://img.shields.io/cpan/l/WebService-IPAPI.svg)](https://metacpan.org/release/WebService-IPAPI)

[![Cpan version](https://img.shields.io/cpan/v/WebService-IPAPI.svg)](https://metacpan.org/release/WebService-IPAPI)

# NAME

WebService::IPAPI - Perl library for IPAPI's Geolocation API,

https://ipapi.com.

# SYNOPSIS

    use WebService::IPAPI;

    my $ipapi = WebService::IPAPI->new(api_key => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx32');

    $ipapi->query('8.8.8.8');

    # Only for Pro plan.

    $ipapi->query(['8.8.8.8', '8.8.4.4']);

# DESCRIPTION

WebService::IPAPI is a Perl library for obtaining information on IPv4 or IPv6

address.

# DEVELOPMENT

Source repository at [https://github.com/kianmeng/webservice-ipapi](https://github.com/kianmeng/webservice-ipapi).

How to contribute? Follow through the [CONTRIBUTING.md](https://github.com/kianmeng/webservice-ipapi/blob/master/CONTRIBUTING.md) document to setup your development environment.

# METHODS

## new($api\_key, \[$api\_plan\])

Construct a new WebService::IPAPI instance.

### api\_key

Compulsory. The API access key used to make request through web service.

### api\_plan

Optional. The API subscription plan used when accessing the API. There are four

subscription plans: free, standard, business, and business\_pro. 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 => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxx32');

    print $ipapi->api_url;

    # The API request URL is https://api.ipapi.com/api/

    my $ipapi = WebService::IPAPI->new(

        api_key => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx32',

        api_plan => 'standard'

    );

    print $ipapi->api_url;

### api\_url

The default API hostname and path. The protocol depends on the subscription plan.

## lookup($ip\_address, \[%params\])

Query and get an IP address information. Optionally you can add more settings

to adjust the output.

    my $ipapi = WebService::IPAPI->new(api_key => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxx32');

    $ipapi->query('8.8.8.8');

    # With optional parameters.

    $ipapi->query('8.8.8.8', {hostname => 1, security => 1, output => 'xml'});

## bulk\_lookup($ip\_address, \[%params\])

Only for paid subscription plans (standard, business, business\_pro). Query and

get multiple IP addresses information. Optionally you can add more settings to

adjust the output.

    my $ipapi = WebService::IPAPI->new(

        api_key => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxx32',

        api_plan => 'standard'

    );

    $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'});

## check(\[%params\])

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 => '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxx32');

    $ipapi->check();

    # With optional parameters.

    $ipapi->check({hostname => 1, security => 1, output => xml});

# AUTHOR

Kian Meng, Ang 

# COPYRIGHT AND LICENSE

This software is Copyright (c) 2019 Kian Meng, Ang.

This is free software, licensed under:

    The Artistic License 2.0 (GPL Compatible)