Please be aware that the API is specifically designed to facilitate the retrieval of new proxies exclusively from the "Proxies List
" resource. It is not intended for the reuse of proxies obtained from the "Today's List
." The following sections provide detailed guidelines on the utilization of the API, accompanied by illustrative examples.
After successfully authenticating within the software system, navigate to the "Proxy API
" tab. In the "API settings
" submenu, choose the "Use API
" option. It is crucial to keep an active login session while utilizing the API functionalities.
Within the main directory of the software application, you'll find a subfolder named "proxytool
." Inside this folder, there is a file titled "ProxyAPI.exe
."
Execute the "ProxyAPI.exe
" executable through your chosen software or script. This requires incorporating the specified parameters detailed below. As a result, automated proxy changes can be achieved:
ProxyAPI.exe -changeproxy/all -proxyport=5000
Copy
Utilize a proxy randomly selected from any country, forwarding the proxy to port 5000. Ensure that the port falls within the "port forward" range specified in the "Settings" tab. Each instance of using this parameter will replace the existing proxy with a new one on this port.
ProxyAPI.exe -changeproxy/US -proxyport=5000
Copy
use a random proxy from US
ProxyAPI.exe -changeproxy/US/NY -proxyport=5000
Copy
use a random proxy from US, state: NewYork
ProxyAPI.exe -changeproxy/US/NY/"New York" -proxyport=5000
Copy
use a random proxy from US, state: NewYork, city: New York
Concerning the country parameter specification, it is necessary to enter the ISO alpha-2 code associated with the desired country. In instances of uncertainty, you can consult external resources such as web search engines using queries like "country ISO alpha-2 code
" to obtain the necessary information.
The "-citynolimit
" parameter can be utilized in the following way:
To give preference to acquiring proxies from a specified city (like "New York") through the API system, you can employ the following command:
ProxyAPI.exe -changeproxy/US/NY/"New York" -citynolimit -proxyport=5000
Copy
This setup directs the API to prioritize the acquisition of proxies from the specified city (New York) initially, assigning it a higher priority. If there are no available proxies from the specified city, the system then proceeds to search for proxies in the corresponding state (NY). If a proxy is successfully obtained from the designated city, the system avoids attempting proxy retrieval from the state level (NY).
To obtain a proxy associated with a particular IP address or IP block, you can use the following format:
ProxyAPI.exe -changeproxy/ -ip=123.123.123.123 -proxyport=5000
Copy
Wildcard symbols (*) can substitute segments of the IP address for a more comprehensive selection, for example:
ProxyAPI.exe -changeproxy/ -ip=123.123.*.* -proxyport=5000
Copy
ProxyAPI.exe -changeproxy/ -ip=123.*.*.* -proxyport=5000
Copy
To free a port and disengage its linked proxy, use the command:
ProxyAPI.exe -freeport={port_number}
Copy
To release all ports and disengage all proxies, use the command:
ProxyAPI.exe -freeport=all
Copy
To choose a proxy randomly from a designated Internet Service Provider (ISP) or employ a fuzzy search with wildcard characters (*), use the following syntax:
ProxyAPI.exe -isp="Time Warner Cable" -proxyport=5000
Copy
For instance, -isp=S*
fetches a proxy with an ISP starting with "S," and -isp=*Cable
retrieves a proxy with an ISP name ending with "Cable
."
To select a random proxy from a specific ZIP code or apply fuzzy search with wildcard characters (*), the command is:
ProxyAPI.exe -zip=92626 -proxyport=5000
Copy
For instance, -zip=800*
, means to get a proxy with ZIP starting with "800
"
These parameters can be amalgamated for more intricate use cases, as illustrated in the subsequent examples:
ProxyAPI.exe -changeproxy/US/NY -proxyport=all
Copy
ProxyAPI.exe -changeproxy/US/NY -isp="Time Warner Cable" -proxyport=5000
Copy
ProxyAPI.exe -changeproxy/US/NY -isp="Time*" -proxyport=5000
Copy
ProxyAPI.exe -changeproxy/US -zip=92626 -proxyport=5000
Copy
ProxyAPI.exe -changeproxy/US -zip=926* -proxyport=5000
Copy
The utilization of the "-hwnd=
" parameter is outlined as follows:
When employing the "-hwnd=
" parameter while running "ProxyAPI.exe,
" the application will send a WM_COPYDATA
message to the calling software. This process allows the initiating software to retrieve postcheck information and additional details pertaining to the acquired proxy. To enable this functionality, you need to furnish the Window Handle of the software initiating "ProxyAPI.exe
." Subsequently, "ProxyAPI.exe
" transmits a WM_COPYDATA
message containing the following format and information:
If the API successfully retrieves a proxy, the output will be in the format:success|ip|Ping|ProxyCountry|ProxyState|ProxyCity|AlphaProxies account balance
If the API fails to retrieve a proxy, the output will be:failed|reason for failure
Illustrative instances showcasing the utilization of this parameter:
ProxyAPI.exe -changeproxy/US/NY/"New York" -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE
Copy
ProxyAPI.exe -changeproxy/US/NY/"New York" -citynolimit -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE
Copy
ProxyAPI.exe -changeproxy/ -ip=123.123.*.* -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE
Copy
ProxyAPI.exe -changeproxy/US/NY -isp="Time Warner Cable" -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE
Copy
ProxyAPI.exe -changeproxy/US -zip=9262* -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE
Copy