API Документация

Api позволит вам интегрировать покупку и продление прокси в ваш сервис, либо приложение. Взаимодействие партнера с системой, равно как и системы с партнером происходит посредством “application/json” запросов и ответов. Все общение происходит в кодировке UTF-8.

Получение баланса

Запрос позволяет увидеть текущее состояние баланса

GET
/client-api/v1/<apiKey>/get/balance
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD"
}
Параметры ответа:
  • "success" - флаг успешности операции -"true/false",
  • "balance" - текущее состояние баланса.
Получить весь список купленных прокси
GET
/client-api/v1/<apiKey>/get/proxies
Пример тела ответа:
{
"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"
}
}
]
}
Параметры ответа:
  • "ipv4" - список активных ipv4 прокси,
  • "ipv6" - список активных ipv6 прокси,
  • "mobile" - список активных mobile прокси,
  • "isp" - список активных isp прокси,
  • "id" - ID прокси. Этот параметр необходим для продления прокси,
  • "orderId" - ID заказа. IPv6, в отличии от остальных типов прокси, позволяет продлевать только весь заказ целиком,
  • "country" - альфа3 код страны,
  • "dateStart" - дата начала аренды,
  • "dateEnd" - дата окончания аренды,
  • "authInfo" - данные для авторизации,
  • "protocol" - протокол -"HTTPS/SOCKS5",
  • "rotationTime" - время обновления IP адреса в мин. 0 - это обновление по ссылке в любой момент,
  • "rebootLink" - ссылка для обновления IP,
  • "mobileOperator" - мобильный оператор.
Получить доступное количество дней для покупки/продления прокси

Доступное количество дней может отличатся в зависимости от типа прокси

GET
/client-api/v1/<apiKey>/get/days
Параметры запроса:
  • "proxyType" - тип прокси. Значение может быть четырех видов -"ipv4/ipv6/isp/mobile".
Пример запроса:
/client-api/v1/<apiKey>/get/days?proxyType=ipv4
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"days":
[
1,
7,
14,
30,
60,
90
]
}
Получить список доступных стран для покупки

Список доступных стран может отличатся в зависимости от типа прокси

GET
/client-api/v1/<apiKey>/get/countries
Параметры запроса:
  • "proxyType" - тип прокси. Значение может быть четырех видов -"ipv4/ipv6/isp/mobile".
Пример запроса:
/client-api/v1/<apiKey>/get/countries?proxyType=ipv4
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"countries":
[
{
"name":"ENGLAND",
"alpha3code":"GBR"
},
{
"name":"USA",
"alpha3code":"USA"
},
{
"name":"FRANCE",
"alpha3code":"FRA"
}
]
}
Параметры ответа:
  • "name" - имя страны,
  • "alpha3code" - альфа3 код страны. Значение этого поля будет использоваться для оформления заказа.
Получить список купленных ipv4 прокси
GET
/client-api/v1/<apiKey>/get/proxies
Параметры запроса:
  • "proxyType" - тип прокси -"ipv4".
Пример запроса:
/client-api/v1/<apiKey>/get/proxies?proxyType=ipv4
Пример тела ответа:
{
"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"
}
}
]
}
Параметры ответа:
  • "proxies" - список активных прокси,
  • "id" - ID прокси. Этот параметр необходим для продления прокси,
  • "country" - альфа3 код страны,
  • "dateStart" - дата начала аренды,
  • "dateEnd" - дата окончания аренды,
  • "authInfo" - данные для авторизации.
Вычислить цену для покупки
GET
/client-api/v1/<apiKey>/get/order/price
Параметры запроса:
  • "proxyType" - тип прокси -"ipv4",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - код страны в формате alpha3 (доступные значения можно получить другим запросом),
  • "count" - количество прокси.
Пример запроса:
/client-api/v1/<apiKey>/get/order/price?proxyType=ipv4&days=7&goal=instagram&country=FRA&count=2
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv4",
"days":7,
"count":2,
"goal":"instagram",
"amount":2.78,
"price":1.39
}
Параметры ответа:
  • "amount" - общая стоимость заказа,
  • "price" - цена за 1 прокси.
Вычислить цену для продления
GET
/client-api/v1/<apiKey>/get/extend/price
Параметры запроса:
  • "proxyType" - тип прокси -"ipv4",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - ID прокси, которые необходимо продлить (разрешается указывать несколько ID через запятую).
Пример запроса:
/client-api/v1/<apiKey>/get/extend/price?proxyType=ipv4&days=7&IpId=id1,id2,id3
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv4",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Параметры ответа:
  • "amount" - общая стоимость,
  • "price" - цена за продление одного прокси,
  • "ipId" - список ID прокси для продления.
Покупка прокси
POST
/client-api/v1/<apiKey>/order
Параметры запроса:
  • "proxyType" - тип прокси -"ipv4",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - альфа3 код страны,
  • "count" - количество прокси,
  • "authType" - тип авторизации -"login/ip",
  • "authIp" - IP адрес авторизации. Это поле является обязательным только если authType = ip.
Пример запроса:
/client-api/v1/<apiKey>/order
Пример тела запроса:
{
"proxyType":"ipv4",
"days":90,
"goal":"instagram",
"country":"GBR",
"count":2,
"authType":"login"
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"ipv4",
"orderNumber":"DV-16620211552356-jA"
}
Параметры ответа:
  • "orderNumber" - номер заказа,
  • "balance" - сумма на балансе после покупки.
Продление прокси
POST
/client-api/v1/<apiKey>/extend
Параметры запроса:
  • "proxyType" - тип прокси -"ipv4",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - список ID прокси, которые нужно продлить.
Пример запроса:
/client-api/v1/<apiKey>/extend
Пример тела запроса:
{
"proxyType":"ipv4",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Параметры ответа:
  • "balance" - сумма на балансе после продления.
Получить список купленных ipv6 прокси
GET
/client-api/v1/<apiKey>/get/proxies
Параметры запроса:
  • "proxyType" - тип прокси -"ipv6".
Пример запроса:
/client-api/v1/<apiKey>/get/proxies?proxyType=ipv6
Пример тела ответа:
{
"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"
}
}
]
}
]
}
Параметры ответа:
  • "proxies" - список активных заказов,
  • "orderId" - ID заказа. IPv6, в отличие от остальных типов прокси, позволяет продлевать только весь заказ целиком,
  • "id" - ID прокси,
  • "country" - альфа3 код страны,
  • "dateStart" - дата начала аренды,
  • "dateEnd" - дата окончания аренды,
  • "protocol" - протокол -"HTTPS/SOCKS5",
  • "authInfo" - данные для авторизации.
Вычислить цену для покупки
GET
/client-api/v1/<apiKey>/get/order/price
Параметры запроса:
  • "proxyType" - тип прокси -"ipv6",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - код страны в формате alpha3 (доступные значения можно получить другим запросом),
  • "count" - количество прокси. Значение должно быть от 10 штук.
Пример запроса:
/client-api/v1/<apiKey>/get/order/price?proxyType=ipv6&days=30&goal=instagram&country=FRA&count=10
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"ipv6",
"days":30,
"count":10,
"goal":"instagram",
"amount":7.25,
"price":0.72
}
Параметры ответа:
  • "amount" - общая стоимость заказа,
  • "price" - цена за 1 прокси.
Вычислить цену для продления
GET
/client-api/v1/<apiKey>/get/extend/price
Параметры запроса:
  • "proxyType" - тип прокси -"ipv6",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "orderId" - ID заказов, которые необходимо продлить (разрешается указывать несколько ID через запятую).
Пример запроса:
/client-api/v1/<apiKey>/get/extend/price?proxyType=ipv6&days=30&orderId=orderId1,orderId2
Пример тела ответа:
{
"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"
]
}
Параметры ответа:
  • "amount" - общая стоимость,
  • "price" - цена за продление одного прокси,
  • "ordersId" - список ID заказов для продления,
  • "ipId" - список ID прокси для продления.
Покупка прокси
POST
/client-api/v1/<apiKey>/order
Параметры запроса:
  • "proxyType" - тип прокси -"ipv6",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - альфа3 код страны,
  • "count" - количество прокси. Значение должно быть от 10 штук,
  • "authType" - тип авторизации -"login/ip",
  • "authIp" - IP адрес авторизации. Это поле является обязательным только если authType = ip,
  • "protocol" - протокол -"HTTPS/SOCKS5".
Пример запроса:
/client-api/v1/<apiKey>/order
Пример тела запроса:
{
"proxyType":"ipv6",
"days":30,
"goal":"instagram",
"country":"GBR",
"count":10,
"authType":"login",
"protocol":"SOCKS5"
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"ipv6",
"orderNumber":"DV-211552356-jA"
}
Параметры ответа:
  • "orderNumber" - номер заказа,
  • "balance" - сумма на балансе после покупки.
Продление прокси
POST
/client-api/v1/<apiKey>/extend
Параметры запроса:
  • "proxyType" - тип прокси -"ipv6",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "orderId" - список ID заказов, которые нужно продлить.
Пример запроса:
/client-api/v1/<apiKey>/extend
Пример тела запроса:
{
"proxyType":"ipv6",
"days":30,
"orderId":
[
"orderId1"
]
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Параметры ответа:
  • "balance" - сумма на балансе после продления.
Получить список купленных isp прокси
GET
/client-api/v1/<apiKey>/get/proxies
Параметры запроса:
  • "proxyType" - тип прокси -"isp".
Пример запроса:
/client-api/v1/<apiKey>/get/proxies?proxyType=isp
Пример тела ответа:
{
"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"
}
}
]
}
Параметры ответа:
  • "proxies" - список активных прокси,
  • "id" - ID прокси. Этот параметр необходим для продления прокси,
  • "country" - альфа3 код страны,
  • "dateStart" - дата начала аренды,
  • "dateEnd" - дата окончания аренды,
  • "authInfo" - данные для авторизации.
Вычислить цену для покупки
GET
/client-api/v1/<apiKey>/get/order/price
Параметры запроса:
  • "proxyType" - тип прокси -"isp",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - код страны в формате alpha3 (доступные значения можно получить другим запросом),
  • "count" - количество прокси.
Пример запроса:
/client-api/v1/<apiKey>/get/order/price?proxyType=isp&days=7&goal=instagram&country=FRA&count=2
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"isp",
"days":7,
"count":2,
"goal":"instagram",
"amount":2.78,
"price":1.39
}
Параметры ответа:
  • "amount" - общая стоимость заказа,
  • "price" - цена за 1 прокси.
Вычислить цену для продления
GET
/client-api/v1/<apiKey>/get/extend/price
Параметры запроса:
  • "proxyType" - тип прокси -"isp",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - ID прокси, которые необходимо продлить (разрешается указывать несколько ID через запятую).
Пример запроса:
/client-api/v1/<apiKey>/get/extend/price?proxyType=isp&days=7&IpId=id1,id2,id3
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"isp",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Параметры ответа:
  • "amount" - общая стоимость,
  • "price" - цена за продление одного прокси,
  • "ipId" - список ID прокси для продления.
Покупка прокси
POST
/client-api/v1/<apiKey>/order
Параметры запроса:
  • "proxyType" - тип прокси -"isp",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - альфа3 код страны,
  • "count" - количество прокси,
  • "authType" - тип авторизации -"login/ip",
  • "authIp" - IP адрес авторизации. Это поле является обязательным только если authType = ip.
Пример запроса:
/client-api/v1/<apiKey>/order
Пример тела запроса:
{
"proxyType":"isp",
"days":90,
"goal":"instagram",
"country":"GBR",
"count":2,
"authType":"login"
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"isp",
"orderNumber":"DV-16620211552356-jA"
}
Параметры ответа:
  • "orderNumber" - номер заказа,
  • "balance" - сумма на балансе после покупки.
Продление прокси
POST
/client-api/v1/<apiKey>/extend
Параметры запроса:
  • "proxyType" - тип прокси -"isp",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - список ID прокси, которые нужно продлить.
Пример запроса:
/client-api/v1/<apiKey>/extend
Пример тела запроса:
{
"proxyType":"isp",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Параметры ответа:
  • "balance" - сумма на балансе после продления.
Получить список доступных мобильных тарифов
GET
/client-api/v1/<apiKey>/get/tariffs
Пример тела ответа:
{
"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
]
}
]
}
]
}
Параметры ответа:
  • "tariffs" - список тарифов,
  • "country" - альфа3 код страны,
  • "mobileOperator" - список доступных мобильных операторов для этой страны,
  • "rotationTime" - доступные периоды обновления IP адреса в мин. 0 - это обновление по ссылке в любой момент.
Получить список купленных mobile прокси
GET
/client-api/v1/<apiKey>/get/proxies
Параметры запроса:
  • "proxyType" - тип прокси -"mobile".
Пример запроса:
/client-api/v1/<apiKey>/get/proxies?proxyType=mobile
Пример тела ответа:
{
"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"
}
}
]
}
Параметры ответа:
  • "proxies" - список активных прокси,
  • "id" - ID прокси. Этот параметр необходим для продления прокси,
  • "country" - альфа3 код страны,
  • "dateStart" - дата начала аренды,
  • "dateEnd" - дата окончания аренды,
  • "rotationTime" - время обновления IP адреса в мин. 0 - это обновление по ссылке в любой момент,
  • "rebootLink" - ссылка для обновления ip,
  • "authInfo" - данные для авторизации.
Вычислить цену для покупки
GET
/client-api/v1/<apiKey>/get/order/price
Параметры запроса:
  • "proxyType" - тип прокси -"mobile",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси (доступные значения можно получить другим запросом),
  • "customGoal" - если в доступных на сайте целей не будет того что вам нужно, вы можете написать свою цель. Длинна поля должна быть 5 или больше символов (в запросе обязательно должен быть один из параметров - goal или customGoal),
  • "country" - код страны в формате alpha3 (доступные значения можно получить другим запросом),
  • "count" - количество прокси,
  • "mobileOperator" - мобильный оператор (доступные значения можно получить другим запросом),
  • "rotationTime" - время обновления IP адреса (доступные значения можно получить другим запросом).
Пример запроса:
/client-api/v1/<apiKey>/get/order/price?proxyType=mobile&days=7&goal=instagram&country=FRA&count=1&mobileOperator=freemobilesas_france&rotationTime=5
Пример тела ответа:
{
"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
}
Параметры ответа:
  • "amount" - общая стоимость заказа,
  • "price" - цена за 1 прокси.
Вычислить цену для продления
GET
/client-api/v1/<apiKey>/get/extend/price
Параметры запроса:
  • "proxyType" - тип прокси -"mobile",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - ID прокси, которые необходимо продлить (разрешается указывать несколько ID через запятую).
Пример запроса:
/client-api/v1/<apiKey>/get/extend/price?proxyType=mobile&days=7&IpId=id1,id2,id3
Пример тела ответа:
{
"success":true,
"balance":13.09,
"currency":"USD",
"proxyType":"mobile",
"days":7,
"count":3,
"amount":9.13,
"price":3.04,
"ipId":
[
"id1",
"id2",
"id3"
]
}
Параметры ответа:
  • "amount" - общая стоимость,
  • "price" - цена за продление одного прокси,
  • "ipId" - список ID прокси для продления.
Покупка прокси
POST
/client-api/v1/<apiKey>/order
Параметры запроса:
  • "proxyType" - тип прокси -"mobile",
  • "days" - количество дней для аренды (доступные значения можно получить другим запросом),
  • "goal" - цель использования прокси,
  • "country" - альфа3 код страны,
  • "count" - количество прокси,
  • "authType" - тип авторизации -"login/ip",
  • "authIp" - IP адрес авторизации. Это поле является обязательным только если authType = ip,
  • "mobileOperator" - мобильный оператор (доступные значения можно получить другим запросом),
  • "rotationTime" - время обновления IP адреса (доступные значения можно получить другим запросом).
Пример запроса:
/client-api/v1/<apiKey>/order
Пример тела запроса:
{
"proxyType":"mobile",
"days":30,
"goal":"instagram",
"country":"FRA",
"count":1,
"authType":"login",
"mobileOperator":"freemobilesas_france",
"rotationTime":5
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD",
"proxyType":"mobile",
"orderNumber":"DV-21x1552356-jA"
}
Параметры ответа:
  • "orderNumber" - номер заказа,
  • "balance" - сумма на балансе после покупки.
Продление прокси
POST
/client-api/v1/<apiKey>/extend
Параметры запроса:
  • "proxyType" - тип прокси -"mobile",
  • "days" - количество дней для продления (доступные значения те же, что и для покупки),
  • "IpId" - список ID прокси, которые нужно продлить.
Пример запроса:
/client-api/v1/<apiKey>/extend
Пример тела запроса:
{
"proxyType":"mobile",
"days":30,
"IpId":
[
"id1",
"id2"
]
}
Пример тела ответа:
{
"success":true,
"balance":4.09,
"currency":"USD"
}
Параметры ответа:
  • "balance" - сумма на балансе после продления.

В случае не удачного выполнения запроса, в ответ придет сообщение о ошибке

Пример ошибки:
{
"success":false,
"error_id":5,
"error":"Incorrect proxy type"
}
  • "error_id" - ID ошибки,
  • "error" - сообщение ошибки.
ID ошибок:
  • "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.