APIs – ProxySP

How to Use Proxy-IPV4 API

proxysp — Fri, 16 Jun 2023 09:14:05 +0000

Proxy-IPV4 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. The system implements protection against DOS attacks; no more than one request per second is allowed. If more than one request per second is sent, the response will be error_id=2, in which case we recommend sending the request again.

General requests

To get the balance information

The request allows to see the current balance

GET

/client-api/v1//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

GET

/client-api/v1//get/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"
}
}
],
"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"
}
}
]
}
],
"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,
“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//get/days

Reqwest parameters:

“proxyType” – type of proxy. Value can be of three types –“ipv4/ipv6/mobile”.

Example reqwest:

/client-api/v1//get/days?proxyType=ipv4

Example 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

GET

/client-api/v1//get/countries

Reqwest parameters:

“proxyType” – type of proxy. Value can be of three types –“ipv4/ipv6/mobile”.

Example reqwest:

/client-api/v1//get/countries?proxyType=ipv4

Example 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 country,
“alpha3code” – alfa3 country code. Value of this field will be used for placing an order.

To get the list of the available goals for purchase

GET

/client-api/v1//get/goals

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"balance":13.09,
"currency":"USD",
"goals":
[
"instagram",
"facebook",
"vk",
"bookmakers",
"avito",
"amazon",
"cs go",
"tiktok"
]
}

Response params:

“goals” – The list of available goals. This parameter is necessary for placing an order. If the list does not contain what you need, you can use the field ‘customGoal' when placing an order.

IPv4 requests

To get the ipv4 list of the bought proxies

GET
/client-api/v1//get/proxies

Reqwest parameters:

“proxyType” – type of proxy –“ipv4”.

Example reqwest:

/client-api/v1//get/proxies?proxyType=ipv4

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//get/order/price

Reqwest 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 (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.

Example reqwest:

/client-api/v1//get/order/price?proxyType=ipv4&days=7&goal=instagram&country=FRA&count=2

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//get/extend/price

Reqwest 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 reqwest:

/client-api/v1//get/extend/price?proxyType=ipv4&days=7&IpId=id1,id2,id3

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//order

Reqwest 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 (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,
“count” – the number of proxies,
“authType” – authorization type –“login/ip”,
“authIp” – authorization IP address. This field is required only if authType = ip.

Example reqwest:

/client-api/v1//order

Example body reqwest:

{
"proxyType":"ipv4",
"days":90,
"goal":"instagram",
"country":"GBR",
"count":2,
"authType":"login"
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//extend

Reqwest 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 reqwest:

/client-api/v1//extend

Example body reqwest:

{
"proxyType":"ipv4",
"days":30,
"IpId":
[
"id1",
"id2"
]
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"balance":4.09,
"currency":"USD"
}

Response params:

“balance” – the balance after extending.

IPv6 requests

To get the ipv4 list of the bought proxies

GET

/client-api/v1//get/proxies

Reqwest parameters:

“proxyType” – type of proxy –“ipv6”.

Example reqwest:

/client-api/v1//get/proxies?proxyType=ipv6

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//get/order/price

Reqwest 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 (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 proxy. The value must be more then 10.

Example reqwest:

/client-api/v1//get/order/price?proxyType=ipv6&days=30&goal=instagram&country=FRA&count=10

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//get/extend/price

Reqwest 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 reqwest:

/client-api/v1//get/extend/price?proxyType=ipv6&days=30&orderId=orderId1,orderId2

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//order

Reqwest 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 (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,
“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 reqwest:

/client-api/v1//order

Example body reqwest:

{
"proxyType":"ipv6",
"days":30,
"goal":"instagram",
"country":"GBR",
"count":10,
"authType":"login",
"protocol":"SOCKS5"
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//extend

Reqwest 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 reqwest:

/client-api/v1//extend

Example body reqwest:

{
"proxyType":"ipv6",
"days":30,
"orderId":
[
"orderId1"
]
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"balance":4.09,
"currency":"USD"
}

Response params:

“balance” – the balance after extending.

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//get/order/price

Reqwest 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 reqwest:

/client-api/v1//get/order/price?proxyType=mobile&days=7&goal=instagram&country=FRA&count=1&mobileOperator=freemobilesas_france&rotationTime=5

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//get/extend/price

Reqwest 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 reqwest:

/client-api/v1//get/extend/price?proxyType=mobile&days=7&IpId=id1,id2,id3

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//order

Reqwest 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,
“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 reqwest:

/client-api/v1//order

Example body reqwest:

{
"proxyType":"mobile",
"days":30,
"goal":"instagram",
"country":"FRA",
"count":1,
"authType":"login",
"mobileOperator":"freemobilesas_france",
"rotationTime":5
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"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//extend

Reqwest 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 reqwest:

/client-api/v1//extend

Example body reqwest:

{
"proxyType":"mobile",
"days":30,
"IpId":
[
"id1",
"id2"
]
}

Example body answer:

{
"success":true,
"user":"client@gmail.com",
"balance":4.09,
"currency":"USD"
}

Response params:

“balance” – the balance after extending.

“error_id” – error ID,
“error” – error message.

ID errors:

“1” – API disabled on the server,
“2” – You are sending requests too often. No more than one per second is allowed,
“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],
“11” – Incorrect field [goal],
“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] or [customGoal],
“23” – Unknown error,
“24” – Insufficient balance,
“25” – Error key,
“26” – Length of field [customGoal] must be 5 characters or more.

Click here to get Proxy-IPV4 API

How to Use ProxyScrape Premium API

proxysp — Thu, 01 Jan 1970 00:00:00 +0000

This article will explain how to use ProxyScrape Premium API services programmatically. Let's begin now!

Get proxy list

https://api.proxyscrape.com/v2/account/datacenter_shared/proxy-list?auth=nhuyjukilompnbvfrtyuui&type=getproxies&country[]=all&protocol=http&format=normal

auth	nhuyjukilompnbvfrtyuui Provide your API auth key
type	getproxies Download the proxies, or display them in your browser: getproxies displayproxies
country[]	all Provide any Alpha 2 ISO country code of countries that are available in your account. Incase you want to download multiple countries at once, please repeat the parameter: &country[]=us&country[]=deWhen this parameter is not provided it will default to all countries.
protocol	http Define which proxy protocol you want to download: http socks The HTTP proxies support SSL (https). The Socks proxies are both Socks4 and Socks5.
format	normal The format you want to receive the proxies in: normal: a simple proxy list json: returns all proxies, along with their associated countries and status.

Example Request

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/account/datacenter_shared/proxy-list?auth=nhuyjukilompnbvfrtyuui&type=getproxies&country[]=all&protocol=http&format=normal'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

Get authenticated IPs

https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=get

Display the IPs that are already authenticated on your account.

PARAMS

auth	nhuyjukilompnbvfrtyuui Provide your API auth key
type	get Get authenticated IPs on your account

Example Request

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=get'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

GET Authenticate one IP

https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=set&ip[]=1.1.1.1

Please note that every new authenticate request has to contain all IPs that need to remain authenticated. To unauthenticate IPs, you can resend the authenticate request, excluding the IPs that have to be unauthenticated.

PARAMS

Example Request

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=set&ip[]=1.1.1.1'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

GET Authenticate multiple IPs

https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=set&ip[]=1.1.1.1&ip[]=1.1.1.2&ip[]=1.1.1.3

To authenticate multiple IPs just simply repeat the ip[] parameter.

PARAMS

auth	nhuyjukilompnbvfrtyuui Provide your API auth key
type	set Set IP request
ip[]	1.1.1.1 Provide one of the IPs that have to be authenticated
ip[]	1.1.1.2 Provide one of the IPs that have to be authenticated
ip[]	1.1.1.3 Provide one of the IPs that have to be authenticated

Example Request

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/account/datacenter_shared/whitelist?auth=nhuyjukilompnbvfrtyuui&type=set&ip[]=1.1.1.1&ip[]=1.1.1.2&ip[]=1.1.1.3'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

References,

https://docs.proxyscrape.com/#b91b6c21-172c-48b3-ab99-6f297d5d9a7b

Disclaimer: This part of the content is mainly from the merchant. If the merchant does not want it to be displayed on my website, please contact us to delete your content.

How to Use Free ProxyScrape API

proxysp — Thu, 01 Jan 1970 00:00:00 +0000

Do you know how to use free ProxyScrape API? This article will give you the detailed guide.

This API is for our free proxy list and the results returned by it can be used anywhere free of charge.

Get proxy list

https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all

Sample codes,

C#

var client = new RestClient("https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);

CURL

curl --location --request GET 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all'

Dart – Http

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all')); http.StreamedResponse response = await request.send(); if (response.statusCode == 200) { print(await response.stream.bytesToString()); } else { print(response.reasonPhrase); }

Go – Native

package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all" method := "GET" client := &http.Client { } req, err := http.NewRequest(method, url, nil) if err != nil { fmt.Println(err) return } res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) }

HTTP

GET /v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all HTTP/1.1 Host: api.proxyscrape.com

java okhttp

OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all") .method("GET", null) .build(); Response response = client.newCall(request).execute();

JavaScript – Fetch

var requestOptions = { method: 'GET', redirect: 'follow' }; fetch("https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error));

JavaScript – jQuery

var settings = { "url": "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); });

JavaScript – XHR

 var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function() { if(this.readyState === 4) { console.log(this.responseText); } }); xhr.open("GET", "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all"); xhr.send();

C – libcurl

CURL *curl; CURLcode res; curl = curl_easy_init(); if(curl) { curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET"); curl_easy_setopt(curl, CURLOPT_URL, "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all"); curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https"); struct curl_slist *headers = NULL; curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers); res = curl_easy_perform(curl); } curl_easy_cleanup(curl);

NodeJs – Axios

var axios = require('axios'); var config = { method: 'get', url: 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all', headers: { } }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); });

NodeJs – Native

var https = require('follow-redirects').https; var fs = require('fs'); var options = { 'method': 'GET', 'hostname': 'api.proxyscrape.com', 'path': '/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all', 'headers': { }, 'maxRedirects': 20 }; var req = https.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function (chunk) { var body = Buffer.concat(chunks); console.log(body.toString()); }); res.on("error", function (error) { console.error(error); }); }); req.end();

DNodeJs – Request

var request = require('request'); var options = { 'method': 'GET', 'url': 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all', 'headers': { } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); });

PHP – cURL

 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response;

Python – http.client

import http.client conn = http.client.HTTPSConnection("api.proxyscrape.com") payload = '' headers = {} conn.request("GET", "/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))

Python – Requests

import requests url = "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all" payload={} headers = {} response = requests.request("GET", url, headers=headers, data=payload) print(response.text)

Ruby – Net::HTTP

require "uri" require "net/http" url = URI("https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all") https = Net::HTTP.new(url.host, url.port) https.use_ssl = true request = Net::HTTP::Get.new(url) response = https.request(request) puts response.read_body

Shell – Httpie

http --follow --timeout 3600 GET 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all'

Shell – get

wget --no-check-certificate --quiet \ --method GET \ --timeout=0 \ --header '' \ 'https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all'

Swift – URLSession

import Foundation #if canImport(FoundationNetworking) import FoundationNetworking #endif var semaphore = DispatchSemaphore (value: 0) var request = URLRequest(url: URL(string: "https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all")!,timeoutInterval: Double.infinity) request.httpMethod = "GET" let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) semaphore.signal() return } print(String(data: data, encoding: .utf8)!) semaphore.signal() } task.resume() semaphore.wait()

PARAMS

request	displayproxies Define whether the proxies should download or display in the browser. Possible values: displayproxies: display the proxies in the browser getproxies: download the proxies
protocol	http Protocol of the proxies that should be downloaded. Possible values: http socks4 socks5 all If you want to download two protocols at once, the values can be separated by a comma, E.G., protocol=socks4,socks5 When this parameter is not defined, it will default to all.
timeout	10000 The maximum timeout of the proxies that should be downloaded in miliseconds.
country	all The country parameter can be any Alpha 2 ISO country code or ‘all'. When no country is defined the country will be automatically set to ‘all'. You can also use multiple countries in 1 request by separating them by a comma.
ssl	all Should the proxies support SSL (HTTPS)? This parameter is only for if you download HTTP proxies.
anonymity	all Define which anonymity level the proxies should have: elite anonymous transparent all When no anonymity level is defined, it will default to ‘all'. You can also use multiple anonymity levels in 1 request by separating them by a comma. This parameter only applies to HTTP(s) proxies.

Example Request:

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/?request=displayproxies&protocol=http&timeout=10000&country=all&ssl=all&anonymity=all'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

Get proxy list details

https://api.proxyscrape.com/v2/?request=proxyinfo

This API endpoint will return information of the available proxies such as:

Amount of available proxies
Time since last proxy list update
Available countries
Organizations the proxies are related to
Ports of the proxies

This API end-point also supports all parameters described in “Get proxy list.”

PARAMS

request	proxyinfo
simplified	true Use this parameter if you only want to receive the amount of available proxies.

Example Request

var request = http.Request('GET', Uri.parse('https://api.proxyscrape.com/v2/?request=proxyinfo'));


http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
}
else {
  print(response.reasonPhrase);
}

References,

https://docs.proxyscrape.com/#74a576d0-6201-494b-af94-e8aaf44b9c46

Disclaimer: This part of the content is mainly from the merchant. If the merchant does not want it to be displayed on my website, please contact us to delete your content.

How to Use Bright Data API? Learn Manuals Before You Buy

proxysp — Thu, 01 Jan 1970 00:00:00 +0000

Want to scraping data by Bright Data API? We make a some examples of code for popular programming languages, with it you can easily to know how ot use Bright Data proxy API.

Luminati proxy API

For Browser or Software,

Use the following settings in your Bot, Crawler or other software,

Proxy: zproxy.lum-superproxy.io
Port: 22225
User: lum-customer-Your_username- Your_zonesetting
Password: 0Yourpasswords0

Shell

curl --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-Your_username- Your_zonesetting:0Yourpasswords0 "http://lumtest.com/myip.json"

Node.js

#!/usr/bin/env node
require('request-promise')({
url: 'http://lumtest.com/myip.json',
proxy: 'http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0@zproxy.lum-superproxy.io:22225',
})
.then(function(data){ console.log(data); },
function(err){ console.error(err); });

Java

package example;

import org.apache.http.HttpHost;
import org.apache.http.client.fluent.*;

public class Example {
public static void main(String[] args) throws Exception {
System.out.println("To enable your free eval account and get "
+"CUSTOMER, YOURZONE and YOURPASS, please contact "
+"sales@brightdata.com");
HttpHost proxy = new HttpHost("zproxy.lum-superproxy.io", 22225);
String res = Executor.newInstance()
.auth(proxy, "lum-customer-Your_username- Your_zonesetting", "0Yourpasswords0")
.execute(Request.Get("http://lumtest.com/myip.json").viaProxy(proxy))
.returnContent().asString();
System.out.println(res);
}
}

C#

using System;
using System.Net;

class Example
{
static void Main()
{
Console.WriteLine("To enable your free eval account and get CUSTOMER, "
+"YOURZONE and YOURPASS, please contact sales@brightdata.com");
var client = new WebClient();
client.Proxy = new WebProxy("zproxy.lum-superproxy.io:22225");
client.Proxy.Credentials = new NetworkCredential("lum-customer-Your_username- Your_zonesetting", "0Yourpasswords0");
Console.WriteLine(client.DownloadString("http://lumtest.com/myip.json"));
}
}

VB

Imports System.Net

Module Module1
Sub Main()
Console.WriteLine("To enable your free eval account and get " & 
"CUSTOMER, YOURZONE and YOURPASS, please contact " &
"sales@brightdata.com")
Dim Client As New WebClient
Client.Proxy = New WebProxy("http://zproxy.lum-superproxy.io:22225")
Client.Proxy.Credentials = New NetworkCredential("lum-customer-Your_username- Your_zonesetting", "0Yourpasswords0")
Console.WriteLine(Client.DownloadString("http://lumtest.com/myip.json"))
End Sub
End Module

PHP

Python

#!/usr/bin/env python
print('If you get error "ImportError: No module named \'six\'" install six:\n'+\
'$ sudo pip install six');
print('To enable your free eval account and get CUSTOMER, YOURZONE and ' + \
'YOURPASS, please contact sales@brightdata.com')
import sys
if sys.version_info[0]==2:
import six
from six.moves.urllib import request
opener = request.build_opener(
request.ProxyHandler(
{'http': 'http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0@zproxy.lum-superproxy.io:22225',
'https': 'http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0@zproxy.lum-superproxy.io:22225'}))
print(opener.open('http://lumtest.com/myip.json').read())
if sys.version_info[0]==3:
import urllib.request
opener = urllib.request.build_opener(
urllib.request.ProxyHandler(
{'http': 'http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0@zproxy.lum-superproxy.io:22225',
'https': 'http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0@zproxy.lum-superproxy.io:22225'}))
print(opener.open('http://lumtest.com/myip.json').read())

Ruby

#!/usr/bin/ruby

require 'uri'
require 'net/http'
require 'net/https'

puts 'To enable your free eval account and get CUSTOMER, YOURZONE and YOURPASS, please contact sales@brightdata.com'

uri = URI.parse('http://lumtest.com/myip.json')
proxy = Net::HTTP::Proxy('zproxy.lum-superproxy.io', 22225, 'lum-customer-Your_username- Your_zonesetting', '0Yourpasswords0')

req = Net::HTTP::Get.new(uri.path)

result = proxy.start(uri.host,uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(req)
end

puts result.body

Perl

#!/usr/bin/perl
print 'To enable your free eval account and get CUSTOMER, YOURZONE and '
.'YOURPASS, please contact sales@brightdata.com';
use LWP::UserAgent;
my $agent = LWP::UserAgent->new();
$agent->proxy(['http', 'https'], "http://lum-customer-Your_username- Your_zonesetting:0Yourpasswords0\@zproxy.lum-superproxy.io:22225");
print $agent->get('http://lumtest.com/myip.json')->content();

Search Engine Crawler API

Google Search Crawler API

Search

Localization

gl Two-letter country code used to define the country of search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&gl=us"

hl Two-letter language code used to define the page language

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&hl=us"

Type of search

tbm Define search type. For regular search there is no need to use the tbm parameter while other types have

a unique tbm value.

Example:
tbm=isch – images
tbm=shop – shopping
[%nws] – news

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&tbm=shop"

ibp Use the ibp parameter for Jobs search type.

Example:
ibp=htl;jobs – Jobs

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&ibp=htl%3Bjobs"

Pagination

start Define the result offset – results to start from the selected value. Used for managing pagination.

Examples:
start=0 (default) – first page of results
start=10 – second page of results
start=20 – third page of results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&start=10"

num Defines the number of results to return.

Examples:
num=10 (default) returns 10 results
num=30 returns 30 results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&num=100"

Geographic Location

uule Stands for the encoded location you want to use for your search and will be used to change geo-location. A CSV with all available uule values can be downloaded here

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&uule=w+CAIQICINVW5pdGVkK1N0YXRlcw"

Device and output format

lum_mobile Define what device type to be represented in user-agent

Default or lum_mobile=0 will provide random desktop user-agent while lum_mobile=1 will provide random mobile user-agent

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PA

lum_json Bright Data parameter allowing to return parsed JSON instead of raw HTML

Examples:
lum_json=1 – return results in JSON
lum_json=html – return JSON with “html” field containing raw HTML
lum_json=hotel – make additional request to retrieve hotel prices
lum_json=hotel,html – two values can be combined while separated by comma

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/search?q=pizza&lum_json=1"

Search by image

download Download image on the proxy side and post it to google using POST request

Examples:
default – download-and-post if google isn't able to download the image
download=1 – force download-and-post image
download=0 – regular GET request with image URL

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/searchbyimage?image_url=https%3A%2F%2Flive.staticflickr.com%2F213%2F491726079_4f46636859_w.jpg&download=1"

Multiple requests

multi Make parallel requests through our API server using POST request.

Parallel requests will be using the same peer and session and can be used for comparison tests, I.e. making an identical pair of requests with 2 different values for a selected parameter
multi=[{“keyword”:”pizza”,”num”:20},{“keyword”:”pizza”,”num”:100}] – the same keyword with different num param
multi=[{“keyword”:”pizza”},{“keyword”:”burger”}] – different keywords

curl -v --compressed "https://brightdata.com/api/serp/req" -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d "{\"country\":\"us\",\"multi\":[{\"keyword\":\"pizza\",\"num\":20},{\"keyword\":\"pizza\",\"num\":100}]}"

Asynchronous requests

Send requests without waiting for the response. Collect results via a designated endpoint or a webhook.

To initiate a request, perform:

RESPONSE_ID=`curl -i --silent --compressed "https://brightdata.com/api/serp/req?customer=username&zone=ZONE" -H "Content-Type: application/json" -H "Authorization: Bearer " -d "{\"query\":{\"q\":\"pizza\"},\"country\":\"us\"}" | sed -En 's/^x-response-id: (.*)/\1/p' | tr -d '\r'`

`x-response-id` header will contain the id of the request so you can use it in the next request to fetch the result

curl -v --compressed "https://brightdata.com/api/serp/get_result?customer=username&zone=ZONE&response_id=${RESPONSE_ID}" -H "Authorization: Bearer "

You can adjust your zone async settings on zones page.
Optional settings:
Result lifetime (days) – number of days to keep results
Web Hook URL – address to deliver results
Web Hook Request Method – HTTP method to use to deliver response, GET or POST are optional

Parsing schema

The parsing scheme can be obtained by the following endpoint: GET /api/serp/google/parsing_schema

To get schema, perform:

curl --compressed "https://brightdata.com/api/serp/google/parsing_schema" -H "Authorization: Bearer API_TOKEN"

Maps

Localization

gl Two-letter country code used to define the country of search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/maps/search/restaurants+new+york/?gl=us"

hl Two-letter language code used to define the page language

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/maps/search/restaurants+new+york/?hl=en"

Pagination

start Define the result offset – results to start from the selected value. Used for managing pagination.

Examples:
start=0 (default) – first page of results
start=20 – second page of results
start=40 – third page of results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/maps/search/restaurants+new+york/?start=20"

num Defines the number of results to return.

Examples:
num=40 (default) returns 40 results
num=50 returns 50 results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/maps/search/restaurants+new+york/?num=40"

Output format

lum_json Bright Data parameter allowing to return parsed JSON instead of raw HTML

Examples:
lum_json=1 – return results in JSON

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/maps/search/restaurants+new+york/?lum_json=1"

Trends

Geo

geo Location of interest, two-letter country code

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://trends.google.com/trends/explore?q=pizza&geo=us"

Localization

hl Preferred language, two-letter language code

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://trends.google.com/trends/explore?q=pizza&hl=de"

Time range

date Time range to search. Available values are:

default: Past 12 month
now 1-H – Past hour
now 4-H – Past 4 hours
now 1-d – Past day
now 7-d – Past 7 days
today 1-m – Past 30 days
today 3-m – Past 90 days
today 12-m – Past 12 months
today 5-y – Past 5 years
2020-07-01 2020-12-31 – custom date range

curl -v --compressed --proxy zproxy.lum-

Reviews

Feature id

fid Feature id what you want to fetch reviews to.
fid parameter can be found in knowledge.fid field of google search response.
For example: http://www.google.com/search?q=hilton%20new%20york%20midtown

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/reviews?fid=0x808fba02425dad8f%3A0x6c296c66619367e0"

hl Preferred language, two-letter language code

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/reviews?hl=de&fid=0x808fba02425dad8f%3A0x6c296c66619367e0"

Sorting and filtering

sort The way reviews are sorted. Possible values are:

sort=qualityScore (default) – most relevant first
sort=newestFirst – newest first
sort=ratingHigh – highest rating first
sort=ratingLow – lowest rating first

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/reviews?fid=0x808fba02425dad8f%3A0x6c296c66619367e0&sort=newestFirst"

filter Filter keyword. Will respond with reviews that contain specified keyword only. Example:

filter=awesome – search for reviews containing ‘awesome' word

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/reviews?filter=awesome&fid=0x808fba02425dad8f%3A0x6c296c66619367e0"

Pagination

start Define the result offset – results to start from the selected value. Used for managing pagination.

Examples:
start=0 (default) – first page of results
start=10 – second page of results
start=20 – third page of results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.google.com/reviews?start=10&fid=0x808fba02425dad8f%3A0x6c296c66619367e0"

Asynchronous requests

Send requests without waiting for the response. Collect results via a designated endpoint or a webhook.

To initiate a request, perform:

RESPONSE_ID=`curl -i --silent --compressed "https://brightdata.com/api/serp/reviews?customer=username&zone=ZONE" -H "Content-Type: application/json" -H "Authorization: Bearer " -d "{\"query\":{\"fid\":\"0x808fba02425dad8f:0x6c296c66619367e0\"},\"country\":\"us\"}" | sed -En 's/^x-response-id: (.*)/\1/p' | tr -d '\r'`

`x-response-id` header will contain the id of the request so you can use it in the next request to fetch the result

curl -v --compressed "https://brightdata.com/api/serp/get_result?customer=username&zone=ZONE&response_id=${RESPONSE_ID}" -H "Authorization: Bearer "

Bing Search Crawler API

Localization

cc Two-letter country code used to define the country of search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&cc=us"

location A location for the search origin.

lat and lon parameters must be specified as well

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&location=New+York%2C+New+York%2C+United+States&lat=40.7001958&lon=-74.1087142"

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&lat=40.7001958&lon=-74.1087142"

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&lat=40.7001958&lon=-74.1087142"

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&mkt=en-US"

Pagination

first Define the result offset – results to start from the selected value. Used for managing pagination.

Examples:
first=1 (default) – first page of results
first=11 – second page of results
first=21 – third page of results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&first=11"

Examples:
count=10 (default) returns 10 results
count=30 returns 30 results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&num=20"

lum_mobile Define what device type to be represented in user-agent

Default or lum_mobile=0 will provide random desktop user-agent while lum_mobile=1 will provide random mobile user-agent

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&lum_mobile=1"

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "http://www.bing.com/search?q=pizza&lum_json=1"

Asynchronous requests

Send requests without waiting for the response. Collect results via a designated endpoint or a webhook.

To initiate a request, perform:

RESPONSE_ID=`curl -i --silent --compressed "https://brightdata.com/api/serp/bing/search?customer=username&zone=ZONE" -H "Content-Type: application/json" -H "Authorization: Bearer " -d "{\"query\":{\"q\":\"pizza\"},\"country\":\"us\"}" | sed -En 's/^x-response-id: (.*)/\1/p' | tr -d '\r'`

curl -v --compressed "https://brightdata.com/api/serp/get_result?customer=username&zone=ZONE&response_id=${RESPONSE_ID}" -H "Authorization: Bearer "

Optional settings:
Result lifetime (days) – number of days to keep results
Web Hook URL – address to deliver results
Web Hook Request Method – HTTP method to use to deliver response, GET or POST are optional

Parsing schema

The parsing scheme can be obtained by the following endpoint: GET /api/serp/bing/parsing_schema

To get schema, perform:

curl --compressed "https://brightdata.com/api/serp/bing/parsing_schema" -H "Authorization: Bearer API_TOKEN"

Yandex Search Crawler API

Localization

lr Region or country to search. Examples:

1 – Moscow
2 – Saint-Petersburg
84 – USA
95 – Canada
134 – China

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&lr=84"

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&lang=en"

Pagination

p Define the result page – results to start from the selected value. Used for managing pagination.

Examples:
p=1 (default) – first page of results
p=2 – second page of results
p=4 – fourth page of results, etc.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&p=1"

Takes the values 10, 20, 30, and 10. When using numbers other than these values which less than 50, rounding up to the nearest of them occurs. When using numbers over 50, rounding up to 50 occurs.

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&numdoc=10"

Time range

within Time range to search. Available values are:

1 – Past 2 weeks
2 – Past month
3 – Past 3 months
4 – Past 6 months
5 – Past year
6 – Past 2 years
7 – Past day
77 – Past 24 hours
8 – Past 3 days
9 – Past week

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&within=1"

Examples:
from_date_full=12.12.2020 – date to start from

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&from_date_full=12.12.2020"

Examples:
to_date_full=01.01.2021 – date to end search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?text=pizza&to_date_full=01.01.2021"

Device and output format

lum_mobile Define what device type to be represented in user-agent

Default or lum_mobile=0 will provide random desktop user-agent while lum_mobile=1 will provide random mobile user-agent

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://www.yandex.com/search/?lum_mobile=1&text=pizza"

Asynchronous requests

Send requests without waiting for the response. Collect results via a designated endpoint or a webhook.

To initiate a request, perform:

RESPONSE_ID=`curl -i --silent --compressed "https://brightdata.com/api/serp/yandex/search?customer=username&zone=ZONE" -H "Content-Type: application/json" -H "Authorization: Bearer " -d "{\"query\":{\"text\":\"pizza\"},\"country\":\"us\"}" | sed -En 's/^x-response-id: (.*)/\1/p' | tr -d '\r'`

`x-response-id` header will contain the id of the request so you can use it in the next request to fetch the result

curl -v --compressed "https://brightdata.com/api/serp/get_result?customer=username&zone=ZONE&response_id=${RESPONSE_ID}" -H "Authorization: Bearer "

DuckDuckGo Search Crawler API

Localization

kl Country and language code used to define the country and language of search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://duckduckgo.com/?q=pizza&kl=us-en"

kp Removes adult content from search results.

Available values are:
1 – Turn on safe search

3 – Moderate search content
3 – Turn off safe search

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://duckduckgo.com/?q=pizza&kp=1"

df Time range to search. Available values are:

d – Past 2 weeks
w – Past month
m – Past 3 months
w – Past 6 months

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://duckduckgo.com/?q=pizza&df=d"

Device and output format

lum_mobile Define what device type to be represented in user-agent

Default or lum_mobile=0 will provide random desktop user-agent while lum_mobile=1 will provide random mobile user-agent

curl -v --compressed --proxy zproxy.lum-superproxy.io:22225 --proxy-user lum-customer-username-zone-ZONE:PASSWORD "https://duckduckgo.com/?q=pizza&lum_mobile=1"

Asynchronous requests

Send requests without waiting for the response. Collect results via a designated endpoint or a webhook.

To initiate a request, perform:

RESPONSE_ID=`curl -i --silent --compressed "https://brightdata.com/api/serp/duckduckgo/search?customer=username&zone=ZONE" -H "Content-Type: application/json" -H "Authorization: Bearer " -d "{\"query\":{\"q\":\"pizza\"},\"country\":\"us\"}" | sed -En 's/^x-response-id: (.*)/\1/p' | tr -d '\r'`

`x-response-id` header will contain the id of the request so you can use it in the next request to fetch the result

curl -v --compressed "https://brightdata.com/api/serp/get_result?customer=username&zone=ZONE&response_id=${RESPONSE_ID}" -H "Authorization: Bearer "

Resource,

Disclaimer: This part of the content is mainly from the merchant. If the merchant does not want it to be displayed on my website, please contact us to delete your content.

How to Use Zenscrape API

proxysp — Thu, 01 Jan 1970 00:00:00 +0000

Want to use Zenscrape API for web scraping? So you have to know how to use Zenscrape API. This article will give you a detailed guide. Let's go!

Documentation

Pro Tip: Register your free apikey here and all code snippets below will contain your private apikey. If you have already registered, login before viewing the documentation.

Postman Collection

To provide you with the best developer experience possible, we also created a Postman collection covering all of our endpoints, including plenty of examples. Run in Postman.

Credit Costs & Failed Requests

The number of credits that is counted towards your quota depends on the type request configuration that and the status code that the API endpoint returns. Hence, a request can cost between 1 and 25 credits. You can configure your request with our request builder inside your dashboard. It generates code snippets for the most common programming languages. You can find the list of our error codes here.

`premium`	`render`	Cost in credits
false	false	1
false	true	5
true	false	10
true	true	25

Basic Usage

This endpoint allows you to fetch the content of a website. For basic usage, only one parameter is required in addition to your apikey.

GET POST /get

Zenscrape adding the url parameter to your request will fetch the HTML content from the target website. This request configuration will use standard proxies and will count as 1 credit towards your monthly limit.

curl "https://app.zenscrape.com/api/v1/get?url=http://httpbin.org/ip" \
    -H "apikey: YOUR-APIKEY"

will generate the following response:

<html>
    <head>
    head>
    <body>
        <pre style="word-wrap: break-word; white-space: pre-wrap;">
            {
                "origin": "80.102.66.13"
            }
        pre>
    body>
html>

Web Scraping API

GET POST /get

See Demo Response:

 
    
      
        
          { 
            "origin": "223.233.44.142" 
          }

This endpoint accepts the following parameters:

Parameter	Type	Description
url	required	target site you want to scrape
premium	optional, boolean, counts as 20 credits towards your quota	Uses residential proxies, unlocks sites that are hard to scrape
location	optional, default: worldwide	if `premium=false` possible locations are ‘na' (North America) and ‘eu' (Europe) if `premium=true` you can choose a location from our list of 230+ countries
keep_headers	optional, boolean	Allows to pass through forward headers (e.g. user agents, cookies)
device_type	optional, boolean	By default, a desktop user agent is set. When set to ‘mobile', it will be set to an iPhone or Android user agent
render	optional, boolean, counts as 5 credits towards your quota	Use a headless browser to fetch content that relies on javascript
wait_for	optional, integer	Max value: 15, only works together with `render=true` amount of seconds that a browser waits for content to render before it scrapes the HTML markup
wait_for_css	optional, integer	Only works together with `render=true`, waits until the css-selector becomes visible
session	optional, string	a random string if you want to reuse an IP, for example `session=kdQ1VeQE`
scroll_to_bottom	optional, boolean	Only works together with `render=true`, scrolls to bottom of page before returning the page content

Zenscrape is a REST-API and accepts HTTP requests through any programming language. The following example connects to the url https://httpbin.org/ip through a proxy and renders the content inside a browser, before it returns the markup to you.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fip&premium=true&country=de&render=true

curl "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fip&premium=true&country=de&render=true"

import requests headers = { "apikey": "YOUR-APIKEY"} params = ( ("url","https://httpbin.org/ip"), ("premium","true"), ("country","de"), ("render","true"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request'); var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://httpbin.org/ip&premium=true&country=de&render=true' }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://httpbin.org/ip", "premium" => "true", "country" => "de", "render" => "true", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY", )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

Proxy Mode

GET POST

See Demo Response:

will generate the following response:

 
    
      
        
          { 
            "origin": "223.233.44.142" 
          }

In addition to the REST API Zenscrape also provides an HTTP proxy interface. You can integrate any application that already relies on proxies. Simply use your API key as the username and use any parameters you usually supply as the password.

The HTTP proxy will return HTTP/1.1 407 Proxy Authentication Required in case your credentials are invalid.

cURLPythonPHP

curl -k -x "http://YOUR-APIKEY:render=true&wait_for_css=.author@proxy-server.zenscrape.com:8282" https://quotes.toscrape.com/js

import requests proxy = { "http": "http://YOUR-APIKEY:render=true&wait_for_css=.author@proxy-server.zenscrape.com:8282", "https": "http://YOUR-APIKEY:render=true&wait_for_css=.author@proxy-server.zenscrape.com:8282" } response = requests.get('https://quotes.toscrape.com/js', proxies=proxy, verify=False); print(response.text)

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($ch, CURLOPT_URL, "https://quotes.toscrape.com/js"); curl_setopt($ch, CURLOPT_PROXY, "proxy-server.zenscrape.com:8282"); curl_setopt($ch, CURLOPT_PROXYUSERPWD, "YOUR-APIKEY:render=true&wait_for_css=.author"); $response = curl_exec($ch); curl_close($ch); var_dump($response);

Premium Proxy Location List

The following list of locations can be used for the location parameter, if premium is set to true.

North America

ai – Anguilla
ag – Antigua and Barbuda
aw – Aruba
bs – Bahamas
bb – Barbados
bz – Belize
bm – Bermuda
bq – Bonaire Saint Eustatius and Saba
vg – BritishVirginIslands
ca – Canada
ky – Cayman Islands
cr – Costa Rica
cu – Cuba
cw – Curacao

dm – Dominica
do – Dominican Republic
sv – El Salvador
gd – Grenada
gp – Guadeloupe
gt – Guatemala
ht – Haiti
hn – Honduras
jm – Jamaica
mq – Martinique
mx – Mexico
ni – Nicaragua

pa – Panama
pr – Puerto Rico
bl – Saint Barthelemy
kn – Saint Kitts and Nevis
lc – Saint Lucia
mf – Saint Martin
pm – Saint Pierre and Miquelon
vc – Saint Vincent and the Grenadines
sx – Sint Maarten
tt – Trinidad and Tobago
tc – TurksandCaicosIslands
us – United States
vi – United States Virgin Islands

Europe

ax – Aland Islands
al – Albania
ad – Andorra
at – Austria
by – Belarus
be – Belgium
ba – Bosnia and Herzegovina
bg – Bulgaria
hr – Croatia
cy – Cyprus
cz – Czech Republic
dk – Denmark
ee – Estonia
fo – Faroe Islands
fi – Finland
fr – France

de – Germany
gi – Gibraltar
gr – Greece
gl – Greenland
gg – Guernsey
hu – Hungary
is – Iceland
ie – Ireland
im – Isle of Man
it – Italy
je – Jersey
xk – Kosovo
lv – Latvia
li – Liechtenstein
lt – Lithuania
lu – Luxembourg
mk – Macedonia

mt – Malta
md – Moldova
mc – Monaco
me – Montenegro
nl – Netherlands
no – Norway
pl – Poland
pt – Portugal
ro – Romania
sm – San Marino
rs – Serbia
sk – Slovakia
si – Slovenia
es – Spain
se – Sweden
ch – Switzerland
tr – Turkey
ua – Ukraine
uk – United Kingdom
va – Vatican

Asia

af – Afghanistan
am – Armenia
az – Azerbaijan
bh – Bahrain
bd – Bangladesh
bt – Bhutan
bn – Brunei
kh – Cambodia
cn – China
ge – Georgia
hk – Hong Kong
in – India
mm – Myanmar
np – Nepal
om – Oman
pk – Pakistan
ph – Philippines

id – Indonesia
ir – Iran
iq – Iraq
il – Israel
jp – Japan
jo – Jordan
kz – Kazakhstan
kw – Kuwait
kg – Kyrgyzstan
la – Laos
lb – Lebanon
mo – Macao
my – Malaysia
mv – Maldives
mn – Mongolia

qa – Qatar
ru – Russia
sa – Saudi Arabia
sg – Singapore
kr – South Korea
lk – Sri Lanka
sy – Syria
tw – Taiwan
tj – Tajikistan
th – Thailand
tm – Turkmenistan
ae – United Arab Emirates
uz – Uzbekistan
vn – Vietnam
ye – Yemen

South America

ar – Argentina
bo – Bolivia
br – Brazil
cl – Chile
co – Colombia

ms – Montserrat
ec – Ecuador
fk – Falkland Islands
gf – French Guiana
gy – Guyana

py – Paraguay
pe – Peru
sr – Surinam
uy – Uruguay
ve – Venezuela

Australia & Oceanica

au – Australia
cx – Christmas Island
cc – Cocos Islands
ck – Cook Islands
tl – East Timor
fj – Fiji
pf – FrenchPolynesia
gu – Guam

ki – Kiribati
mh – Marshall Islands
fm – Micronesia
nr – Nauru
nc – New Caledonia
nz – New Zealand
mp – Northern Mariana Islands

pw – Palau
pg – Papua New Guinea
ws – Samoa
sb – SolomonIslands
to – Tonga
tv – Tuvalu
vu – Vanuatu
vf – Wallis and Futuna

Africa

dz – Algeria
ao – Angola
bj – Benin
bw – Botswana
bf – Burkina Faso
bi – Burundi
cm – Cameroon
cv – CapeV erde
cf – Central African Republic
td – Chad
km – Comoros
dj – Djibouti
eg – Egypt
gq – Equatorial Guinea
er – Eritrea
et – Ethiopia
ga – Gabon
gm – Gambia

gh – Ghana
gn – Guinea
gw – Guinea
ci – Ivory Coast
ke – Kenya
ls – Lesotho
lr – Liberia
ly – Libya
mg – Madagascar
mw – Malawi
ml – Mali
mr – Mauritania
mu – Mauritius
yt – Mayotte
ma – Morocco
mz – Mozambique
na – Namibia
ne – Niger
ng – Nigeria
cg – Republic of the Congo
re – Reunion

rw – Rwanda
st – Sao Tomeand Principe
sn – Senegal
sc – Seychelles
sl – Sierra Leone
so – Somalia
za – South Africa
ss – South Sudan
sd – Sudan
sz – Swaziland
tz – Tanzania
tg – Togo
tn – Tunisia
ug – Uganda
eh – Western Sahara
zm – Zambia
zw – Zimbabwe

Authentification & Apikey Information

Zenscrape uses API keys to allow access to the API. You can register a new API key at our developer portal. You can register a new API key at our developer portal. The /status route returns the number of left credits.

To authorize, you can use the following ways:

GET POST /status

Zenscrape looks for the API key in a header that looks like the following (recommended, works with all requests):

curl "https://app.zenscrape.com/api/v1/status" \ -H "apikey: YOUR-APIKEY"

curl "https://app.zenscrape.com/api/v1/status?apikey=YOUR-APIKEY"

curl "https://app.zenscrape.com/api/v1/status -F "apikey=YOUR-APIKEY"

Error Codes

The Zenscrape API uses the following error codes:

HTTP Error Code	Meaning
403	Forbidden — API key is wrong, you don't have enough credits or you don't have enough rights to access it.
404	Not Found — There were no results found.
429	Too many requests — You have reached the limit for concurrency. Please wait or upgrade
500	Internal Server Error

The API returns errors in this template:

{ 
   "errors": [{ 
      "url": "missing" 
   }] 
}

Common Use Cases

Using Premium Proxies

Zenscrape offers a large pool of premium proxies are the preferred choice when scraping sites that are difficult to scrape. In order to utilize the pool simply set premium=true. In addition, you may specify a location, using the location parameter. We have chosen ‘se' (Sweden) for this example. You can see a list of all supported locations here.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fip&premium=true&country=se

curl "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fip&premium=true&country=se"

import requests headers = { "apikey": "YOUR-APIKEY"} params = ( ("url","https://httpbin.org/ip"), ("premium","true"), ("country","se"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request'); var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://httpbin.org/ip&premium=true&country=se' }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://httpbin.org/ip", "premium" => "true", "country" => "se", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY", )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

Setting a Custom Header

Setting a custom header to avoid being blocked is not necessary, since we manage headers on our end. If you still want to set a custom header, you can do so by setting keep_headers=true. In this example we set a custom user-agent.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fheaders&keep_headers=true&country=us

curl -H "User-Agent: 123" \ "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fheaders&keep_headers=true&country=us"

import requests headers = { "apikey": "YOUR-APIKEY", "User-Agent": "123" } params = ( ("url","https://httpbin.org/headers"), ("keep_headers","true"), ("country","us"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request'); var headers = { 'User-Agent': '123' }; var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://httpbin.org/headers&keep_headers=true&country=us', headers: headers }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://httpbin.org/headers", "keep_headers" => "true", "country" => "us", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY", "User-Agent: 123" )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

Enable JS Rendering

A lot of websites use front-end frameworks like vue, react etc. In order to extract components that require javascript, please set render=true.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fheaders&keep_headers=true&country=us

curl -H "User-Agent: 123" \ "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fhttpbin.org%2Fheaders&keep_headers=true&country=us"

import requests headers = { "apikey": "YOUR-APIKEY", "User-Agent": "123" } params = ( ("url","https://httpbin.org/headers"), ("keep_headers","true"), ("country","us"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request'); var headers = { 'User-Agent': '123' }; var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://httpbin.org/headers&keep_headers=true&country=us', headers: headers }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://httpbin.org/headers", "keep_headers" => "true", "country" => "us", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY", "User-Agent: 123" )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

Getting around Cloudflare DDoS Protection

Quite a few websites that are offering interesting content have imposed cloudflare DDoS protection. Zenscrape automatically detects when cloudlare DDoS protection appears and returns the page content once the protection layer has disappeared. Hence, cloudflare DDoS protection is handled automatically and does not require any action from your end.

Blocking Particular Resources

In order to increase speed or to supress a certain page behaviour, it can be useful to block certain resources from loading. In the following example we have decided to block stylesheets, image and other media from loading. Keep in mind that block_resources only works in combination with render=true.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fquotes.toscrape.com%2Fjs&render=true&block_resources=stylesheet%2Cimage%2Cmedia

curl "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fquotes.toscrape.com%2Fjs&render=true&block_resources=stylesheet%2Cimage%2Cmedia"

import requests headers = { "apikey": "YOUR-APIKEY"} params = ( ("url","https://quotes.toscrape.com/js"), ("render","true"), ("block_resources","stylesheet,image,media"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request'); var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://quotes.toscrape.com/js&render=true&block_resources=stylesheet,image,media' }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://quotes.toscrape.com/js", "render" => "true", "block_resources" => "stylesheet,image,media", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY", )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

Setting a Cookie

Cookies can also be passed to the request using keep_headers=true. The header then simply needs to contain the cookie name and value.

BrowsercURLPython Node.jsPHP

https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fquotes.toscrape.com%2Fcookies&keep_headers=true

curl -H "Cookie: SESSIONID=27382738" \ "https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https%3A%2F%2Fquotes.toscrape.com%2Fcookies&keep_headers=true"

import requests headers = { "apikey": "YOUR-APIKEY", "Cookie": "SESSIONID=27382738" } params = ( ("url","https://quotes.toscrape.com/cookies"), ("keep_headers","true"), ); response = requests.get('https://app.zenscrape.com/api/v1/get', headers=headers, params=params); print(response.text)

var request = require('request');, var headers = { 'User-Agent': '123', 'Cookie': 'SESSIONID=27382738' }; var options = { url: 'https://app.zenscrape.com/api/v1/get?apikey=YOUR-APIKEY&url=https://quotes.toscrape.com/cookies&keep_headers=true' }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } } request(options, callback);

$ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); $data = [ "url" => "https://quotes.toscrape.com/cookies", "keep_headers" => "true", ]; curl_setopt($ch, CURLOPT_URL, "https://app.zenscrape.com/api/v1/get?" . http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apikey: YOUR-APIKEY",, "Cookie: SESSIONID=27382738" )); $response = curl_exec($ch); curl_close($ch); $json = json_decode($response); var_dump($json);

References,

https://app.zenscrape.com/documentation#webScrapingApi

Disclaimer: This part of the content is mainly from the merchant. If the merchant does not want it to be displayed on my website, please contact us to delete your content.

How to Use Scraping Robot API? Learn Manuals Before You Buy

proxysp — Thu, 01 Jan 1970 00:00:00 +0000

Want to buy Scraping Robot API for web scraping? Before that, you have to know how to use it. This article will give you a detailed guide.

Scraping Robot API

Basic Usage

This page will tell you about Scraping Robot's basic functionality

The Scraping Robot API exposes a single API endpoint. Simply send an http-request to https://api.scrapingrobot.com with your API key, passed as a query-parameter, and get the needed data.

All task-parameters are passed in a POST-body as a JSON-object.

POST Sample Code

https://api.scrapingrobot.com?token=

Sample Code

{  
  "url": "https://www.scrapingrobot.com/",  
  "module": "HtmlChromeScraper" 
}

Authentication

Every request to the Scraping Robot API should contain an access token. If a user does not pass the token or it is invalid – Scraping Robot will respond with status 401 (Unauthorized).

The token can be passed in two ways:

As a query-parameter:
- ?token=
In the Authorization header (bearer authentication):
- Authorization: Bearer

Note: To receive your Scraping Robot API access token you must register an account at https://dashboard.scrapingrobot.com/sign-up.

Error Handling

Authorization Parameter Missing

If you forget to include your API key from your Scraping Robot dashboard as the “token” path parameter in your API call, we'll show you the error message on the right side of the screen.

Authorization Parameter Missing

{
   "status": "FAIL",
   "date": "Thu, 01 Mar 2020 10:00:00 GMT",
   "error": "Token query parameter not found"
}

To rectify this error, please include your API key from your Scraping Robot dashboard as the “token” path parameter in your API call, so that you can be authorized to make the request to our system.

Invalid Authorization Parameter

If you put an invalid API key as the “token” path parameter in your API call, we will show you the error message on the right side of the screen.

Invalid Authorization Parameter

{
   "status": "FAIL",
   "date": "Thu, 01 Mar 2020 10:00:00 GMT",
   "error": "Invalid client token"
}

Not Enough Credits

If you do not have enough credits in your account to perform the scraping task you're requesting, we will show you the error message on the right side of the screen.

Not Enough Credits

{
  "status": "FAIL",
  "date": "Thu, 01 Mar 2020 10:00:00 GMT",
  "error": "You do not have enough credits"
}

To rectify this error, please add scraping credits to your account through your Scraping Robot dashboard or contact our support team to get credits added to your account.

Request Body is not Valid JSON

If you send in a request that does not have valid JSON, we will show you the error message on the right side of the screen.

Invalid JSON includes anything that is not in JSON format and does not have the structure of JSON. This is different than the “Invalid Request Body” error explained next.

Request Body is not Valid JSON

{
  "status": "FAIL",
  "date":"Thu, 01 Mar 2020 10:00:00 GMT",
  "error": "Request-body is not a valid JSON"
}

To rectify this error, please fix the JSON in the request body and try your request again. You can find JSON validators online to help you with getting your JSON correctly formatted.

Invalid Request Body

If you send in a JSON body, but the body parameters are incorrect or out of order, we will show you the error message on the right side of the screen.

Invalid Request Body

{ 
  "status": "FAIL", 
  "date":"Thu, 01 Mar 2020 10:00:00 GMT", 
  "error": "Invalid json format: ..." 
}

To rectify this error, please review the API documentation for the request you're sending in to ensure all parameters are correct. If you cannot resolve the issue on your own, please contact our support team for assistance and we'll gladly help out!

Service Overloaded

If our service is overloaded at the time of your request, we will show you the error message on the right side of the screen.

Service Overloaded

{ 
  "status": "FAIL", 
  "date":"Thu, 01 Mar 2020 10:00:00 GMT", 
  "error": "The service is overloaded. Try again later" 
}

To rectify this error, please contact our support team for updates on the situation.

Page Load Failure

If Scraping Robot is unable to load the page you're trying to scrape, we will show you the error message on the right side of the screen.

Page Load Failure

{ 
  "status": "FAIL", 
  "date":"Thu, 01 Mar 2020 10:00:00 GMT", 
  "error": "Please retry this task again later" 
}

To rectify this error, please contact our support team for assistance.

Internal Error

If there is an issue with our system, we will show you the error message on the right side of the screen.

Internal Error

{ 
  "error": "Internal server error", 
  "date": "Thu, 01 Mar 2020 10:00:00 GMT", 
  "status": "FAIL" 
}

To rectify this error, please contact our support team for assistance.

Credits

Get Credit Balance

GET https://api.scrapingrobot.com/balance?token=

[/su_tab]

Get Credit Usage Statistics

get https://api.scrapingrobot.com/stats?token=&type=daily

This endpoint will show you your credit usage over the specified time period.

cURLNodePHPPythonTab titleC++

Request

curl --request GET \
--url 'https://api.scrapingrobot.com/balance?token=' \
--header 'Accept: application/json'

Request

const fetch = require('node-fetch');
const url = 'https://api.scrapingrobot.com/balance?token=';
const options = {method: 'GET', headers: {Accept: 'application/json'}};
fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

Request

request('GET', 'https://api.scrapingrobot.com/balance?token=', [
'headers' => [
'Accept' => 'application/json',
],
]);

echo $response->getBody();

Request

import requests

url = "https://api.scrapingrobot.com/balance?token="

headers = {"Accept": "application/json"}

response = requests.request("GET", url, headers=headers)

print(response.text)

Request

const options = {method: 'GET', headers: {Accept: 'application/json'}};

fetch('https://api.scrapingrobot.com/balance?token=', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));

Request

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.scrapingrobot.com/balance?token=");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[/su_tab]

Html API

Create a task using POST-request

/

post https://api.scrapingrobot.com/

Create scraping task

cURLNodePHP PythonJavaScriptC++

Request

curl --request GET \
--url 'https://api.scrapingrobot.com/stats?token=&type=daily' \
--header 'Accept: application/json'

Request

const fetch = require('node-fetch');

const url = 'https://api.scrapingrobot.com/stats?token=&type=daily';
const options = {method: 'GET', headers: {Accept: 'application/json'}};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));

Request

request('GET', 'https://api.scrapingrobot.com/stats?token=&type=daily', [
'headers' => [
'Accept' => 'application/json',
],
]);

echo $response->getBody();

Request

import requests

url = "https://api.scrapingrobot.com/stats?token=&type=daily"

headers = {"Accept": "application/json"}

response = requests.request("GET", url, headers=headers)

print(response.text)

Request

const options = {method: 'GET', headers: {Accept: 'application/json'}};

fetch('https://api.scrapingrobot.com/stats?token=&type=daily', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));

Request

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.scrapingrobot.com/stats?token=&type=daily");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[/su_tab]

Create a task using GET-request

/

get https://api.scrapingrobot.com/

Create scraping task

cURLNodePHPPythonJavaScriptC++

Request

curl --request POST \
--url 'https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true&contentType=text%2Fplain' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Request

const sdk = require('api')('@staging-docs-scrapingrobot/v1.0#1b382ykufox5uf');

sdk.server('https:/api.scrapingrobot.com/');
sdk.post('', {
responseType: 'json',
waitUntil: 'load',
noScripts: 'false',
noImages: 'true',
noFonts: 'true',
noCss: 'true',
contentType: 'text%2Fplain'
})
.then(res => console.log(res))
.catch(err => console.error(err));

Request

request('POST', 'https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true&contentType=text%2Fplain', [
'headers' => [
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
]);

echo $response->getBody();

Request

import requests

url = "https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true&contentType=text%2Fplain"

headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}

response = requests.request("POST", url, headers=headers)

print(response.text)

Request

const options = {
method: 'POST',
headers: {Accept: 'application/json', 'Content-Type': 'application/json'}
};

fetch('https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true&contentType=text%2Fplain', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));

Request

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true&contentType=text%2Fplain");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept: application/json");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[/su_tab]

Get current credits balance

/balance

get https://api.scrapingrobot.com/balance

Get current credits balance

cURLNodePHP PythonJavaScriptC++

Request

curl --request GET \
--url https://api.scrapingrobot.com/ \
--header 'Accept: application/json'

Request

const sdk = require('api')('@staging-docs-scrapingrobot/v1.0#1b382ykufox5uf');

sdk.server('https:/api.scrapingrobot.com/');
sdk.get('', {
responseType: 'json',
waitUntil: 'load',
noScripts: 'false',
noImages: 'true',
noFonts: 'true',
noCss: 'true'
})
.then(res => console.log(res))
.catch(err => console.error(err));

Request

request('GET', 'https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true', [
'headers' => [
'Accept' => 'application/json',
],
]);

echo $response->getBody();

Request

import requests

url = "https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true"

headers = {"Accept": "application/json"}

response = requests.request("GET", url, headers=headers)

print(response.text)

Request

const options = {method: 'GET', headers: {Accept: 'application/json'}};

fetch('https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));

Request

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.scrapingrobot.com/?responseType=json&waitUntil=load&noScripts=false&noImages=true&noFonts=true&noCss=true");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

[/su_tab]

References,

https://docs.scrapingrobot.com/reference/getting-started-with-your-api

Disclaimer: This part of the content is mainly from the merchant. If the merchant does not want it to be displayed on my website, please contact us to delete your content.

911 Proxy Developer API (Offline!)

admin — Tue, 03 Aug 2021 08:02:46 +0000

Please note that the API only works for getting a new proxy from “ProxyList”, and can not be used to reuse the proxy from “TodayList”. The following are how to use the API and examples

After login to the software, switch to the AutoProxy tab, select “Use API” from “API settings,” and you need to keep the software staying logged in when you use the API:

In the software's root folder, there's a subfolder: “proxytool” and there's a file “Autoproxytool.exe” in it

Using your soft/script which want to implement the api to launch “Autoproxytool.exe” with the following parameters, then you are able to change proxy automatically：

Autoproxytool.exe -changeproxy/all use a random proxy from any countries

Autoproxytool.exe -changeproxy/US use a random proxy from US

Autoproxytool.exe -changeproxy/US/NY use a random proxy from US, state: NewYork

Autoproxytool.exe -changeproxy/US/NY/”New York” use a random proxy from US, state: NewYork, city: New York

For country you need to enter the country ISO alpha-2 code, if you have no idea, you can google: country ISO alpha-2 code

-citynolimit you can use the parameter like this:

Autoproxytool.exe -changeproxy/US/NY/”New York”/ -citynolimit

Which means the API system will firstly try to get a proxy from the City you set(New York) for higher priority, Only if there's no proxy available from that City, then it will try to get a proxy from the State you set(NY). If proxy is available from that City, it wont try from the State(NY)

Autoproxytool.exe -changeproxy/ -ip=123.123.123.123

Get a proxy by ip. You can replace * in the ip address to get any proxy from that ip block, e.g: Autoproxytool.exe -changeproxy/ -ip=123.123.*.* or Autoproxytool.exe -changeproxy/ -ip=123.*.*.*

Autoproxytool.exe -proxyport=

Forward a proxy to a port, the port need to be in the “port forward” range in software “Settings”, Each time using the parameter will result in replacing a new proxy to this port

Autoproxytool.exe -freeport=

Free the port and unload the proxy

Autoproxytool.exe -proxyport=all

Forward proxies to all the ports in the “port forward” range in software “Settings”, Each time using the parameter will result in replacing new proxies to all these ports

Autoproxytool.exe -freeport=all

Free all the ports and unload all the proxies

Autoproxytool.exe -isp=

Use a random proxy from the isp, it also supports fuzzy search by using *, e.g Autoproxytool.exe -isp=S*, means to get a proxy with ISP starting with “S”, Autoproxytool.exe -isp=*Cable, means to get a proxy with ISP ending with “Cable”

Autoproxytool.exe -zip=

Use a random proxy from the zip location, it also supports fuzzy search by using *, e.g Autoproxytool.exe -zip=800*, means to get a proxy with ZIP starting with “800”

And these parameters mentioned above can be used as a combo, some examples:

Autoproxytool.exe -changeproxy/US/NY/”New York” -proxyport=5000

Autoproxytool.exe -changeproxy/US/NY -proxyport=all

Autoproxytool.exe -changeproxy/US/NY -isp=”Time Warner Cable”

Autoproxytool.exe -changeproxy/US -zip=92626

Autoproxytool.exe -changeproxy/US/NY -isp=”Time Warner Cable” -proxyport=5000

Autoproxytool.exe -changeproxy/US -zip=92626 -proxyport=5000

-hwnd=

With using -hwnd= parameter, Autoproxytool.exe will send WM_COPYDATA message to your soft which launches Autoproxytool.exe, so that your soft is able to get postcheck and more info of the proxy, you also need to pass the Window Handle of your soft which launches Autoproxytool.exe and Autoproxytool.exe will send you WM_COPYDATA message with the following format and info:

1. if the proxy successful get by api:

2. if the proxy failed to get by api:

failed|reason for failure

Some examples of how to use it:

Autoproxytool.exe -changeproxy/US/NY/”New York” -hwnd=YOUR SOFT'S WINDOW HANDLE

Autoproxytool.exe -changeproxy/US/NY/”New York” -citynolimit -hwnd=YOUR SOFT'S WINDOW HANDLE

Autoproxytool.exe -changeproxy/ -ip=123.123.*.* -hwnd=YOUR SOFT'S WINDOW HANDLE

Autoproxytool.exe -changeproxy/US/NY/”New York” -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE

Autoproxytool.exe -changeproxy/US/NY -isp=”Time Warner Cable” -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE

Autoproxytool.exe -changeproxy/US -zip=92626 -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE

Auto change proxy from the software:

In “AutoProxy” tab, the features of “AutoProxy Settings” its not for API, its designed for auto swiching proxy according to the configs, you can set the frequency to auto change proxy and set delay of time range to auto launch your program, etc. For using this feature, you need to unselect “Use API” from “API Settings”

Updated time: Sep 12th 2019

Since 911 S5 3.2, We developed a new API program for port forwarding

The new API program works with multi-thread, you can send multiple API requests at the same time(The old API program Autoproxytool.exe only can handle your request one by one with single thread, you have to wait until the last request get processed)

If your work requires high efficiency which need to send a lot of API requests, we suggest you to use the new API:

In the software's root folder, there's a sub folder: “proxytool” and there's a file “ProxyAPI.exe” in it

Launching “ProxyAPI.exe” with parameters from your soft/script, the parameters and format its exactly the same like using the old API program(Autoproxytool.exe), the only difference is you need to include this parameter “-proxyport=”, the port behind this parameter must be in the “Port Forward” range of 911 S5's “Settings” tab. Please note, you need to keep 911 S5 staying logged in when you use the API. Here are some examples of using the new API:

ProxyAPI.exe -changeproxy/US/NY/”New York” -proxyport=5000, Port forwarding a proxy from New York to port 5000

ProxyAPI.exe -changeproxy/ -ip=123.123.*.* -proxyport=5000 -hwnd=YOUR SOFT'S WINDOW HANDLE, Port forwarding a proxy from IP range “123.123.*.*” to port 5000, and send WM_COPYDATA message to your soft

ProxyAPI.exe -changeproxy/US/NY/”New York” -citynolimit -proxyport=5000

ProxyAPI.exe -changeproxy/US/NY -isp=”Time Warner Cable” -proxyport=5000, Port forwarding a proxy from the US, NY, with ISP Time Warner Cable to port 5000

ProxyAPI.exe -changeproxy/US -zip=92626 -proxyport=5000, Port forwarding a proxy from the US with ZIP code “92626” to port 5000

ProxyAPI.exe -changeproxy/US/NY -proxyport=all, Port forwarding proxies from the US, NY to all the available ports(all the ports in “Port Forward” range of 911 S5's “Settings” tab)

ProxyAPI.exe -freeport=5000, Free port 5000 and unload the proxy

ProxyAPI.exe -freeport=all, Free all the ports and unload all the proxies

APIs – ProxySP

How to Use Proxy-IPV4 API

General requests

To get the balance information

To get the full list of the bought proxies

To get the available number of days for a proxy purchase/renewal

To get the list of the countries available for purchase

To get the list of the available goals for purchase

IPv4 requests

To get the ipv4 list of the bought proxies

Calculate purchase price

Calculate extending price

Placing an order

Extending proxy

IPv6 requests

To get the ipv4 list of the bought proxies

Calculate purchase price

Calculate extending price

Placing an order

Extending proxy

Mobile requests

To get the list of available mobile tariffs

the list of active mobile proxies

Calculate purchase price

Calculate extending price

Placing an order

Extending proxy

Possible mistakes

How to Use ProxyScrape Premium API

Get proxy list

Get authenticated IPs

GET Authenticate one IP

GET Authenticate multiple IPs

References,

How to Use Free ProxyScrape API

Get proxy list

C#

CURL

Dart – Http

Go – Native

HTTP

java okhttp

JavaScript – Fetch

JavaScript – jQuery

JavaScript – XHR

C – libcurl

NodeJs – Axios

NodeJs – Native

DNodeJs – Request

PHP – cURL

Python – http.client

Python – Requests

Ruby – Net::HTTP

Shell – Httpie

Shell – get

Swift – URLSession

Get proxy list details

References,

How to Use Bright Data API? Learn Manuals Before You Buy

Luminati proxy API

For Browser or Software,

Shell

Node.js

C#

VB

PHP

Python

Ruby

Perl

Search Engine Crawler API

Google Search Crawler API

Search

Maps

Trends

Reviews

Bing Search Crawler API

Yandex Search Crawler API

DuckDuckGo Search Crawler API

Resource,

How to Use Zenscrape API