Home API for developers

FOR DEVELOPERS (API)

Communication with the API is carried out using the URL:

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!

Available methods:

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 "no", if the response signals an error;
error_id - ID number of the error;
error - Description of the error.

Method getcategory:

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"
}
]
}

Method "getprice"

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) - Period - number of days;
version - Proxy version: 1- IPv4 (default), 2 - IPv4 Shared

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 - Total price;
price_single - Price of a single proxy;
period - The period requested (number of days);
count - The number of proxies requested.

Method "getcount"

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;
version - Proxy version: 1- IPv4 (default), 2 - IPv4 Shared.

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.

Method "getcountry"

Used to obtain information about countries available for purchase.

Arguments:

version - Proxy version: 1- IPv4 (default), 2 - IPv4 Shared.

https://proxy-store.com/api/{api_key}/getcountry?version=1

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.

Method "getproxy"

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;

Method "settype"

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"
}

Method "setcomment"

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.

Method "buy"

Used to purchase proxies.

Arguments:

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;
version - Proxy version: 4- IPv4, 3 - IPv4 Shared, 6 - IPv6 (default);
type - Type of proxy (protocol): socks, or http (default);
descr - 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;
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?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 the period of activity 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).

Method "prolong"

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;
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.

Method "check"

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.

Error codes

Code	Text	Description
1	Error unknown	Unknown error
2	Error key	Authentication error, invalid key
3	Error method	Method is not valid
4	Error count	Error in the number of proxies: incorrectly specified number or no number supplied
5	Error period	Error with regard to the period: the period (number of days) is correctly specified or no period is supplied
6	Error country	Error with regard to the country: country is specified incorrectly (countries are represented in ISO two-letter country codes) or no country supplied
7	Error category	Error with regard to the category: the category is incorrectly specified or no category is supplied
8	Error ids	Error with regard to the list of proxy ID numbers: the IDs for the proxies should be comma-separated
9	Error coupon	Error with regard to a coupon: an invalid or expired coupon was supplied
10	Error comment	Error with regard to a comment: the comment was incorrectly specified or no comment was supplied
11	Error type	Error with regard to the type (protocol) of a proxy: the type was incorrectly specified or no type was supplied
12	Error active proxy allow	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
13	Error no money	Error regarding one’s account balance: your balance lacks funds, or they are insufficient to purchase the requested number of proxies
404	Error not found	Occurs when the element you are requesting is not found
14	Error price	Error in the value of the price: the total price is less than or equal to zero