README

This package has been created as a simple facade to access the IPStack API.

Take a look at contributing.md to see a to do list.

Installation

Getting started with IPStack is easy, first install the package via Composer:

composer require arimolzer/ipstack

Then, optionally, publish the package configuration.

php artisan vendor:publish --provider="Arimolzer\IPStack\IPStackServiceProvider"

Then, you can set your environmental variables:

Variable	Description	Default
IPSTACK_API_KEY	API Key For IP Stack	`null`
IPSTACK_BASE_URI	Base URL for the API	https://api.ipstack.com/
IPSTACK_DEFAULT_TESTING_IP	The default IP to be used by tests for a successful response	134.201.250.155

To lookup the geolocation of a single IP address:

use \Arimolzer\IPStack\Facades\IPStack;

IPStack::get('134.201.250.155')

IP Stack supports bulk IP lookups, with a maximum of 50 addresses. Simply pass through an array of IP addresses to the getBulk method.

Important

The 'Professional' subscription tier is required to access the bulk endpoint.

IPStack::getBulk(['134.201.250.155' ,'72.229.28.185', '110.174.165.78'])

Please see the changelog for more information on what has changed recently.

composer test

Please see contributing.md for details and a todolist.

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

MIT. Please see the license file for more information.