Skip to content

Commit 8db3da3

Browse files
authored
Update README.md
1 parent d9f33b5 commit 8db3da3

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IP2Proxy Ruby Library
22

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 from IP2Location BIN Data file. This data file can be downloaded at
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 from **IP2Proxy BIN Data** file. This data file can be downloaded at
44

55
* Free IP2Proxy BIN Data: http://lite.ip2location.com
66
* Commercial IP2Proxy BIN Data: http://www.ip2location.com/proxy-database
@@ -9,6 +9,26 @@ This module allows user to query an IP address if it was being used as open prox
99
For more details, please visit:
1010
[https://www.ip2location.com/ip2proxy/developers/ruby](https://www.ip2location.com/ip2proxy/developers/ruby)
1111

12+
## Methods
13+
14+
Below are the methods supported in this module.
15+
16+
|Method Name|Description|
17+
|---|---|
18+
|open|Open the IP2Proxy BIN data with **File I/O** mode for lookup.|
19+
|close|Close and clean up the file pointer.|
20+
|getPackageVersion|Get the package version (1 to 4 for PX1 to PX4 respectively).|
21+
|getModuleVersion|Get the module version.|
22+
|getDatabaseVersion|Get the database version.|
23+
|isProxy|Check whether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address</li></ul>|
24+
|getAll|Return the proxy information in array.|
25+
|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/databases/px4-ip-proxytype-country-region-city-isp" target="_blank">IP2Location</a> for the list of proxy types supported|
26+
|getCountryShort|Return the ISO3166-1 country code (2-digits) of the proxy.|
27+
|getCountryLong|Return the ISO3166-1 country name of the proxy.|
28+
|getRegion|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported|
29+
|getCity|Return the city name of the proxy.|
30+
|getISP|Return the ISP name of the proxy.|
31+
1232
## Usage
1333

1434
```

0 commit comments

Comments
 (0)