EN
EN
EN
EN
Developers API

Api will allow you to integrate the purchase and renewal of a proxy into your service or application. The interaction of the partner with the system, as well as the system with the partner, occurs through “application / json” requests and responses. All communication takes place in UTF-8 encoding.

To get the balance information

The request allows to see the current balance

GET
/client-api/v1/<apiKey>/get/balance
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD"
}
Response params:
  • "success" - operation status -"true/false",
  • "balance" - the current balance.
To get the full list of the bought proxies
GET
/client-api/v1/<apiKey>/get/proxies
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"countOfProxy":6,
"ipv4":
[
{
"id":"id1",
"ip":"185.81.112.215",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id2",
"ip":"107.181.142.223",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
],
"ipv6":
[
{
"orderId":"orderId1",
"ips":
[
{
"id":"id3",
"ip":"140.82.53.23:10002",
"country":"FRA",
"dateStart":"2022-08-03T14:04:59.131+00:00",
"dateEnd":"2022-10-02T14:04:59.159+00:00",
"protocol":"SOCKS5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id4",
"ip":"140.82.53.23:10004",
"country":"FRA",
"dateStart":"2022-08-03T14:04:59.131+00:00",
"dateEnd":"2022-10-02T14:04:59.159+00:00",
"protocol":"SOCKS5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
],
"isp":
[
{
"id":"id21",
"ip":"185.81.112.210",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id22",
"ip":"110.18.142.213",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
],
"mobile":
[
{
"id":"id5",
"ip":"61.62.63.64",
"country":"FRA",
"dateStart":"2022-08-30T14:54:25.414+00:00",
"dateEnd":"2022-09-29T23:59:25.414+00:00",
"httpsPort":"7781",
"socks5Port":"8891",
"mobileOperator":"freemobilesas_france",
"rotationTime":0,
"rebootLink":"https://proxy-ipv4.com/modem/reboot/448eac96-8546-4389-8f56-54b2sb4798d12",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id6",
"ip":"61.62.63.64",
"country":"FRA",
"dateStart":"2022-08-30T14:54:25.414+00:00",
"dateEnd":"2022-09-29T23:59:25.414+00:00",
"httpsPort":"7782",
"socks5Port":"8892",
"mobileOperator":"freemobilesas_france",
"rotationTime":0,
"rebootLink":"https://proxy-ipv4.com/modem/reboot/44cf7d39-b682-4296-8909-7038ba99008b5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
Response params:
  • "ipv4" - the list of active ipv4 proxies,
  • "ipv6" - the list of active ipv6 proxies,
  • "mobile" - the list of active mobile proxies,
  • "isp" - the list of active isp proxies,
  • "id" - proxy ID. This parameter is needed for extending proxy,
  • "orderId" - order ID. Ipv6, unlike the rest of the proxy types, allows to extend all the proxies in the order only,
  • "country" - alfa3 country code,
  • "dateStart" - the rent start date,
  • "dateEnd" - the rent end date,
  • "authInfo" - the data for authorization,
  • "protocol" - protocol -"HTTPS/SOCKS5",
  • "rotationTime" - rotation time of IP address in minutes. 0 is rotation by link at any moment,
  • "rebootLink" - link for IP reboot,
  • "mobileOperator" - mobile operator.
To get the available number of days for a proxy purchase/renewal

An available number of days can differ depending on the proxy type

GET
/client-api/v1/<apiKey>/get/days
Request parameters:
  • "proxyType" - type of proxy. Value can be of four types -"ipv4/ipv6/isp/mobile".
Example request:
/client-api/v1/<apiKey>/get/days?proxyType=ipv4
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"days":
[
1,
7,
14,
30,
60,
90
]
}
To get the list of the countries available for purchase

The list of available countries can differ depending on the proxy type

GET
/client-api/v1/<apiKey>/get/countries
Request parameters:
  • "proxyType" - type of proxy. Value can be of four types -"ipv4/ipv6/isp/mobile".
Example request:
/client-api/v1/<apiKey>/get/countries?proxyType=ipv4
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"countries":
[
{
"name":"ENGLAND",
"alpha3code":"GBR"
},
{
"name":"USA",
"alpha3code":"USA"
},
{
"name":"FRANCE",
"alpha3code":"FRA"
}
]
}
Response params:
  • "name" - name of country,
  • "alpha3code" - alfa3 country code. Value of this field will be used for placing an order.
To get the ipv4 list of the bought proxies
GET
/client-api/v1/<apiKey>/get/proxies
Request parameters:
  • "proxyType" - type of proxy -"ipv4".
Example request:
/client-api/v1/<apiKey>/get/proxies?proxyType=ipv4
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv4",
"countOfProxy":2,
"proxies":
[
{
"id":"id1",
"ip":"185.81.112.215",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id2",
"ip":"107.181.142.223",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
Response params:
  • "proxies" - the list of active ipv4 proxies,
  • "id" - proxy ID. This parameter is needed for extending proxy,
  • "country" - alfa3 country code,
  • "dateStart" - the rent start date,
  • "dateEnd" - the rent end date,
  • "authInfo" - the data for authorization.
Calculate purchase price
GET
/client-api/v1/<apiKey>/get/order/price
Request parameters:
  • "proxyType" - type of proxy -"ipv4",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code (available values can be got by other request),
  • "count" - the number of proxies.
Example request:
/client-api/v1/<apiKey>/get/order/price?proxyType=ipv4&days=7&goal=instagram&country=FRA&count=2
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv4",
"days":7,
"count":2,
"goal":"instagram",
"amount":2.78,
"price":1.39
}
Response params:
  • "amount" - total amount,
  • "price" - price for one proxy.
Calculate extending price
GET
/client-api/v1/<apiKey>/get/extend/price
Request parameters:
  • "proxyType" - type of proxy -"ipv4",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - proxy IDs that require renewal (it is allowed to indicate several IDs separated by commas).
Example request:
/client-api/v1/<apiKey>/get/extend/price?proxyType=ipv4&days=7&IpId=id1,id2,id3
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv4",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Response params:
  • "amount" - total amount,
  • "price" - price for extending one proxy,
  • "ipId" - the list of proxy IDs for extending.
Placing an order
POST
/client-api/v1/<apiKey>/order
Request parameters:
  • "proxyType" - type of proxy -"ipv4",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code,
  • "count" - the number of proxies,
  • "authType" - authorization type -"login/ip",
  • "authIp" - authorization IP address. This field is required only if authType = ip.
Example request:
/client-api/v1/<apiKey>/order
Example body request:
{
"proxyType":"ipv4",
"days":90,
"goal":"instagram",
"country":"GBR",
"count":2,
"authType":"login"
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"ipv4",
"orderNumber":"DV-16620211552356-jA"
}
Response params:
  • "orderNumber" - order number,
  • "balance" - the balance after the purchase.
Extending proxy
POST
/client-api/v1/<apiKey>/extend
Request parameters:
  • "proxyType" - type of proxy -"ipv4",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - the list of proxy IDs to be extended.
Example request:
/client-api/v1/<apiKey>/extend
Example body request:
{
"proxyType":"ipv4",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Response params:
  • "balance" - the balance after extending.
To get the ipv4 list of the bought proxies
GET
/client-api/v1/<apiKey>/get/proxies
Request parameters:
  • "proxyType" - type of proxy -"ipv6".
Example request:
/client-api/v1/<apiKey>/get/proxies?proxyType=ipv6
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv6",
"countOfProxy":2,
"proxies":
[
{
"orderId":"orderId1",
"ips":
[
{
"id":"id1",
"ip":"140.82.53.23:10002",
"country":"FRA",
"dateStart":"2022-08-03T14:04:59.131+00:00",
"dateEnd":"2022-10-02T14:04:59.159+00:00",
"protocol":"SOCKS5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id2",
"ip":"140.82.53.23:10004",
"country":"FRA",
"dateStart":"2022-08-03T14:04:59.131+00:00",
"dateEnd":"2022-10-02T14:04:59.159+00:00",
"protocol":"SOCKS5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
]
}
Response params:
  • "proxies" - the list of active ipv4 proxies,
  • "orderId" - //too,
  • "id" - proxy ID,
  • "country" - alfa3 country code,
  • "dateStart" - the rent start date,
  • "dateEnd" - the rent end date,
  • "protocol" - protocol -"HTTPS/SOCKS5",
  • "authInfo" - the data for authorization.
Calculate purchase price
GET
/client-api/v1/<apiKey>/get/order/price
Request parameters:
  • "proxyType" - type of proxy -"ipv6",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code (available values can be got by other request),
  • "count" - the number of proxy. The value must be more then 10.
Example request:
/client-api/v1/<apiKey>/get/order/price?proxyType=ipv6&days=30&goal=instagram&country=FRA&count=10
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv6",
"days":30,
"count":10,
"goal":"instagram",
"amount":7.25,
"price":0.72
}
Response params:
  • "amount" - total amount,
  • "price" - price for one proxy.
Calculate extending price
GET
/client-api/v1/<apiKey>/get/extend/price
Request parameters:
  • "proxyType" - type of proxy -"ipv6",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "orderId" - order IDs that require renewal (it is allowed to indicate several IDs separated by commas).
Example request:
/client-api/v1/<apiKey>/get/extend/price?proxyType=ipv6&days=30&orderId=orderId1,orderId2
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv6",
"days":30,
"count":20,
"amount":123.42,
"price":6.17,
"ordersId":
[
"orderId1",
"orderId2"
],
"ipId":
[
"id1",
"id2",
"id3",
"id4",
"id5",
"id6",
"id7",
"id8",
"id9",
"id10",
"id11",
"id12",
"id13",
"id14",
"id15",
"id16",
"id17",
"id18",
"id19",
"id20"
]
}
Response params:
  • "amount" - total amount,
  • "price" - price for extending one proxy,
  • "ordersId" - the list of order IDs for extending,
  • "ipId" - the list of proxy IDs for extending.
Placing an order
POST
/client-api/v1/<apiKey>/order
Request parameters:
  • "proxyType" - type of proxy -"ipv6",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code,
  • "count" - the number of proxies. Value can be more then 10,
  • "authType" - authorization type -"login/ip",
  • "authIp" - authorization IP address. This field is required only if authType = ip,
  • "protocol" - protocol -"HTTPS/SOCKS5".
Example request:
/client-api/v1/<apiKey>/order
Example body request:
{
"proxyType":"ipv6",
"days":30,
"goal":"instagram",
"country":"GBR",
"count":10,
"authType":"login",
"protocol":"SOCKS5"
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"ipv6",
"orderNumber":"DV-211552356-jA"
}
Response params:
  • "orderNumber" - order number,
  • "balance" - the balance after the purchase.
Extending proxy
POST
/client-api/v1/<apiKey>/extend
Request parameters:
  • "proxyType" - type of proxy -"ipv6",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "orderId" - the list of order IDs to be extended.
Example request:
/client-api/v1/<apiKey>/extend
Example body request:
{
"proxyType":"ipv6",
"days":30,
"orderId":
[
"orderId1"
]
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Response params:
  • "balance" - the balance after extending.
To get the isp list of the bought proxies
GET
/client-api/v1/<apiKey>/get/proxies
Request parameters:
  • "proxyType" - type of proxy -"isp".
Example request:
/client-api/v1/<apiKey>/get/proxies?proxyType=isp
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"isp",
"countOfProxy":2,
"proxies":
[
{
"id":"id1",
"ip":"185.81.112.215",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id2",
"ip":"107.181.142.223",
"country":"GBR",
"dateStart":"2022-08-29T14:55:38.293+00:00",
"dateEnd":"2022-08-30T23:59:38.293+00:00",
"httpsPort":"49162",
"socks5Port":"49163",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
Response params:
  • "proxies" - the list of active isp proxies,
  • "id" - proxy ID. This parameter is needed for extending proxy,
  • "country" - alfa3 country code,
  • "dateStart" - the rent start date,
  • "dateEnd" - the rent end date,
  • "authInfo" - the data for authorization.
Calculate purchase price
GET
/client-api/v1/<apiKey>/get/order/price
Request parameters:
  • "proxyType" - type of proxy -"isp",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code (available values can be got by other request),
  • "count" - the number of proxies.
Example request:
/client-api/v1/<apiKey>/get/order/price?proxyType=isp&days=7&goal=instagram&country=FRA&count=2
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"isp",
"days":7,
"count":2,
"goal":"instagram",
"amount":2.78,
"price":1.39
}
Response params:
  • "amount" - total amount,
  • "price" - price for one proxy.
Calculate extending price
GET
/client-api/v1/<apiKey>/get/extend/price
Request parameters:
  • "proxyType" - type of proxy -"isp",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - proxy IDs that require renewal (it is allowed to indicate several IDs separated by commas).
Example request:
/client-api/v1/<apiKey>/get/extend/price?proxyType=isp&days=7&IpId=id1,id2,id3
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"isp",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Response params:
  • "amount" - total amount,
  • "price" - price for extending one proxy,
  • "ipId" - the list of proxy IDs for extending.
Placing an order
POST
/client-api/v1/<apiKey>/order
Request parameters:
  • "proxyType" - type of proxy -"isp",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code,
  • "count" - the number of proxies,
  • "authType" - authorization type -"login/ip",
  • "authIp" - authorization IP address. This field is required only if authType = ip.
Example request:
/client-api/v1/<apiKey>/order
Example body request:
{
"proxyType":"isp",
"days":90,
"goal":"instagram",
"country":"GBR",
"count":2,
"authType":"login"
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"isp",
"orderNumber":"DV-16620211552356-jA"
}
Response params:
  • "orderNumber" - order number,
  • "balance" - the balance after the purchase.
Extending proxy
POST
/client-api/v1/<apiKey>/extend
Request parameters:
  • "proxyType" - type of proxy -"isp",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - the list of proxy IDs to be extended.
Example request:
/client-api/v1/<apiKey>/extend
Example body request:
{
"proxyType":"isp",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Response params:
  • "balance" - the balance after extending.
To get the list of available mobile tariffs
GET
/client-api/v1/<apiKey>/get/tariffs
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"tariffs":
[
{
"country":"GBR",
"mobileOperator":
[
{
"name":"Three",
"rotationTime":
[
0,
5,
10
]
},
{
"name":"O2",
"rotationTime":
[
5,
10
]
}
]
},
{
"country":"USA",
"mobileOperator":
[
{
"name":"AT&T Wireless",
"rotationTime":
[
0,
5,
10
]
}
]
}
]
}
Response params:
  • "tariffs" - the list of tariffs,
  • "country" - alfa3 country code,
  • "mobileOperator" - the list of available operators for this country,
  • "rotationTime" - available rotation times of IP address in minutes. 0 is rotation by link at any moment.
the list of active mobile proxies
GET
/client-api/v1/<apiKey>/get/proxies
Request parameters:
  • "proxyType" - type of proxy -"mobile".
Example request:
/client-api/v1/<apiKey>/get/proxies?proxyType=mobile
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"mobile",
"countOfProxy":2,
"proxies":
[
{
"id":"id1",
"ip":"61.62.63.64",
"country":"FRA",
"dateStart":"2022-08-30T14:54:25.414+00:00",
"dateEnd":"2022-09-29T23:59:25.414+00:00",
"httpsPort":"7781",
"socks5Port":"8891",
"mobileOperator":"freemobilesas_france",
"rotationTime":0,
"rebootLink":"https://proxy-ipv4.com/modem/reboot/448eac96-8546-4389-8f56-54b2sb4798d12",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
},
{
"id":"id2",
"ip":"61.62.63.64",
"country":"FRA",
"dateStart":"2022-08-30T14:54:25.414+00:00",
"dateEnd":"2022-09-29T23:59:25.414+00:00",
"httpsPort":"7782",
"socks5Port":"8892",
"mobileOperator":"freemobilesas_france",
"rotationTime":0,
"rebootLink":"https://proxy-ipv4.com/modem/reboot/44cf7d39-b682-4296-8909-7038ba99008b5",
"authInfo":
{
"login":"authLogin123",
"password":"authPassword"
}
}
]
}
Response params:
  • "proxies" - the list of active proxies,
  • "id" - proxy ID. This parameter is needed for extending proxy,
  • "country" - alfa3 country code,
  • "dateStart" - the rent start date,
  • "dateEnd" - the rent end date,
  • "rotationTime" - the rotation time of IP address in minutes. 0 is rotation by link at any moment,
  • "rebootLink" - the link for rotation IP,
  • "authInfo" - the data for authorization.
Calculate purchase price
GET
/client-api/v1/<apiKey>/get/order/price
Request parameters:
  • "proxyType" - type of proxy -"mobile",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy (available values can be got by other request),
  • "customGoal" - if the goal you need is not present in the goal list, you can indicate your own goal. Length of field must be 5 characters or more (one of the parameters - goal or customGoal - must be in the request),
  • "country" - alfa3 country code (available values can be got by other request),
  • "count" - the number of proxies,
  • "mobileOperator" - the mobile operator (available values can be got by other request),
  • "rotationTime" - the rotation time of IP address in minutes (available values can be got by other request).
Example request:
/client-api/v1/<apiKey>/get/order/price?proxyType=mobile&days=7&goal=instagram&country=FRA&count=1&mobileOperator=freemobilesas_france&rotationTime=5
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"mobile",
"rotationTime":5,
"mobileOperator":"freemobilesas_france",
"days":7,
"count":1,
"goal":"instagram",
"amount":1.78,
"price":1.78
}
Response params:
  • "amount" - total amount,
  • "price" - price for one proxy.
Calculate extending price
GET
/client-api/v1/<apiKey>/get/extend/price
Request parameters:
  • "proxyType" - type of proxy -"mobile",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - proxy IDs that require renewal (it is allowed to indicate several IDs separated by commas).
Example request:
/client-api/v1/<apiKey>/get/extend/price?proxyType=mobile&days=7&IpId=id1,id2,id3
Example body answer:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"mobile",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Response params:
  • "amount" - total amount,
  • "price" - price for extending one proxy,
  • "ipId" - the list of proxy IDs for extending.
Placing an order
POST
/client-api/v1/<apiKey>/order
Request parameters:
  • "proxyType" - type of proxy -"mobile",
  • "days" - the number of rental days (available values can be got by other request),
  • "goal" - goal of using proxy,
  • "country" - alfa3 country code,
  • "count" - the number of proxies,
  • "authType" - authorization type -"login/ip",
  • "authIp" - authorization IP address. This field is required only if authType = ip,
  • "mobileOperator" - the mobile operator (available values can be got by other request),
  • "rotationTime" - the rotation time of IP address in minutes (available values can be got by other request).
Example request:
/client-api/v1/<apiKey>/order
Example body request:
{
"proxyType":"mobile",
"days":30,
"goal":"instagram",
"country":"FRA",
"count":1,
"authType":"login",
"mobileOperator":"freemobilesas_france",
"rotationTime":5
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"mobile",
"orderNumber":"DV-21x1552356-jA"
}
Response params:
  • "orderNumber" - order number,
  • "balance" - the balance after the purchase.
Extending proxy
POST
/client-api/v1/<apiKey>/extend
Request parameters:
  • "proxyType" - type of proxy -"mobile",
  • "days" - the number of renewal days (the available values are the same as for the purchase),
  • "IpId" - the list of proxy IDs to be extended.
Example request:
/client-api/v1/<apiKey>/extend
Example body request:
{
"proxyType":"mobile",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Example body answer:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Response params:
  • "balance" - the balance after extending.

In case of failed query, you will get an error message

Error Example:
{
"success":false,
"error_id":5,
"error":"Incorrect proxy type"
}
  • "error_id" - error ID,
  • "error" - error message.
ID errors:
  • "1" - API disabled on the server,
  • "3" - Error auth. Your IP doesn't have access,
  • "4" - Method not supported,
  • "5" - Incorrect proxy type,
  • "6" - Ipv4 proxies disabled on the server,
  • "7" - Ipv6 proxies disabled on the server,
  • "8" - Mobile proxies disabled on the server,
  • "9" - Incorrect field [days],
  • "10" - Incorrect field [country],
  • "12" - Incorrect field [authType],
  • "13" - Incorrect field [protocol]. Field must be [HTTPS] or [SOCKS5],
  • "14" - Incorrect field [authIp],
  • "15" - Incorrect field [count],
  • "16" - Incorrect field [mobileOperator],
  • "17" - Incorrect field [rotationTime],
  • "18" - Incorrect field [IpId],
  • "19" - Incorrect field [orderId],
  • "20" - OrderId {orderId} don't have active IPs!,
  • "21" - ID {ip} not found!,
  • "22" - Request must contain [goal],
  • "23" - Unknown error,
  • "24" - Insufficient balance,
  • "25" - Error key,
  • "26" - Length of field [goal] must be 5 characters or more,
  • "27" - ISP proxies disabled on the server,
  • "28" - Mobile tariff is not available.