README

Integrate the powerful IP Geolocation API from Abstract in your PHP project in a few lines of code.

Abstract's IP Geolocation API is a fast, lightweight, modern, and RESTful JSON API allowing you to look up the location, timezone, country details, and more of an IPv4 or IPv6 address.

It's very simple to use: you only need to submit your API key and an IP address, and the API will respond with an assessment of its geographical location, as well as additional details like the timezone, if it's a VPN address, and more.

Validating and verifying IP addresses is a critical step to reducing the chances of low-quality data and fraudulent or risky users in your website or application.

Documentation

Supported PHP Versions

This library supports the PHP version 5.6 and higher.

Installation

You can install php-ip-geolocation via composer or by downloading the source.

Via Composer:

php-ip-geolocation is available on Packagist as the abstractapi/php-ip-geolocation package:

composer require abstractapi/php-ip-geolocation

API key

Get your API key for free and without hassle from the Abstact website.

Quickstart

Geolocation from an IP Address

// Get a Geolocation from an IP Address Abstract's IP Geolocation API and PHP
<?php
$api_key = "YYYYYY"; // Your API Key from https://app.abstractapi.com/api/ip-geolocation/documentation

Abstractapi\IpGeolocation\AbstractIpGeolocation::configure($api_key);

$info = Abstractapi\IpGeolocation\AbstractIpGeolocation::look_up('8.8.8.8');

print $info->city;

API response

The API response is returned in a IpGeolocationData object.

Detailed documentation

You will find additional information and request examples in the Abstract help page.

Getting help

If you need help installing or using the library, please contact Abstract's Support.

For bug report and feature suggestion, please use this repository issues page.

Contribution

Contributions are always welcome, as they improve the quality of the libraries we provide to the community.

Please provide your changes covered by the appropriate unit tests, and post them in the pull requests page.

Composer

To work on the source code, you need to install composer on your local computer. At the time of writing, the latest version of composer is v2.0.12. The installation instructions can be found here: https://getcomposer.org/download/.

Setup

To install the requirements, run:

composer install --prefer-source --no-interaction --ignore-platform-reqs

Once you implementer all your changes and the unit tests, run the following command to run the tests:

php vendor/bin/phpunit

abstractapi / php-ip-geolocation

Maintainers

Details