API Documentation

Parameter request types

There are four types of API requests you can make, including:

• getproxies
• displayproxies
• amountproxies
• lastupdated

getproxies

getproxies will immediately download the proxies once navigated to the URL. getproxies supports multiple parameters including:

• proxytype
• timeout
• ssl
• anonymity
• country
• limit
• format
• serialkey
• age
• status
• averagetimeout
• port

displayproxies

displayproxies will not download the proxies instead it will display the proxies on the website. displayproxies supports multiple parameters including:

• proxytype
• timeout
• ssl
• anonymity
• country
• limit
• format
• serialkey
• age
• status
• averagetimeout
• port

amountproxies

amountproxies will return the amount of available proxies for the given conditions. amountproxies supports multiple parameters including:

• proxytype
• timeout
• ssl
• anonymity
• country
• serialkey
• age
• status
• averagetimeout
• port

lastupdated

lastupdated will return when the proxies were last updated. lastupdated only requires one parameter:

• proxytype

keystatus

keystatus will return the status of a key and has one allowed parameter:

• serialkey

remaining

remaining will return how long a premium serial key remains active and has one allowed parameter:

• serialkey

Parameter request type values

Parameter values are used to tell the API what kind of proxies you want.

proxytype

proxytype has 4 allowed values:

• http
• socks4
• socks5
• all

When you don't set this value the proxy type will be automatically set to 'all'.
You can also use multiple proxy types in 1 request by separating them by a comma.

timeout

The timeout is in milliseconds.
When no timeout is defined the timeout is automatically set to 10,000ms.

country

The country parameter can be any Alpha 2 ISO country code or 'all', the country codes can be found here.
When no country is defined the country will be automatically set to 'all'.
You can also use multiple countries in 1 request by separating them by a comma.

anonymity

anonymity has 4 allowed values:

• elite
• anonymous
• transparent
• all

When no anonymity level is defined it will be automatically set to 'all'.
You can also use multiple anonymity levels in 1 request by separating them by a comma.

ssl

SSL has 3 allowed values:

• yes
• no
• all

When SSL is not defined it will be automatically set to 'all'.

limit

the limit parameter will limit the amount of proxies that get downloaded or displayed and can be any number above 0
When limit is not defined it will be automatically set to 'all'.

format

format has 2 allowed values:

• normal
• json

When format is not defined it will be automatically set to 'normal'.

serialkey

serialkey can be any key bought from our store
When serialkey is not provided it will automaticly use the free api and any premium features can't be used.

averagetimeout

The averagetimeout is in milliseconds.
When no averagetimeout is defined the averagetimeout is automatically set to 10,000ms.

status

Status can be "alive" or any number in days.
When no status is provided it will automaticly be set to "alive".

age

age is when the proxy was first seen, this can be "unlimited" or any number in days.
When no age is provided it will be automaticly set to "unlimited".

port

port can be any number between 1 and 65535.
When no port is provided it will be automaticly set to "all".
You can also use multiple ports in 1 request by separating them by a comma.