Please take note that the API exclusively functions to facilitate the acquisition of fresh proxies solely from the "Proxies List" resource. It is not intended to reuse proxies sourced from the "Today's List." The subsequent sections elucidate the API utilization guidelines along with illustrative instances.
Upon successful authentication within the software system, transition to the "Proxy API" tab. From the "API settings" submenu, opt for the "Use API" option. Maintaining an active login session while engaging the API functionalities is imperative.
In the root directory of the software application, a subordinate folder labeled "proxytool" is present. Contained therein is a file named "ProxyAPI.exe".
Invoke the "ProxyAPI.exe" executable using your designated software or script. This necessitates the inclusion of specific parameters outlined below. Consequently, automated proxy alteration can be accomplished:
use a random proxy from any countries, with port forwarding the proxy to port 5000. The port need to be in the "port forward" range in "Settings" tab, Each time using the parameter will result in replacing a new proxy to this port
use a random proxy from US, state: NewYork, city: New York
Regarding the specification of the country parameter, it is requisite to input the ISO alpha-2 code corresponding to the desired country. In cases of uncertainty, you may refer to external resources such as web search engines for queries like "country ISO alpha-2 code" to acquire the requisite information.
For the "-citynolimit" parameter, it can be employed in the following manner:
To prioritize proxy retrieval from a designated city (such as "New York") using the API system, you can use the command:
This configuration instructs the API to initially attempt proxy acquisition from the specified city (New York), giving it higher priority. Only in the absence of available proxies from the specified city does the system proceed to seek proxies from the corresponding state (NY). Should a proxy be successfully obtained from the designated city, the system refrains from attempting proxy retrieval from the state level (NY).
To acquire a proxy based on a specific IP address or IP block, the following format can be utilized:
The usage of the "-hwnd=" parameter is as follows:
By utilizing the "-hwnd=" parameter, when executing "ProxyAPI.exe," the application will dispatch a WM_COPYDATA message to the invoking software. This mechanism enables the originating software to access postcheck information and additional details related to the acquired proxy. To facilitate this functionality, you must provide the Window Handle of the software launching "ProxyAPI.exe". Subsequently, "ProxyAPI.exe" transmits a WM_COPYDATA message containing the subsequent format and information:
In the event of successful proxy retrieval via the API: success|ip|Ping|ProxyCountry|ProxyState|ProxyCity|CloudRouter account balance
In the event of unsuccessful proxy retrieval via the API: failed|reason for failure
Examples demonstrating the usage of this parameter: