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
autoprolong
Enabling and disabling proxy auto-renewal
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": "ok"
}
status
Always"ok", if the response is successful and no error occurred
"Error key":
{
"status": false,
"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.
"getbalance" method:
Get info about an account balance
https://proxy-store.com/api/{api_key}/getbalance
Response:
{
"status": "ok",
"balance": "100",
"currency": "USD"
}
"getcategory" method:
Get the list of available categories
Arguments:
nokey
When this argument is included (nokey=1), the list will be returned without keys.
https://proxy-store.com/api/{api_key}/getcategory?nokey=1
Response:
{
"status": "ok",
"list": [
{
"id": "for_al",
"name": "List of all sites"
}
]
}
"getprice" method:
Get info about the order amount depending on the period and number of proxies.
Arguments:
count
(Obligatory) - Number of proxies
period
(Obligatory) - Number of days
category
(Obligatory) - Purchase category (from getcategory attribute)
country
ISO two-letter code for the country
https://proxy-store.com/api/{api_key}/getprice?count=100&period=30&category=for_all&country=us
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": "ok",
"price": 1800,
"category", "for_all",
"price_single": 0.6,
"period": 30,
"country": "us",
"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
category
Proxy category
period
The period requested (number of days)
country
ISO two-letter code for the country
count
The number of proxies requested.
"getcount" method:
Get the number of certain countries' proxies available for purchasing. If the "category" or "country" parameters are missing, the response will show the number of proxies for all countries and categories
Arguments:
country
The two-letter ISO country code for the given country
category
Purchase category (from getcategory attribute)
https://proxy-store.com/api/{api_key}/getcount?country=ru&category=for_all
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": "ok",
"count": 971,
}
https://proxy-store.com/api/{api_key}/getcount
In the example above, we are obtaining information about the available quantity of IPv4 proxies for purchase.
In the case of a successful response without parameters:
{
"status":"ok",
"count": {
"for_all": {
"ru":18201,
"de":0,
"gb":2974,
"ua":2973,
"us":2787
},
"soc": {
"ru":18561,
"de":865,
"gb":2783,
"ua":2981,
"us":2991
},
...
}
}
count
Available quantity.
"getcountry" method:
Get info about available countries 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": "ok",
"list": "["ru","ua","us"]",
}
list
The set of available countries, formatted as ISO two-letter country codes.
"getproxy" method:
Get the list of your proxies.
Arguments:
state
The state of the proxies returned. Available values:active - Activate, expiring - expiring, all - All (default)
order_id
Internal order number. If this parameter is present, only proxies purchased as part of this order will be selected
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
nokey
When this argument is included (nokey=1), the list will be returned without keys.
https://proxy-store.com/api/{api_key}/getproxy
In the event of a successful response:
{
"status": "ok",
"list_count": 4,
"list": {
"11": {
"id": 11,
"ip": "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,
"comment": "",
"active": 1,
"category": "for_all"
},
"14": {
"id": 14,
"ip": "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,
"comment": "",
"active": 1,
"category": "for_all"
}
}
}
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
active
Active (1) or not active (0)
category
Proxy category
"setipauth" method:
Used to indicate IPs acceptable for proxy authorization (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 event of a successful response:
{
"status": "ok",
}
"settype" method:
Used to change the protocol of the proxies list.
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": "ok"
}
"setdescr" method:
Used to update the technical comment to the proxies list ("buy" method).
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.
{
"status": "ok",
"count": 4
}
count
Number of proxies for which the comment has been changed.
"buy" method:
Used to buy 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
Login for authorization via a proxy, 5-15 characters (optional)
password
Password for authorization via a proxy, 5-15 characters (optional)
generate_auth
Login/password generation: 1 - generation of data for authorization, 0 - disable generation of data for authorization via a proxy (default)
coupon
Promocode (optional)
nokey
When this argument is included (nokey=1), the list will be returned without keys
https://proxy-store.com/api/{api_key}/buy?category=for_all&count=1&period=30&country=ru
In the example above we are purchasing 1 Russian IPv4 proxy for 30 days.
In the event of a successful response:
{
"status": "ok",
"order_id": 100000,
"count": 1,
"price": 6.3,
"price_single": 0.9,
"period": 7,
"country": "ru"
"list": {
"15": {
"id": 15,
"ip": "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,
"comment": "",
"active": 1,
"category": "for_all"
}
}
}
order_id
Internal order number
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
IPv4 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)
category
Proxy category
"prolong" method:
Used to renew 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 (nokey=1), the list will be returned without keys
https://proxy-store.com/api/{api_key}/prolong?period=30&ids=15,16
In the example above we are extending the proxies with numbers 15 and 16 for 30 days.
In the event of a successful response:
{
"status": "ok",
"period": 30,
"price": 12.6,
"count": 2,
"list": {
"15": {
"id": 15,
"date_end": "2016-07-12 11:50:41",
"unixtime_end": 1468349441
},
"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
"autoprolong" method:
Used to auto-renew current proxies
*Auto-renewal is only available for 30 days
Arguments:
ids
(Obligatory) - Comma-separated list of internal IDs for the proxies in our system
coupon
Promocode (optional)
nokey
When this argument is included (nokey=1), the list will be returned without keys
https://proxy-store.com/api/{api_key}/autoprolong?ids=15,16&enabled=1
In the example above we are extending the proxies with numbers 15 and 16 for 30 days.
In case of a successful response:
{
"code":200,
"data":{
"15":{
"status":"success",
"enabled":true
},
"16":{
"status":"success",
"enabled":true
}
}
}
code
Response code, 200 in case of a successful request
status
Status of enabling/disabling auto-renewal for a specific proxy
enabled/disabled
True if auto-renewal has been enabled/disabled for the proxy
"delete" method:
Used to remove proxies
Arguments:
ids
(Obligatory) - Comma-separated list of internal IDs for the proxies in our system
https://proxy-store.com/api/{api_key}/delete?ids=15,16
In the example above we are deleting the proxies with numbers 15 and 16
In the event of a successful response:
{
"status": "ok",
"count": 2,
}
count
Number of deleted proxies
"check" method:
Used to check the validity of the 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": "ok",
"proxies": [
{
"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
