API for developers

https://proxy-store.com/api/{api_key}/{method}/?{params}

api_key

Secret key, which you can obtain in your account settings;

method

Name of a method;

params

Additional options depending on the particular method.

Any charges will be deducted from your account balance!

getbalance

Get the balance on an account;

getcategory

Get a list of categories

getprice

Get information on the amount of an order;

getcount

Get information about the available number of proxies for a particular country;

getcountry

Get a list of available countries;

getproxy

Get a list of your proxies;

settype

Change the type (protocol) of a proxy);

setdescr

Update the technical description;

buy

Purchase a proxy;

prolong

Extend the list of proxies;

delete

Delete a proxy;

setipauth

IP authorization for the proxy;

check

Check the validity of a proxy.

When accessing any API method, the status will always be present in the response:

Successful response:

{
"status": "yes",
}

status

Always "yes", if the response is successful and no error occurred

Error response:

{
"status": "no",
"error_id": 100,
"error": "Error key"
}

status

Always "yes", if the response signals an error

error_id

ID number of the error;

error

Description of the error.

Get a list of available categories

Arguments:

nokey

When this argument is included (no value is required), the list will be returned without keys.

https://proxy-store.com/api/{api_key}/getcategory?nokey

Response:

{
"status": "yes",
"list": [
{
"id": "for_al",
"name": "List of all sites"
}
]
}

Used to obtain information about the order amount (the price) depending on the period and the number of proxies.

Arguments:

count

(Obligatory) - Number of proxies;

period

(Obligatory) - Number of days;

https://proxy-store.com/api/{api_key}/getprice?count=100&period=30

In the argument above we are obtaining information on the price of 100 IPv4 proxies for 30 days.

In the event of a successful response:

{
"status": "yes",
"price": 1800,
"price_single": 0.6,
"period": 30,
"count": 100
}

price

When this argument is included (no value is required), the list will be returned without keys.

price_single

Price of a single proxy;

period

The period requested (number of days);

count

The number of proxies requested.

Used to obtain information on the number of proxies for a particular country that are available for purchase.

Arguments:

country

(Obligatory) - The two-letter ISO country code for the given country;

https://proxy-store.com/api/{api_key}/getcount?country=ru

In the example above we are obtaining information about the number of Russian IPv4 proxies available for purchase.

In the event of a successful response:

{
"status": "yes",
"count": 971
}

count

Available quantity.

Used to obtain information about countries available for purchase.

Arguments:

category

(Obligatory) - Purchase category (from getcategory attribute);

https://proxy-store.com/api/{api_key}/getcountry?category=for_all

In the event of a successful response:

{
"status": "yes",
"list": ["ru","ua","us"]
}

list

The set of available countries, formatted as ISO two-letter country codes.

Used to obtain a list of your proxies.

Arguments:

state

The state of the proxies returned. Available values:
active - Activate, expiring - expiring, all - All (default);

comment

A comment which you have specified for a proxy. If this argument is supplied, then only those proxies for which you have specified that particular comment will be chosen. If this argument is not supplied, then all proxies will be chosen;

https://proxy-store.com/api/{api_key}/getproxy

In the event of a successful response:

{ "status": "yes", "list_count": 4, "list": { "11": { "id": "11", "ip": "2a00:1838:32:19f:45fb:2640::330", "host": "185.22.134.250", "port": "7330", "user": "5svBNZ", "pass": "iagn2d", "type": "http", "country": "ru", "date": "2016-06-19 16:32:39", "date_end": "2016-07-12 11:50:41", "unixtime": 1466379159, "unixtime_end": 1468349441, "descr": "" }, "14": { "id": "14", "ip": "2a00:1838:32:198:56ec:2696::386", "host": "185.22.134.242", "port": "7386", "user": "nV5TFK", "pass": "3Itr1t", "type": "http", "country": "ru", "date": "2016-06-27 16:06:22", "date_end": "2016-07-11 16:06:22", "unixtime": 1466379159, "unixtime_end": 1468349441, "descr": "" } } }

list_count

Number of proxies;

list

The set of proxies;

id

Internal ID number of the proxy, needed to extend a proxy’s validity period using the method prolong;

ip

IPv4;

port

Port;

user

Username;

pass

Password;

type

Type of proxy: http for HTTPS, socks for SOCKS5;

country

ISO two-letter code for the country;

date

Date when proxy was purchased;

date_end

Date when a proxy’s period of validity ends;

comment

Comment;

Used to specify IP addresses from which you can authorize on the proxy (up to 3 pcs)

Arguments:

ips

IP list separated by commas (up to 3 pcs);

ids

(Obligatory) - Comma-separated list of internal IDs for the proxies in our system;

https://proxy-store.com/api/{api_key}/setipauth?ids=10,11,12,15&ips=192.168.1.2,192.168.1.5

In the example above, we change the authorization IP to 192.168.1.2,192.168.1.5. To return authorization by login / password, specify an empty value for ips.

In the event of a successful response:

{ "status": "yes" }

Used for changing the type (protocol) in the list of proxies.

Arguments:

ids

(Obligatory) - Comma-separated list of internal ID numbers for the proxies in our system;

type

(Obligatory) - Set type (protocol): http - HTTPS, or socks - SOCKS5.

https://proxy-store.com/api/{api_key}/settype?ids=10,11,12,15&type=socks

In the example above we are changing the proxy type for numbers 10,11,12,15 to SOCKS5.

In the event of a successful response:

{ "status": "yes" }

Used to update the comment left for a list of proxies that have been purchased (using method buy).

Arguments:

comment

(Obligatory) - New comment value (maximum length is 50 characters);

old_comment

The comment that you wish to change;

ids

Comma-separated list of internal ID numbers in our system.

One of the arguments, either ids or old_comment, must be supplied.

https://proxy-store.com/api/{api_key}/setdescr?old_comment=test&comment=newtest

In the example above we are changing the comment from test to newtest.

In the event of a successful response:

{ "status": "yes", "count": 4 }

count

Number of proxies for which the comment has been changed.

Used to purchase proxies.

Arguments:

category

(Obligatory) - Purchase category (from getcategory attribute);

count

(Obligatory) - The number of proxies to purchase;

period

(Obligatory) - The period, specified as the number of days, for which the proxies are being purchased;

country

(Obligatory) - The country, represented by the ISO two-letter country code;

type

Type of proxy (protocol): socks, or http (default);

comment

Comment for the list of proxies (maximum length 50 characters) – supplying this argument allows you to subsequently select a list of proxies based on this value using the method getproxy;

username

Comment for the list of proxies (maximum length 50 characters) – supplying this argument allows you to subsequently select a list of proxies based on this value using the method getproxy;

password

Comment for the list of proxies (maximum length 50 characters) – supplying this argument allows you to subsequently select a list of proxies based on this value using the method getproxy;

generate_auth

Comment for the list of proxies (maximum length 50 characters) – supplying this argument allows you to subsequently select a list of proxies based on this value using the method getproxy;

auto_prolong

When this argument is included (no value is required), auto-extension of the purchased proxies will be activated;

coupon

Promocode (optional);

nokey

When this argument is included (no value is required), the list will be returned without keys.

https://proxy-store.com/api/{api_key}/buy?category=for_all&count=1&period=7&country=ru

In the example above we are purchasing 1 Russian IPv6 proxy for 7 days.

In the event of a successful response:

{ "status": "yes", "user_id": "1", "balance": 42.5, "currency": "RUB", "count": 1, "price": 6.3, "price_single": 0.9, "period": 7, "country": "ru", "list": { "15": { "id": "15", "ip": "2a00:1838:32:19f:45fb:2640::330", "host": "185.22.134.250", "port": "7330", "user": "5svBNZ", "pass": "iagn2d", "type": "http", "date": "2016-06-19 16:32:39", "date_end": "2016-07-12 11:50:41", "unixtime": 1466379159, "unixtime_end": 1468349441, "active": "1" } } }

count

The requested number of proxies to purchase;

price

Total price;

price_single

Price of a single proxy for the specified number and period;

period

The requested period, specified as the number of days, for purchase;

country

The location (country) of the proxies for purchase, represented by the ISO two-letter country code;

list

The set of proxies purchased;

id

Internal ID number of the proxy, needed to extend a proxy’s validity period using the method prolong;

ip

IPv6 hidden behind host:port;

host

IPv4;

port

Port;

user

Username;

pass

Password;

type

Type of proxy: http for HTTPS, socks for SOCKS5;

date

Date when proxy was purchased;

date_end

Date when a proxy’s period of validity ends;

active

Active (1) or not active (0).

Used to extend the current proxies.

Arguments:

period

(Obligatory) - Period for which you are extending the proxies, expressed as the number of days;

ids

(Obligatory) - Comma-separated list of internal IDs for the proxies in our system;

coupon

Promocode (optional);

nokey

When this argument is included (no value is required), the list will be returned without keys.

https://proxy-store.com/api/{api_key}/prolong?period=7&ids=15,16

In the example above we are extending the proxies with numbers 15 and 16 for 7 days.

In the event of a successful response:

{ "status": "yes", "user_id": "1", "balance": 29, "currency": "RUB", "price": 12.6, "price_single": 0.9, "period": 7, "count": 2, "list": { "15": { "id": 15, "date_end": "2016-07-15 06:30:27", "unixtime_end": 1466379159 }, "16": { "id": 16, "date_end": "2016-07-16 09:31:21", "unixtime_end": 1466379261 } } }

price

Total price for the extension;

price_single

Price of a single proxy for the specified amount and period (not present when extending a mixed type of proxies);

period

The requested period, specified as the number of days, for extension;

count

Number of successful extensions;

list

List of extended proxies;

id

Internal ID for the proxy;

date_end

New date at which the proxy’s validity will end.

Used to check the validity (functional status) of a proxy.

Arguments:

ids

(Obligatory) - Internal ID for the proxy in our system.

https://proxy-store.com/api/{api_key}/check?ids=15

In the example above we are testing the proxy with number 15.

In the event of a successful response:

{ "status": "yes", "user_id": "1", "balance": "48.80", "currency": "RUB", "proxy_id": 15, "proxy_status": true }

proxy_id

Internal ID for the proxy;

proxy_status

Result of test: true or false.

Code

Text

Description

Code:

1

Text:

Error unknown

Description:Unknown error

Code:

2

Text:

Error key

Description:Authentication error, invalid key

Code:

3

Text:

Error method

Description:Method is not valid

Code:

4

Text:

Error count

Description:Error in the number of proxies: incorrectly specified number or no number supplied

Code:

5

Text:

Error period

Description:Error with regard to the period: the period (number of days) is correctly specified or no period is supplied

Code:

6

Text:

Error country

Description:Error with regard to the country: country is specified incorrectly (countries are represented in ISO two-letter country codes) or no country supplied

Code:

7

Text:

Error category

Description:Error with regard to the category: the category is incorrectly specified or no category is supplied

Code:

8

Text:

Error ids

Description:Error with regard to the list of proxy ID numbers: the IDs for the proxies should be comma-separated

Code:

9

Text:

Error coupon

Description:Error with regard to a coupon: an invalid or expired coupon was supplied

Code:

10

Text:

Error comment

Description:Error with regard to a comment: the comment was incorrectly specified or no comment was supplied

Code:

11

Text:

Error type

Description:Error with regard to the type (protocol) of a proxy: the type was incorrectly specified or no type was supplied

Code:

12

Text:

Error active proxy allow

Description:Error with regard to the number of proxies: occurs when one attempts to purchase a larger number of proxies than is available from the service

Code:

13

Text:

Error no money

Description:Error regarding one’s account balance: your balance lacks funds, or they are insufficient to purchase the requested number of proxies

Code:

404

Text:

Error not found

Description:Occurs when the element you are requesting is not found

Code:

14

Text:

Error price

Description:Error in the value of the price: the total price is less than or equal to zero

API for developers

Communication with the API is carried out using the URL:

Available methods:

Method "getcategory":

Method "getprice":

Method "getcount":

Method "getcountry":

Method "getproxy":

Method "setipauth":

Method "settype":

Method "setdescr":

Method "buy":

Method "prolong":

Method "check":

Error codes