README

This Laravel 5.8 package provides a simple to use facade to request data from the ipstack.com geolocation API.

Installation

You can install the package via composer:

composer require arimolzer/ipstack-finder

The package will be immediately available thanks to Laravel auto discovery.

Configuration

Before making any requests however, you'll need to provide an ipstack.com API key. You can sign up for a free key on their website.

The best way to set the API key is by assigning the IPSTACK_API_KEY environmental variable in your .env file. Alternatively, you can publish the packages config file to your application and edit the it directly.

Optionally, you can also set a IPSTACK_DEFAULT_LANGUAGE environmental variable, which will update the default response language. For language options, see the API documentation.

If you would like to publish the config files, run the below artisan command:

php artisan vendor:publish --provider="Arimolzer\IPStackFinder\IPStackFinderServiceProvider"

Usage

Once the package is installed, you can call the facade by using the IPFinder facade:

/** @var array $data */
$data = IPStackFinderFacade::get('8.8.8.8');

Currently the only available method is IPStackFinderFacade::get(string $ip).

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email ari.molzer@molzertech.com instead of using the issue tracker.

arimolzer / ipstack-finder

Maintainers

Details