|
1 | 1 | # IP2Proxy .NET API |
2 | 2 |
|
3 | 3 | ## Component Class |
4 | | -```{py:function} Open(DatabasePath) |
| 4 | +```{py:function} Open(DatabasePath, IOMode) |
5 | 5 | Load the IP2Proxy BIN database for lookup. |
6 | 6 |
|
7 | 7 | :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. |
8 | 15 | ``` |
9 | 16 |
|
10 | 17 | ```{py:function} Close() |
@@ -41,6 +48,32 @@ Retrieve geolocation information for an IP address. |
41 | 48 |
|
42 | 49 | **RETURN FIELDS** |
43 | 50 |
|
| 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 | +
|
44 | 77 | | Field Name | Description | |
45 | 78 | | ---------------- | ------------------------------------------------------------ | |
46 | 79 | | Country_Short | Two-character country code based on ISO 3166. | |
|
0 commit comments