Skip to content

Commit 7dfe707

Browse files
ip2locationip2location
committed
IP2Proxy PHP API
0 parents  commit 7dfe707

File tree

4 files changed

+200
-0
lines changed

4 files changed

+200
-0
lines changed

‎LICENSE.TXT‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 IP2Location.com
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following aconditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# IP2Proxy PHP API
2+
3+
This module allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address using **IP2Proxy API**.
4+
5+
6+
## Getting Started
7+
To begin, an API key is required for this module to function. Find further information at https://www.ip2location.com/ip2proxy-web-service
8+
9+
## Installation
10+
Add the following to your composer.json file:
11+
12+
```
13+
require_once 'class.IP2ProxyAPI.php';
14+
```
15+
16+
## Usage
17+
18+
```
19+
<?php
20+
21+
class IP2ProxyAPI
22+
{
23+
public $response;
24+
public $ipAddress;
25+
public $countryCode;
26+
public $countryName;
27+
public $regionName;
28+
public $cityName;
29+
public $isp;
30+
public $proxyType;
31+
public $isProxy;
32+
33+
protected $apiKey;
34+
protected $useSSL;
35+
36+
public function __construct($apiKey = '', $useSSL = false)
37+
{
38+
$this->apiKey = $apiKey;
39+
$this->useSSL = $useSSL;
40+
}
41+
42+
public function query($ip)
43+
{
44+
if (!filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
45+
return false;
46+
}
47+
48+
$response = $this->get('http' . (($this->useSSL) ? 's' : '') . '://api.ip2proxy.com/?' . http_build_query([
49+
'key' => $this->apiKey,
50+
'ip' => $ip,
51+
'package' => 'PX4',
52+
'format' => 'json',
53+
]));
54+
55+
if (($json = json_decode($response)) === null) {
56+
return false;
57+
}
58+
59+
$this->response = (string) $json->response;
60+
$this->countryCode = (string) $json->countryCode;
61+
$this->countryName = (string) $json->countryName;
62+
$this->regionName = (string) $json->regionName;
63+
$this->cityName = (string) $json->cityName;
64+
$this->isp = (string) $json->isp;
65+
$this->proxyType = (string) $json->proxyType;
66+
$this->isProxy = (string) $json->isProxy;
67+
68+
return true;
69+
}
70+
71+
private function get($url)
72+
{
73+
$ch = curl_init();
74+
75+
curl_setopt($ch, CURLOPT_URL, $url);
76+
curl_setopt($ch, CURLOPT_FAILONERROR, 1);
77+
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
78+
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
79+
curl_setopt($ch, CURLOPT_USERAGENT, 'IP2ProxyAPI_PHP-1.0.0');
80+
curl_setopt($ch, CURLOPT_TIMEOUT, 3);
81+
$response = curl_exec($ch);
82+
83+
return $response;
84+
}
85+
}
86+
?>
87+
```
88+
89+

‎class.IP2ProxyAPI.php‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?php
2+
3+
class IP2ProxyAPI
4+
{
5+
public $response;
6+
public $ipAddress;
7+
public $countryCode;
8+
public $countryName;
9+
public $regionName;
10+
public $cityName;
11+
public $isp;
12+
public $proxyType;
13+
public $isProxy;
14+
15+
protected $apiKey;
16+
protected $useSSL;
17+
18+
public function __construct($apiKey = '', $useSSL = false)
19+
{
20+
$this->apiKey = $apiKey;
21+
$this->useSSL = $useSSL;
22+
}
23+
24+
public function query($ip)
25+
{
26+
if (!filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
27+
return false;
28+
}
29+
30+
$response = $this->get('http' . (($this->useSSL) ? 's' : '') . '://api.ip2proxy.com/?' . http_build_query([
31+
'key' => $this->apiKey,
32+
'ip' => $ip,
33+
'package' => 'PX4',
34+
'format' => 'json',
35+
]));
36+
37+
if (($json = json_decode($response)) === null) {
38+
return false;
39+
}
40+
41+
$this->response = (string) $json->response;
42+
$this->countryCode = (string) $json->countryCode;
43+
$this->countryName = (string) $json->countryName;
44+
$this->regionName = (string) $json->regionName;
45+
$this->cityName = (string) $json->cityName;
46+
$this->isp = (string) $json->isp;
47+
$this->proxyType = (string) $json->proxyType;
48+
$this->isProxy = (string) $json->isProxy;
49+
50+
return true;
51+
}
52+
53+
private function get($url)
54+
{
55+
$ch = curl_init();
56+
57+
curl_setopt($ch, CURLOPT_URL, $url);
58+
curl_setopt($ch, CURLOPT_FAILONERROR, 1);
59+
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
60+
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
61+
curl_setopt($ch, CURLOPT_USERAGENT, 'IP2ProxyAPI_PHP-1.0.0');
62+
curl_setopt($ch, CURLOPT_TIMEOUT, 3);
63+
$response = curl_exec($ch);
64+
65+
return $response;
66+
}
67+
}

‎example.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
require_once 'class.IP2ProxyAPI.php';
4+
5+
$apiKey = 'YOUR_API_KEY';
6+
$ip = '8.8.8.8';
7+
8+
$ipx = new IP2ProxyAPI($apiKey, false);
9+
10+
if (!$ipx->query($ip)) {
11+
die('ERROR');
12+
}
13+
14+
echo '<pre>';
15+
echo 'Response : ' . $ipx->response . "\n";
16+
echo 'Country Code : ' . $ipx->countryCode . "\n";
17+
echo 'Country Name : ' . $ipx->countryName . "\n";
18+
echo 'Region Name : ' . $ipx->regionName . "\n";
19+
echo 'City Name : ' . $ipx->cityName . "\n";
20+
echo 'ISP : ' . $ipx->isp . "\n";
21+
echo 'Proxy Type : ' . $ipx->proxyType . "\n";
22+
echo 'Is Proxy : ' . $ipx->isProxy . "\n";
23+
echo '</pre>';

0 commit comments

Comments
 (0)