General requests
To get the balance information
The request allows you to see the current balance.
GET/client-api/v1/<apiKey>/get/balance
Example body answer:
{
"success":true,
"user":"client@gmail.com",
"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
Example body answer:
{
"success":true,
"user":"client@gmail.com",
"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"
}
}
]
}{
"success":true,
"user":"client@gmail.com",
"balance":13.09,
"currency":"USD",
"countOfProxy":6,
"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"
}
}
]
}
]
}{
"success":true,
"user":"client@gmail.com",
"balance":13.09,
"currency":"USD",
"countOfProxy":6,
"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"
}
}
]
}{
"success":true,
"user":"client@gmail.com",
"balance":13.09,
"currency":"USD",
"countOfProxy":6,
"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.
0is 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.
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=ipv4Example body answer:
{
"success":true,
"user":"client@gmail.com",
"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.
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=ipv4Example body answer:
{
"success":true,
"user":"client@gmail.com",
"balance":13.09,
"currency":"USD",
"countries":[
{
"name":"ENGLAND",
"alpha3code":"GBR"
},
{
"name":"USA",
"alpha3code":"USA"
},
{
"name":"FRANCE",
"alpha3code":"FRA"
}
]
}Response params:
"name" — name of the country,
"alpha3code" — alfa3 country code. Value of this field will be used for placing an order.