sudiptpa/ipstack

A simple package for IP to Location implementation with PHP.

v1.3.0 2018-07-18 16:10 UTC

Requires

• php: ~7.0

Requires (Dev)

• mockery/mockery: ^0.9.4
• phpro/grumphp: ^0.14.0
• phpunit/phpunit: ~6.0
• squizlabs/php_codesniffer: ^3

MIT

• Sujip Thapa

• geoip
• ip to location
• ipstack

README

https://ipstack.com provides a public HTTP API for software developers to search the geolocation of IP addresses. It uses a database of IP addresses that are associated to cities along with other relevant information like time zone, latitude and longitude.

You're allowed up to 10,000 queries per month by default. Once this limit is reached, all of your requests will result in HTTP 403, forbidden, until your quota is cleared.

The ipstack is an API service which enable you to locate and identify website visitors at a stage before any data is entered into your system. The data received from the API can be used to enhance user experiences based on location data and assess risks and potential threats to your web application in time.

Installation

You can install the package via composer: Composer.

composer require sudiptpa/ipstack

And run composer to update your dependencies:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

Usage

This package only supports json format for now.

Here are a few examples on how you can use the package:

Free

    $ipstack = new Sujip\Ipstack\Ipstack($ip);

    $ipstack->country();

    $ipstack->city();

    $ipstack->region();

Using API Key

    $ipstack = new Sujip\Ipstack\Ipstack($ip, $api_key);

    $ipstack->formatted();

Premium Membership

If you have a paid membership with https://ipstack.com and want to make API call with HTTPS mode, you can call ->secure() method.

    $ipstack = (new Sujip\Ipstack\Ipstack($ip, $api_key))->secure();

    $ipstack->formatted();

Also have a look in the source code of Sujip\Ipstack\Ipstack to discover the methods you can use.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Contributions are welcome and will be fully credited.

Contributions can be made via a Pull Request on Github.

Testing

  $ composer test

Support

If you are having general issues with the package, feel free to drop me and email [e-mail]

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.