Skip to content

Commit 34deffe

Browse files
committed
2 parents 1ec4132 + 9013f19 commit 34deffe

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/source/code.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# IP2Proxy .NET API
22

33
## Component Class
4-
```{py:function} Open(DatabasePath)
4+
```{py:function} Open(DatabasePath, IOMode)
55
Load the IP2Proxy BIN database for lookup.
66
77
:param String DatabasePath: (Required) The file path links to IP2Proxy BIN databases.
8+
:param Enum IOMode: (Optional) Specify which mode to use when loading the BIN database. Available values are IOModes.IP2PROXY_FILE_IO and IOModes.IP2PROXY_MEMORY_MAPPED. Default is IOModes.IP2PROXY_FILE_IO.
9+
```
10+
11+
```{py:function} Open(DBStream)
12+
Initialize component with a stream that contains the BIN database then preload BIN file.
13+
14+
:param Stream DBStream: (Required) A stream that contains the BIN database.
815
```
916

1017
```{py:function} Close()
@@ -41,6 +48,32 @@ Retrieve geolocation information for an IP address.
4148
4249
**RETURN FIELDS**
4350
51+
| Field Name | Description |
52+
| ---------------- | ------------------------------------------------------------ |
53+
| Country_Short | Two-character country code based on ISO 3166. |
54+
| Country_Long | Country name based on ISO 3166. |
55+
| Region | Region or state name. |
56+
| City | City name. |
57+
| Isp | Internet Service Provider or company\'s name. |
58+
| Domain | Internet domain name associated with IP address range. |
59+
| Usage_Type | Usage type classification of ISP or company. |
60+
| Asn | Autonomous system number (ASN). |
61+
| As | Autonomous system (AS) name. |
62+
| Last_Seen | Proxy last seen in days. |
63+
| Threat | Security threat reported. |
64+
| Proxy_Type | Type of proxy. |
65+
| Provider | Name of VPN provider if available. |
66+
```
67+
68+
```{py:function} GetAllAsync(IP)
69+
Retrieve geolocation information for an IP address.
70+
71+
:param String IP: (Required) The IP address (IPv4 or IPv6).
72+
:return: Returns the geolocation information in array. Refer below table for the fields avaliable in the array
73+
:rtype: array
74+
75+
**RETURN FIELDS**
76+
4477
| Field Name | Description |
4578
| ---------------- | ------------------------------------------------------------ |
4679
| Country_Short | Two-character country code based on ISO 3166. |

0 commit comments

Comments
 (0)