The API documentation, free tools and source code

The API documentation

	Our API can be used to integrate automated proxy handling into tools, macros and scripts.
	You could even create a bookmark in your browser to change your external IP on the fly!
	Disclaimer: you may not use our API for illegal activities and you may only use our API if you own an active license
	Hint: When configuring a tool, browser or script make sure you add our domain ( as proxy exception
	Our API is designed to integrate our IP services (IP rotation) into custom tools and scripts without much effort, however it can still be quite a task
	to develop your data analysis or mining tools. 
	If you require help from experienced people please contact our customer support, we can recommend experienced developers.

Through the API you can do these actions

* take IPs from the IP pool * start a proxy * stop a proxy * rotate your proxy to a random IP (IPs that were not used for a longer time are favored against IPs you used more recently) * rotate your proxy to a specific IP * verify your external IP


The API The API is a HTTP protocol, that means you can access it through a browser, a TCP session, CURL or similar. All API calls require: your userid,your encrypted password, a command name and optional parameters Your API password: d24479f7966bddb4e57451b8e35bb16d Your API userid : -1 Your first Proxy-Port : 7999 The proxies The protocol of your proxy is the HTT, the SOCKS or the VPN protocol. You can switch the protocol in your profile at any time. All proxies run on the host "" , your first proxy port is 7999 . When using US portal the host will be "". This makes configuration a lot easier than usual: You simply configure as HTTP/SOCKS proxy! The external IP of the proxy is auto-tunneled by our server as you define it (rotate to a random IP or rotate to a specified IP) Each started proxy has a default lifetime of 7 hours (can be changed in your profile), after that you will have to start it again. VPN requires the installation of our VPN-package (see profile page) and will not expire/shut down while in use. Proxy authentication Our proxies are authenticated by your IP address. This happens when you rotate or start the proxy.
This means that you do not have to configure any passwords or logins, all you need is to start the proxy and it will work. The VPN is authenticated by a secret key which is part of your VPN download package, the key can only be used from one computer at the same time.

Using the API

The API listens for HTTP GET requests, the below examples already include your current encrypted password and your userid. The base of all API calls: The API is able to temporarily throttle API requests in case of an overload, depending on your license you can make more or less requests per hour. If you receive a throttle message make sure not to ignore it, please either contact us or work on your code to reduce the number of API requests. API TOS The API will issue automated temporal bans when detecting TOS violations. If you find yourself being blocked please make sure your tools do not violate our TOS. Especially DoS like behaviour or overusage, for example by causing Captcha responses from scraping search engines). Please always keep a reasonable delay between API calls as well as reasonable delays and quotas when accessing other webservices. For example, if you receive a Captcha page from Google you need to slow down as well as pause the affected IP address for at least an hour. API commands "hello" ( The API call 'hello' can be used to test if the license is valid without changing anything. The parameter "&extended=1" can be used to append the configured proxy protocol and the max proxy processes number. A successful response is "HELLO:xx:yy" where xx is the total number of IPs in the license and yy the currently assigned IP count For extended requests the response looks like this: "HELLO:IPs in license:IPs assigned:proxy protocol:proxy process limit" If the license is not ready it will return "ERROR:$code:$reason" or "HELLO:0:0" "rotate" ( When using the API call 'rotate' then the first started proxy is stopped and replaced by another proxy. In case you had no proxy running a proxy is started for you. In most cases all you need for your API integration is the rotate command! Optional parameters: & , this requests the specific IP to be used for rotation & , this requests a different authorization IP than your own one &randomness=0 , by default the rotation sort-order is based on the last-usage time. The last-usage time has a 5 hours fuzziness applied, so rotation sequences are mixed up a bit. randomness=0 removes the 5h fuzziness. &offset=X , if your license allows multiple proxies you can use this parameter to control a specific proxy. 0 is default (the first proxy) Return values: ERROR:102:STOP FAILED:$IP_ADDRESS : this might happen when the server experiences high load and can not stop your proxy ERROR:104:PROXY START FAILED:$IP_ADDRESS : this might happen when the server experiences high load and can not start your proxy ERROR:103:NO NEW IP FOUND : this return value is currently not available and will be ready in future ROTATE:$PROXY_IP:$PORT:$IP_ADDRESS : rotation successful. IP authentication for $AUTH_IP. Proxy runs on$port and has the external IP $IP_ADDRESS "start" ( This command is used to start a specific IP, the use of "rotate" is recommended!. The ip to start has to be supplied as parameter &name=xx.xx.xx.xx Return values: ERROR:301:Starting unknown/foreign proxy not allowed : the specified IP is not within your allocated IPs or unknown ERROR:303:Proxy is already started or starting : the specified IP is already booting up (usually a matter of 2-5 seconds) ERROR:106:PROXY START FAILED:$IP_ADDRESS : indication of high load on the server, try again in 10 seconds. START:$PROXY_IP:$PORT:$IP_ADDRESS : start of IP succeeded, the proxy runs through$PORT "stop" ( This command is used to stop a running proxy once you are finished, this is only required when managing IPs without the use of the "rotate" cmd The parameter &name=xx.xx.xx.xx is required, to tell the API which Proxy to stop. Return values: ERROR:501:Proxy not found running:$IP_ADDRESS : the specified proxy is not started ERROR:102:STOP FAILED:$IP_ADDRESS : indication of high load on the server STOP:FINISHED:$IP_ADDRESS : stop finished successfully "comment" ( This command can be used to add, change, remove and view comments of a selected IP The parameter &ip=xx.xx.xx.xx is required, to tell the API which Proxy to check. The parameter &text=html_encoded_text, is used to change or remove the comment The parameter &view is used to view the selected comment Return values: COMMENT:Changed COMMENT:Removed COMMENT:comment text information "status" ( This command will give an overview about the currently started proxies The first line contains the number of started proxies (STATUS_RUNNING:$NUMBER_OF_RUNNING_PROXIES) Subsequent lines contain information about the started proxies, information pieces are separated by ":" (STATUS_PROXY:$EXTERNAL_IP:$PROXY_HOSTNAME:$PROXY_PORT:$PROXY_TYPE:$PROXY_COMMENT:$SECONDS_SINCE_START:$SECONDS_TILL_EXPIRE) For example: comment text:60:21000 The parameter "&human=1" can be added to receive a human readable status report with reduced information. Please note: more information might be added by future API versions. "proxy_protocol" ( This command allows to change the proxy protocol. Valid options are "http", "socks" and "vpn". The parameter &protocol= is required, otherwise the command will fail with an error Please note: This command will only change the protocol setting, currently active proxies will not change their protocol. It is required to use the "rotate" or "stop" and "start" commands to change the protocol of a running proxy process Return values: ERROR:601:unknown type PROXY_PROTOCOL:CHANGED:please restart or rotate proxy processes To detect you external IP we offer this free script: , it will return back your current IP address. See the php CURL example below as example. The same code can easily be converted into C,C++ or similar programming languages. The commands for activating IPs from the "subnet pool" are currently not supported for customers, this might be useful for resellers in future.

Example source code

PHP code for a new professional Google Rank Scraper with local country/language result support

Scraping Google Ranks for Fun and Profit

PHP code for a multipage and keyword expanding Google search result scraper

Scraping Google for Fun and Profit

Premium tool: a professional Digg bot including Captcha solving written in C++

Tiny Digg Bot

API code for a PHP script to rotate/start a proxy:

Example code for a console PHP script to test the external IP after rotation:

Example code for an imacros - myspace account creation script

Support for CLAD Genius

CLAD Genius supports automated proxy rotation through the API
There is no need for hacks and scripts anymore, all you need to do is to follow these simple instructions:
1. Start Clad Genius and click the configuration Icon on the upper right side 2. Go to the section "seo-proxies" and activate the checkbox. 3. Enter your userid (-1) and api password (d24479f7966bddb4e57451b8e35bb16d) into the two fields 4. Click the "Test" button, it should now obtain one IP from your pool and start it 5. Now head to the configuration of account creation and ad posting and setup seo-proxies as 1st proxy-rotation method (In settings, you have to go to Posting>Craigslist>Internet and then click on Change to set up the proxy priority rotation.) That's it, now CLAD G. is using your exclusive proxies Make sure NOT to use "USA" as Entry-proxy. Use the default "Europe" proxy for Clad-G and similar tools