Introduction
Get started with API by following this guide. To use the API, first top up your balance and create an order on the site through your account. For all methods you will need your API key. You can get it in your account settings.
[GET] Get user's current balance
Parameters:
api_key*: [your_API_key]
action*: getBalance
Output (json):
{"status":"ok","message":"","data":{"balance":"12.34"}}
Balance in USD.
Example link:
https://proxyshark.io/api/?api_key=[your_API_key]&action=getBalance
[GET] Get user's available traffic
Parameters:
api_key*: [your_API_key]
action*: getAvailableTraffic
Output (json):
{"status":"ok","message":"","data":{"available_traffic":12.34}}
Available traffic volume in GB.
Example link:
https://proxyshark.io/api/?api_key=[your_API_key]&action=getAvailableTraffic
[GET] Get a list of countries
Parameters:
api_key*: your API key
action*: getCountries
Output (json):
{"status":"ok","message":"","data":[{"name":"Abkhazia","iso":"ab"},{"name":"Afghanistan","iso":"af"},...]}
Example link:
https://proxyshark.io/api/?api_key=[your_API_key]&action=getCountries
[GET] Create a new order
Parameters:
api_key*: your API key
action*: createOrder
type: Proxy type (Residential GB - 1, Mobile - 4).
traffic_volume: Traffic volume.
number_of_proxies: The number of proxies to be created in the order. From 1 to
100 pcs per order. This parameter only
works if proxy mode=1 (Sticky).
country_iso: country code in ISO format. A list of all codes can be viewed using
the "getCountries" method above.
Output (json):
{"status":"ok","message":"","data":{"order_id":***,"proxies":[{"server":"*****","port":"*****","login":"*****","password":"*****"}]}}
Example link:
https://proxyshark.io/ api/?api_key=&action=[your_API_key]createProxy&type=[type]&traffic_volume=[traffic_volume]&number_of_proxies=[number_of_proxies]&country_iso=[country_ISO]
[GET] Create a new proxy
Parameters:
api_key*: your API key
action*: createProxy
country_iso: country code in ISO format. A list of all codes can be viewed using
the
"getCountries" method above.
mode: Proxy mode (Randomize - 0,
Sticky - 1).
protocol: Proxy protocol (HTTP - 0, HTTPS - 1, SOCKS5 - 2).
number_of_proxies: The number of proxies to be created in the order. From 1 to
100 pcs per order. This parameter only works if proxy
mode=1 (Sticky).
Output (json):
{"status":"ok","message":"","data":[{"server":"*****","port":"*****","login":"*****","password":"*****"}]}
Example link:
https://proxyshark.io/ api/?api_key=&action=[your_API_key]createProxy&country_iso=[country_ISO]&mode=[mode]&protocol=[protocol]&number_of_proxies=[number_of_proxies]
[GET] Update proxy country in order
Parameters:
api_key*: your API key
action*: updateCountry
id*: order ID
country_iso*: country code in ISO format. A list of all codes can be viewed using
the "getCountries" method above.
Output (json):
{"status":"ok","message":"","data":[{"server":"*****","port":"*****","login":"*****","password":"*****"}]}
Example link:
https://proxyshark.io/ api/?api_key=[your_API_key]&action=updateCountry&country=[country_ISO]&id=[id]
[GET] Update proxy protocol in order
Parameters:
api_key*: your API key
action*: updateProtocol
id*: order ID
protocol*: Proxy protocol (HTTP - 0, HTTPS - 1, SOCKS5 - 2).
Output (json):
{"status":"ok","message":"","data":[{"server":"*****","port":"*****","login":"*****","password":"*****"}]}
Example link:
https://proxyshark.io/ api/?api_key=[your_API_key]&action=updateProtocol&protocol=[protocol]&id=[id]
[GET] Update proxy mode in order
Parameters:
api_key*: your API key
action*: updateMode
id*: order ID
mode*: Proxy mode (Randomize - 0,
Sticky - 1).
number_of_proxies: The number of proxies to be created in the order. From 1 to
100 pcs per order. This parameter only works if proxy
mode=1 (Sticky).
Output (json):
{"status":"ok","message":"","data":[{"server":"*****","port":"*****","login":"*****","password":"*****"}]}
Example link:
https://proxyshark.io/ api/?api_key=[your_API_key]&action=updateMode&mode=[mode]&number_of_proxies=[number_of_proxies]&id=[id]
