├── example.php
├── composer.json
├── function_ipwhois.php
├── docs
    └── index.rst
└── README.md


/example.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 |     require_once('function_ipwhois.php');  
 3 |     $ip = "8.8.4.4"; // CLIENT IPADDRESS
 4 |     $location = get_ipwhois($ip,'json','en','');
 5 | 
 6 |     echo "<pre>";
 7 |     print_r($location);
 8 |     echo "</pre>";
 9 | ?>
10 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "ipwhois-io/ip-geolocation-api",
 3 |   "version": "1.0.0",
 4 |   "description": "A Simple php wrapper for https://ipwhois.io",
 5 |   "type": "library",
 6 |   "license": "MIT",
 7 |   "authors": [
 8 |     {
 9 |       "name": "IPWHOIS.io",
10 |       "homepage": "https://ipwhois.io/",
11 |       "role": "Developer"
12 |     }
13 |   ],
14 |   "require": {
15 |     "guzzlehttp/guzzle": "~6.0",
16 |     "nesbot/carbon": "~1.18",
17 |     "php" : "^5.5 || ^7.0",
18 |     "ext-json": "*"
19 |   },
20 |   "require-dev": {
21 |     "phpunit/phpunit": "^7",
22 |     "phpunit/php-code-coverage": "^6.0"
23 |   }
24 | }
25 | 


--------------------------------------------------------------------------------
/function_ipwhois.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 |     function get_ipwhois($ip, $format = "json", $lang = "en", $apiKey = "") {
 3 |         $url = "http://".($apiKey != '' ? 'ipwhois.pro' : 'ipwhois.app')."/".$format."/".$ip."?lang=".$lang.($apiKey != '' ? '&key='.$apiKey : '');
 4 |         $cURL = curl_init();
 5 |         curl_setopt($cURL, CURLOPT_URL, $url);
 6 |         curl_setopt($cURL, CURLOPT_HTTPGET, true);
 7 |         curl_setopt($cURL, CURLOPT_RETURNTRANSFER, true);
 8 |         curl_setopt($cURL, CURLOPT_HTTPHEADER, array(
 9 |             'Content-Type: application/json',
10 |             'Accept: application/json'
11 |         ));
12 |         return json_decode(curl_exec($cURL),true);
13 |     }
14 | ?>
15 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | **************************
 2 | ipwhois.io | IP Geolocation API - PHP SDK
 3 | **************************
 4 | 
 5 | Overview
 6 | ============
 7 | 
 8 | This `IP Geolocation API <https://ipwhois.io>`_ service is designed for quick and easy visitors IP geolocation integration into your script or website. Get rid of setting up local GeoIP libraries and forget about regular updates. Our neural network analyzes dozens of sources and almost real-time updates the database.
 9 | 
10 | Quick Start Guide
11 | ============
12 | 
13 | You can call the API by sending HTTP ``GET requests`` to:
14 | 
15 | .. code:: console
16 | 
17 |   http://ipwhois.app/json/{IP}
18 | 
19 | ``{IP}`` can be an IPv4 or IPv6 address, or none to use the current IP address.
20 | 
21 | Note: Complete documentation to use this SDK is also available at https://ipwhois.io/documentation
22 | 
23 | 
24 | Basic Usage
25 | ============
26 | Call method 
27 | 
28 | .. code:: console
29 | 
30 |   get_ipwhois($ip, $format, $lang, $apiKey)
31 |   
32 | passing IP address as parameters (rest of the parameters are optional) and it will return the Geolocation for the passed IP address.
33 | 
34 | 
35 | Example
36 | ============
37 | 
38 | .. code:: php
39 | 
40 |   <?php
41 |       $ip = "8.8.4.4"; // CLIENT_IP_ADDRESS;
42 |       $location = get_ipwhois($ip,'json','en','');
43 | 
44 |       echo "<pre>";
45 |       print_r($location);
46 |       echo "</pre>";
47 | 
48 |       function get_ipwhois($ip, $format = "json", $lang = "en", $apiKey = "") {
49 |           $url = "http://".($apiKey != '' ? 'ipwhois.pro' : 'ipwhois.app')."/".$format."/".$ip."?lang=".$lang.($apiKey != '' ? '&key='.$apiKey : '');
50 |           $cURL = curl_init();
51 |           curl_setopt($cURL, CURLOPT_URL, $url);
52 |           curl_setopt($cURL, CURLOPT_HTTPGET, true);
53 |           curl_setopt($cURL, CURLOPT_RETURNTRANSFER, true);
54 |           curl_setopt($cURL, CURLOPT_HTTPHEADER, array(
55 |               'Content-Type: application/json',
56 |               'Accept: application/json'
57 |           ));
58 |           return json_decode(curl_exec($cURL),true);
59 |       }
60 |   ?>
61 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <h1>IP Geolocation API  - PHP SDK</h1>
 2 | 
 3 | <h2>Overview</h2>
 4 | 
 5 | This <a href="https://ipwhois.io">IP Geolocation API</a> service is designed for quick and easy visitors IP geolocation integration into your script or website. Get rid of setting up local GeoIP libraries and forget about regular updates. Our neural network analyzes dozens of sources and almost real-time updates the database.
 6 | 
 7 | <h2>Quick Start Guide</h2>
 8 | 
 9 | You can call the API by sending HTTP GET requests to <code>http://ipwho.is/{IP}</code>
10 | 
11 | <code>{IP}</code> can be an IPv4 or IPv6 address, or none to use the current IP address.
12 | 
13 | <strong>Note:</strong> Complete documentation to use this API is also available at <a href="https://ipwhois.io/documentation">IP Geolocation API Documentation</a>.
14 | 
15 | <h2>System Requirements</h2>
16 | 
17 | Internet connection is required to run this component.
18 | 
19 | <h2>Basic Usage</h2>
20 | 
21 | Call method <code><strong>get_ipwhois($ip, $format, $lang, $apiKey)</strong></code> passing IP address as parameters (rest of the parameters are optional) and it will return the Geolocation for the passed IP address. To customize the geolocation response, you can pass the other parameters to <code><strong>get_ipwhois()</strong></code> method as described below:
22 | 
23 | <ul>
24 | <li>
25 | <p><strong>$format</strong></p>
26 | Based on your choice, the ipwhois API can deliver results in:
27 |   <ul><li>json (default)</li><li>xml</li><li>line</li></ul>
28 | </li>
29 |   
30 | <li>
31 | <p><strong>$lang</strong></p>
32 | Pass the language parameter to get the geolocation information in a language other than English. By default, it is set to English language.<br>
33 | ipwhois provides response in the following languages:
34 |   
35 | <ul>
36 | <li>en -	English (default)</li>
37 | <li>de -	Deutsch (German)</li>
38 | <li>es -	Español (Spanish)</li>
39 | <li>pt-BR -	Español - Argentina (Spanish)</li>
40 | <li>fr -	Français (French)</li>
41 | <li>ja -	日本語 (Japanese)</li>
42 | <li>zh-CN -	中国 (Chinese)</li>
43 | <li>ru -	Русский (Russian)</li>
44 | </ul>
45 |  
46 | </li>
47 | </ul>
48 | 
49 | <h2>Example</h2>
50 | 
51 | ```php
52 | <?php
53 |     $ip = "8.8.4.4"; // CLIENT IPADDRESS
54 |     $apiKey = ""; // Leave blank for free endpoint
55 |     $location = get_ipwhois($ip,'json','en',$apiKey);
56 |     
57 |     echo "<pre>";
58 |     print_r($location);
59 |     echo "</pre>";
60 | 
61 |     function get_ipwhois($ip, $format = "json", $lang = "en", $apiKey = "") {
62 |         $url = "http://".($apiKey != '' ? 'ipwhois.pro' : 'ipwho.is')."/".$ip."?lang=".$lang.($apiKey != '' ? '&key='.$apiKey : '')."&output=".$format;
63 |         $cURL = curl_init();
64 |         curl_setopt($cURL, CURLOPT_URL, $url);
65 |         curl_setopt($cURL, CURLOPT_HTTPGET, true);
66 |         curl_setopt($cURL, CURLOPT_RETURNTRANSFER, true);
67 |         curl_setopt($cURL, CURLOPT_HTTPHEADER, array(
68 |             'Content-Type: application/json',
69 |             'Accept: application/json'
70 |         ));
71 |         return json_decode(curl_exec($cURL),true);
72 |     }
73 | ?>
74 | ```
75 | 


--------------------------------------------------------------------------------