Web Scraping Proxies made Simple
Get Started scraping the web in as little as 2 minutes
API Documentation
Scraping & Integration Tutorials
Frequent Questions
Getting Started
Advanced API Functionality
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
ScrapeNetwork exposes a single API endpoint for you to send GET requests. Simply send a GET request to http://api.scrapenetwork.com with two query string parameters and the API will return the HTML response for that URL:
api_keywhich contains your API key, andurlwhich contains the url you would like to scrape
You should format your requests to the API endpoint as follows:
curl "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
curl "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
To use two or more parameters, simply separate them with the “&” sign.
curl "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
curl -x "http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
curl -x "http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Multiple parameters can be included by separating them with periods; for example:
curl -x "http://scrapenetwork.render=true.country_code=true:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
curl --header "X-MyHeader: 123" "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/anything&keep_headers=true"
curl --header "X-MyHeader: 123" \-x "http://scrapenetwork.keep_headers=true:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/anything"
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
curl "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&session_number=123"
curl -x "http://scrapenetwork.session_number=123:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
curl "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us"
curl -x "http://scrapenetwork.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
curl "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us"
curl -x "http://scrapenetwork.premium=true:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
curl "http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&device_type=mobile"
curl -x "http:/scrapenetwork.device_type=mobile:APIKEY@proxy-server.scrapenetwork.com:8001" -k "http://httpbin.org/ip"
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
curl "http://api.scrapenetwork.com/account?api_key=APIKEY"
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
ScrapeNetwork exposes a single API endpoint for you to send GET requests. Simply send a GET request to http://api.scrapenetwork.com with two query string parameters and the API will return the HTML response for that URL:
api_keywhich contains your API key, andurlwhich contains the url you would like to scrape
You should format your requests to the API endpoint as follows:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
Simple Code
import requests
payload = {'api_key': 'APIKEY', 'url': 'https://httpbin.org/ip'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork?api_key=APIKEY&url=' + url]
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url, self.parse)
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
Simple Code
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'render': 'true'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork.com?api_key=APIKEY&url=' + url +'&render=true']
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url +'&render=true', self.parse)
To use two or more parameters, simply separate them with the “&” sign.
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Simple Code
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'render': 'true', 'country_code': 'us'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork.com?api_key=APIKEY&url=' + url +'&render=true' + ‘&country_code=true’]
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url +'&render=true' + ‘&country_code=true’, self.parse)
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
"http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
You can use the scrapenetwork proxy the same way as you would use any other proxy:
import requests
proxies = {
"http": "http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
}
r = requests.get('http://httpbin.org/ip', proxies=proxies, verify=False)
print(r.text)
# Scrapy users can likewise simply pass their API key in headers.
# NB: Scrapy skips SSL verification by default.
# ...other scrapy setup code
start_urls = ['http://httpbin.org/ip']
meta = {
"proxy": "http://scrapenetwork:APIKEY@proxy-server.scrapenetwork:8001"
}
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request(url, callback=self.parse, headers=headers, meta=meta)
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
"http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
Multiple parameters can be included by separating them with periods; for example:
"http://scrapenetwork.render=true.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
import requests
url = 'http://httpbin.org/anything'
headers = {
'Accept': 'application/json'
'X-MyHeader': '123',
}
payload = {'api_key': 'APIKEY', 'url': 'https://httpbin.org/ip', 'keep_headers': 'true'}
r = requests.get('http://api.scrapenetwork.com', params=payload, headers=headers)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function in their parse function
# ...other scrapy setup code
headers = {
'Accept': 'application/json'
'X-MyHeader': '123',
}
start_urls = ['http://api.scrapenetwork.com?api_key=APIKEY&url=' + url + '&keep_headers=true']
def parse(self, response):
# ...your parsing logic here
scraper_url = 'http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url + '&keep_headers=true'
yield scrapy.Request(scraper_url, self.parse, headers=headers)
import requests
headers = {
'Accept': 'application/json'
'X-MyHeader': '123',
}
proxies = {
"http": "http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
}
r = requests.get('http://httpbin.org/ip', proxies=proxies, headers=headers, verify=False)
print(r.text)
# Scrapy users can likewise simply pass their API key in headers.
# NB: Scrapy skips SSL verification by default.
# ...other scrapy setup code
start_urls = ['http://httpbin.org/ip']
meta = {
"proxy": "http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
}
headers = {
'Accept': 'application/json'
'X-MyHeader': '123',
}
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request(url, callback=self.parse, headers=headers, meta=meta)
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'session_number': '123'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork?api_key=APIKEY&url=' + url + '&session_number=123']
import requests
proxies = {
"http": "http://scrapenetwork.session_number=123:APIKEY@proxy-server.scrapenetwork.com:8001"
}
r = requests.get('http://httpbin.org/ip', proxies=proxies, verify=False)
print(r.text)
# Scrapy users can likewise simply pass their API key in headers.
# NB: Scrapy skips SSL verification by default.
# ...other scrapy setup code
start_urls = ['http://httpbin.org/ip']
meta = {
"proxy": "http://scrapenetwork.session_number=123:APIKEY@proxy-server.scrapenetwork.com:8001"
}
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request(url, callback=self.parse, headers=headers, meta=meta)
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'country_code': 'us'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork?api_key=APIKEY&url=' + url + 'country_code=us']
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork/?api_key=APIKEY&url=' + url + 'country_code=us', self.parse)
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'country_code': 'us'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork?api_key=APIKEY&url=' + url + 'country_code=us']
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url + 'country_code=us', self.parse)
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'premium': 'true'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork.com?api_key=APIKEY&url=' + url + 'premium=true']
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url + 'premium=true', self.parse)
import requests
proxies = {
"http": "http://scrapenetwork.premium=true:APIKEY@proxy-server.scrapenetwork.com:8001"
}
r = requests.get('http://httpbin.org/ip', proxies=proxies, verify=False)
print(r.text)
# Scrapy users can likewise simply pass their API key in headers.
# NB: Scrapy skips SSL verification by default.
# ...other scrapy setup code
start_urls = ['http://httpbin.org/ip']
meta = {
"proxy": "http://scrapenetwork.premium=true:APIKEY@proxy-server.scrapenetwork.com:8001"
}
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request(url, callback=self.parse, headers=headers, meta=meta)
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
import requests
payload = {'api_key': 'APIKEY', 'url':'https://httpbin.org/ip', 'device_type': 'mobile'}
r = requests.get('http://api.scrapenetwork.com', params=payload)
print r.text
# Scrapy users can simply replace the urls in their start_urls and parse function
# ...other scrapy setup code
start_urls = ['http://api.scrapenetwork.com?api_key=APIKEY&url=' + url + 'device_type=mobile']
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request('http://api.scrapenetwork.com/?api_key=APIKEY&url=' + url + 'device_type=mobile', self.parse)
import requests
proxies = {
"http": "http://scrapenetwork.device_type=mobile:APIKEY@proxy-server.scrapenetwork.com:8001"
}
r = requests.get('http://httpbin.org/ip', proxies=proxies, verify=False)
print(r.text)
# Scrapy users can likewise simply pass their API key in headers.
# NB: Scrapy skips SSL verification by default.
# ...other scrapy setup code
start_urls = ['http://httpbin.org/ip']
meta = {
"proxy": "http://scrapenetwork.device_type=mobile:APIKEY@proxy-server.scrapenetwork.com:8001"
}
def parse(self, response):
# ...your parsing logic here
yield scrapy.Request(url, callback=self.parse, headers=headers, meta=meta)
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
import requests
payload = {'api_key': 'APIKEY'}
r = requests.get('http://api.scrapenetwork.com/account', params=payload)
print r.text
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
You should format your requests to the API endpoint as follows:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
Simple Code
const request = require('request-promise');
request(`http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip`)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
Simple Code
const request = require('request-promise');
request(`http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&render=true`)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
To use two or more parameters, simply separate them with the “&” sign.
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Simple Code
const request = require('request-promise');
request(`http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us`)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
"http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
You can use the scrapenetwork proxy the same way as you would use any other proxy:
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://httpbin.org/ip',
proxy:`http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001`
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
"http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
Multiple parameters can be included by separating them with periods; for example:
"http://scrapenetwork.render=true.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/anything&keep_headers=true',
headers: {
Accept: 'application/json',
'X-MyHeader': '123',
},
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://httpbin.org/anything',
proxy:'http://scrapenetwork.keep_headers=true:APIKEY@proxy-server.scrapenetwork:8001',
headers: {
Accept: 'application/json',
'X-MyHeader': '123',
},
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
const request = require('request-promise');
request('http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&session_number=123')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://httpbin.org/ip',
proxy:'http://scrapenetwork.session_number=123:APIKEY@proxy-server.scrapenetwork.com:8001'
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
const request = require('request-promise');
request('http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
const request = require('request-promise');
request('http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
const request = require('request-promise');
request('http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&premium=true')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://httpbin.org/ip',
proxy:'http://scrapenetwork.premium=true:APIKEY@proxy-server.scrapenetwork.com:8001'
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
const request = require('request-promise');
request('http://api.scrapenetwork.com/?api_key=APIKEY&url=http://httpbin.org/ip&device_type=mobile')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
const request = require('request-promise');
options = {
method: 'GET',
url: 'http://httpbin.org/ip',
proxy:'http://scrapenetwork.device_type=mobile:APIKEY@proxy-server.scrapenetwork:8001'
}
request(options)
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
const request = require('request-promise');
request('http://api.scrapenetwork.com/account?api_key=APIKEY')
.then(response => {
console.log(response)
})
.catch(error => {
console.log(error)
})
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
ScrapeNetwork exposes a single API endpoint for you to send GET requests. Simply send a GET request to http://api.scrapenetwork.com with two query string parameters and the API will return the HTML response for that URL:
api_keywhich contains your API key, andurlwhich contains the url you would like to scrape
You should format your requests to the API endpoint as follows:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
Simple Code
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
Simple Code
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
To use two or more parameters, simply separate them with the “&” sign.
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Simple Code
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
"http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
You can use the scrapenetwork proxy the same way as you would use any other proxy:
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/anything";
# POST/PUT Requests
$postData = ["foo" => "bar"];
$postData = json_encode($postData);
$headers = [
"Content-Type: application/json"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData); //Post Fields
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
#Form POST Request
$postData = ["foo" => "bar"];
$postData = json_encode($postData);
$headers = [
'Content-Type: application/x-www-form-urlencoded; charset=utf-8',
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
"http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
Multiple parameters can be included by separating them with periods; for example:
"http://scrapenetwork.render=true.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&keep_headers=true";
$headerArray = array(
"Content-Type: application/json",
"X-MyHeader: 123"
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headerArray);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
<?php
$headerArray = array(
"Content-Type: application/json",
"X-MyHeader: 123"
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://httpbin.org/ip");
curl_setopt($ch, CURLOPT_PROXY, "http://scrapenetwork.keep_headers=true:APIKEY@proxy-server.scrapenetwork.com:8001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headerArray);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&session_number=123";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://httpbin.org/ip");
curl_setopt($ch, CURLOPT_PROXY, "http://scrapenetwork.session_number=123:APIKEY@proxy-server.scrapenetwork.com:8001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&country_code=us";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&premium=true";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://httpbin.org/ip");
curl_setopt($ch, CURLOPT_PROXY, "http://scrapenetwork.premium=true:APIKEY@proxy-server.scrapenetwork.com:8001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
<?php
$url = "http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&device_type=mobile";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://httpbin.org/ip");
curl_setopt($ch, CURLOPT_PROXY, "http://scrapenetwork.device_type=mobile:APIKEY@proxy-server.scrapenetwork:8001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
<?php
$url = "http://api.scrapenetwork.com/account?api_key=APIKEY";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
ScrapeNetwork exposes a single API endpoint for you to send GET requests. Simply send a GET request to http://api.scrapenetwork.com with two query string parameters and the API will return the HTML response for that URL:
api_keywhich contains your API key, andurlwhich contains the url you would like to scrape
You should format your requests to the API endpoint as follows:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
Simple Code
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip"
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
Simple Code
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:render => true
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
To use two or more parameters, simply separate them with the “&” sign.
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Simple Code
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:render => true,
:country_code => “us”
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
"http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
You can use the scrapenetwork proxy the same way as you would use any other proxy:
require 'httparty'
HTTParty::Basement.default_options.update(verify: false)
response = HTTParty.get('http://httpbin.org/ip', {
http_proxyaddr: "proxy-server.scrapenetwork.com",
http_proxyport: "8001",
http_proxyuser: "scrapenetwork",
http_proxypass: "APIKEY"
})
results = response.body
puts results
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
"http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
Multiple parameters can be included by separating them with periods; for example:
"http://scrapenetwork.render=true.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/anything",
:keep_headers => true
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'
req['X-MyHeader'] = '123'
website_content = Net::HTTP.start(uri.hostname, uri.port) {|http|
http.request(req)
}
print(website_content.body)
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/anything",
:keep_headers => true
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'
req['X-MyHeader'] = '123'
website_content = Net::HTTP.start(uri.hostname, uri.port) {|http|
http.request(req)
}
print(website_content.body)
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:session_number => 123
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
require 'httparty'
HTTParty::Basement.default_options.update(verify: false)
response = HTTParty.get('http://httpbin.org/ip', {
http_proxyaddr: "proxy-server.scrapenetwork.com",
http_proxyport: "8001",
http_proxyuser: "scrapenetwork.session_number=123",
http_proxypass: "APIKEY"
})
results = response.body
puts results
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:country_code => “us”
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:country_code => “us”
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:premium => true
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
require 'httparty'
HTTParty::Basement.default_options.update(verify: false)
response = HTTParty.get('http://httpbin.org/ip', {
http_proxyaddr: "proxy-server.scrapenetwork.com",
http_proxyport: "8001",
http_proxyuser: "scrapenetwork.premium=true",
http_proxypass: "APIKEY"
})
results = response.body
puts results
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY",
:url => "http://httpbin.org/ip",
:device_type => “mobile”
}
uri = URI('http://api.scrapenetwork.com/')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
require 'httparty'
HTTParty::Basement.default_options.update(verify: false)
response = HTTParty.get('http://httpbin.org/ip', {
http_proxyaddr: "proxy-server.scrapenetwork.com",
http_proxyport: "8001",
http_proxyuser: "scrapenetwork.device_type=mobile",
http_proxypass: "APIKEY"
})
results = response.body
puts results
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
require 'net/http'
require 'json'
params = {
:api_key => "APIKEY"
}
uri = URI('http://api.scrapenetwork.com/account')
uri.query = URI.encode_www_form(params)
website_content = Net::HTTP.get(uri)
print(website_content)
Getting Started
Using ScrapeNetwork is easy. Just send the URL you would like to scrape to the API along with your API key and the API will return the HTML response from the URL you want to scrape.
API Key & Authentication
ScrapeNetwork uses API keys to authenticate requests. To use the API you need to sign up for an account and include your unique API key in every request.
If you haven’t signed up for an account yet then
- Sign up for a free trial here with 5,000 free API credits
Making Requests
You can use the API to scrape web pages, API endpoints, images, documents, PDFs, or other files just as you would any other URL. Note: there is a 2MB limit per request.
There are three ways in which you can send GET requests to ScrapeNetwork:
- Via our Async Scraper service
http://async.scrapenetwork.com - Via our API endpoint
http://api.scrapenetwork.com? - Via one of our SDKs (only available for some programming languages)
- Via our proxy port
http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001
Choose whichever option best suits your scraping requirements.
Important note: regardless of how you invoke the service, we highly recommend you set a 60 seconds timeout in your application to get the best possible success rates, especially for some hard-to-scrape domains.
Requests to the API Endpoint Method #1
ScrapeNetwork exposes a single API endpoint for you to send GET requests. Simply send a GET request to http://api.scrapenetwork.com with two query string parameters and the API will return the HTML response for that URL:
api_keywhich contains your API key, andurlwhich contains the url you would like to scrape
You should format your requests to the API endpoint as follows:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip"
Simple Code
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
To enable other API functionality when sending a request to the API endpoint simply add the appropriate query parameters to the end of the ScrapeNetwork URL.
For example, if you want to enable Javascript rendering with a request, then add render=true to the request:
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true"
Simple Code
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&render=true";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
To use two or more parameters, simply separate them with the “&” sign.
"http://api.scrapenetwork.com?api_key=APIKEY&url=http://httpbin.org/ip&render=true&country_code=us"
Simple Code
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&render=true&country_code=us";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Send requests to the proxy port Method #2
To simplify implementation for users with existing proxy pools, we offer a proxy front-end to the API. The proxy will take your requests and pass them through to the API which will take care of proxy rotation, captchas, and retries.
The proxy mode is a light front-end for the API and has all the same functionality and performance as sending requests to the API endpoint.
The username for the proxy is scrapenetwork and the password is your API key.
"http://scrapenetwork:APIKEY@proxy-server.scrapenetwork.com:8001"
You can use the scrapenetwork proxy the same way as you would use any other proxy:
try {
String apiKey = "APIKEY";
String proxy = "http://scrapenetwork:" + apiKey + "@proxy-server.scrapenetwork.com";
URL server = new URL("https://httpbin.org/ip");
Properties systemProperties = System.getProperties();
systemProperties.setProperty("http.proxyHost", proxy);
systemProperties.setProperty("http.proxyPort", "8001");
HttpURLConnection httpURLConnection = (HttpURLConnection) server.openConnection();
httpURLConnection.connect();
String readLine = null;
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Note: So that we can properly direct your requests through the API, your code must be configured to not verify SSL certificates.
To enable extra functionality whilst using the API in proxy mode, you can pass parameters to the API by adding them to username, separated by periods.
For example, if you want to enable Javascript rendering with a request, the username would be scrapenetwork.render=true
"http://scrapenetwork.render=true:APIKEY@proxy-server.scrapenetwork.com:8001"
Multiple parameters can be included by separating them with periods; for example:
"http://scrapenetwork.render=true.country_code=us:APIKEY@proxy-server.scrapenetwork.com:8001"
API Status Codes
The API will return a specific status code after every request depending on whether the request was successful, failed or some other error occurred. ScrapeNetwork will retry failed requests for up to 60 seconds to try and get a successful response from the target URL before responding with a 500 error indicating a failed request.
Note: To avoid timing out your request before the API has had a chance to complete all retries, remember to set your timeout to 60 seconds.
In cases where a request fails after 60 seconds of retrying, you will not be charged for the unsuccessful request (you are only charged for successful requests, 200 and 404 status codes).
Errors will inevitably occur so on your end make sure you catch these errors. You can configure your code to immediately retry the request and in most cases, it will be successful. If a request is consistently failing then check your request to make sure that it is configured correctly. Or, if you are consistently getting bans messages from an anti-bot, then create a ticket with our support team and we will try to bypass this anti-bot for you.
If you receive a successful 200 status code response from the API but the response contains a CAPTCHA, please contact our support team and they will add it to our CAPTCHA detection database. Once included in our CAPTCHA database the API will treat it as a ban in the future and automatically retry the request.
Below are the possible status codes you will receive:
| Status Code | Details |
|---|---|
| 200 | Successful response |
| 404 | Page requested does not exist. |
| 410 | Page requested is no longer available. |
| 500 | After retrying for 60 seconds, the API was unable to receive a successful response. |
| 429 | You are sending requests too fast, and exceeding your concurrency limit. |
| 403 | You have used up all your API credits. |
Credits and Requests
Every time you make a request, you consume credits. The credits you have available are defined by the plan you are currently using. The amount of credits you consume depends on the domain and parameters you add to your request.
Domains
We have created custom scrapers to target these sites, if you scrape one of these domains you will activate this scraper and the credit cost will change.
| Category | Domain examples | Credit Cost |
|---|---|---|
| SERP | Google, Bing | 25 |
| E-Commerce | Amazon, Allegro | 5 |
| Protected Domains | Linkedin, G2, Social Media Sites | 30 |
Geotargeting is included in these credit costs.
If your domain does not fit in any category in the above list, it will cost 1 credit if no additional parameters are added.
Parameters
According to your needs, you may want to access different features on our platform.
premium=true – requests cost 10 credits
render=true – requests cost 10 credits
premium=true + render=true – requests cost 25 credits
ultra_premium=true – requests cost 30 credits
ultra_premium=true + render=true – requests cost 75 credits
In any requests, with or without these parameters, we will only charge for successful requests (200 and 404 status codes). If you run out of credits sooner than planned, you can renew your subscription early as explained in the next section – Dashboard.
Dashboard
The Dashboard shows you all the information so you can keep track of your usage. It is divided into Usage, Billing, Documentation, and links to contact us.
Usage
Here you will find your API key, sample codes, monitoring tools, and usage statistics such as credits used, concurrency, failed requests, your current plan, and the end date of your billing cycle.
Billing
In this section, you are able to see your current plan, the end date of the current billing cycle, as well as subscribe to another plan. This is also the right place to set or update your billing details, payment method, view your invoices, manage your subscription, or cancel it.
Here you can also renew your subscription early, in case you run out of API credits sooner than planned. This option will let you renew your subscription at an earlier date than planned, charging you for the subscription price and resetting your credits. If you find yourself using this option regularly, please reach out to us so we can find a plan that can accommodate the number of credits you need.
Documentation
This will direct you to our documentation – exactly where you are right now.
Contact Support
Direct link to reach out to our technical support team.
Contact Sales
Direct link to our sales team, for any subscription or billing-related inquiries.
Advanced API Functionality
Customize API Functionality
ScrapeNetwork enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
| Parameter | Description |
|---|---|
| render | Activate javascript rendering by setting render=true in your request. The API will automatically render the javascript on the page and return the HTML response after the javascript has been rendered. Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra-premium ultra_premium=true. |
| country_code | Activate country geotargeting by setting country_code=us to use US proxies for example.
This parameter does not increase the cost of the API request. |
| premium | Activate premium residential and mobile IPs by setting premium=true. Using premium proxies costs 10 API credits, or 25 API credits if used in combination with Javascript rendering render=true. |
| session_number | Reuse the same proxy by setting session_number=123 for example. This parameter does not increase the cost of the API request. |
| keep_headers | Use your own custom headers by setting keep_headers=true along with sending your own headers to the API. This parameter does not increase the cost of the API request. |
| device_type | Set your requests to use mobile or desktop user agents by setting device_type=desktop or device_type=mobile. This parameter does not increase the cost of the API request. |
| autoparse | Activate auto parsing for select websites by setting autoparse=true. The API will parse the data on the page and return it in JSON format. This parameter does not increase the cost of the API request. |
| ultra_premium | Activate our advanced bypass mechanisms by setting ultra_premium=true.
Requests using this parameter cost 30 API credits, or 75 if used in combination with javascript rendering. |
Custom Headers
If you would like to use your own custom headers (user agents, cookies, etc.) when making a request to the website, simply set keep_headers=true and send the API the headers you want to use. The API will then use these headers when sending requests to the website.
Note: Only use this feature if you need to send custom headers to retrieve specific results from the website. Within the API we have a sophisticated header management system designed to increase success rates and performance on difficult sites. When you send your own custom headers you override our header system, which oftentimes lowers your success rates. Unless you absolutely need to send custom headers to get the data you need, we advise that you don’t use this functionality.
If you need to get results for mobile devices, use the device_type parameter to set the user-agent header for your request, instead of setting your own.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/anything&keep_headers=true";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection httpURLConnection = (HttpURLConnection) urlForGetRequest.openConnection();
httpURLConnection.setRequestProperty("Content-Type", "application/json");
httpURLConnection.setRequestProperty("X-MyHeader", "123");
httpURLConnection.setRequestMethod("GET");
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
try {
String apiKey = "APIKEY";
String proxy = "http://scrapenetwork.keep_headers=true:" + apiKey + "@proxy-server.scrapenetwork.com";
URL server = new URL("http://httpbin.org/anything");
Properties systemProperties = System.getProperties();
systemProperties.setProperty("http.proxyHost", proxy);
systemProperties.setProperty("http.proxyPort", "8001");
HttpURLConnection httpURLConnection = (HttpURLConnection) server.openConnection();
httpURLConnection.setRequestProperty("Content-Type", "application/json");
httpURLConnection.setRequestProperty("X-MyHeader", "123");
httpURLConnection.connect();
String readLine = null;
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Sessions
To reuse the same proxy for multiple requests, simply use the session_number parameter by setting it equal to a unique integer for every session you want to maintain (e.g. session_number=123). This will allow you to continue using the same proxy for each request with that session number. To create a new session simply set the session_number parameter with a new integer to the API. The session value can be any integer. Sessions expire 15 minutes after the last usage.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&session_number=123";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
try {
String apiKey = "APIKEY";
String proxy = "http://scrapenetwork.session_number=123:" + apiKey + "@proxy-server.scrapenetwork.com";
URL server = new URL("http://httpbin.org/ip");
Properties systemProperties = System.getProperties();
systemProperties.setProperty("http.proxyHost", proxy);
systemProperties.setProperty("http.proxyPort", "8001");
HttpURLConnection httpURLConnection = (HttpURLConnection) server.openConnection();
httpURLConnection.connect();
String readLine = null;
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Geographic Location
Certain websites (typically e-commerce stores and search engines) display different data to different users based on the geolocation of the IP used to make the request to the website. In cases like these, you can use the API’s geotargeting functionality to easily use proxies from the required country to retrieve the correct data from the website.
To control the geolocation of the IP used to make the request, simply set the country_code parameter to the country you want the proxy to be from and the API will automatically use the correct IP for that request.
For example: to ensure your requests come from the United States, set the country_code parameter to country_code=us.
Business and Enterprise Plan users can geotarget their requests to the following 13 regions (Hobby and Startup Plans can only use US and EU geotargeting) by using the country_code in their request:
| Country Code | Region | Plans |
|---|---|---|
| us | United States | Hobby Plan and higher. |
| eu | Europe | Hobby Plan and higher. |
| ca | Canada | Business Plan and higher. |
| uk | United Kingdom | Business Plan and higher. |
| ge | Germany | Business Plan and higher. |
| fr | France | Business Plan and higher. |
| es | Spain | Business Plan and higher. |
| br | Brazil | Business Plan and higher. |
| mx | Mexico | Business Plan and higher. |
| in | India | Business Plan and higher. |
| jp | Japan | Business Plan and higher. |
| cn | China | Business Plan and higher. |
| au | Australia | Business Plan and higher. |
Geotargeting “eu” will use IPs from any European country.
Other countries are available to Enterprise customers upon request.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&country_code=us";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&country_code=us";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Premium Residential/Mobile Proxy Pools
Our standard proxy pools include millions of proxies from over a dozen ISPs and should be sufficient for the vast majority of scraping jobs. However, for a few particularly difficult to scrape sites, we also maintain a private internal pool of residential and mobile IPs. This pool is only available to users on the Business plan or higher.
Requests through our premium residential and mobile pool are charged at 10 times the normal rate (every successful request will count as 10 API credits against your monthly limit). Each request that uses both javascript rendering and our premium proxy pools will be charged at 25 times the normal rate (every successful request will count as 25 API credits against your monthly limit). To send a request through our premium proxy pool, please set the premium query parameter to premium=true.
We also have a higher premium level that you can use for really tough targets, such as LinkedIn. You can access these pools by adding the ultra_premium=true query parameter. These requests will use 30 API credits against your monthly limit, or 75 if used together with rendering. Please note, this is only available on our paid plans.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&premium=true";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
try {
String apiKey = "APIKEY";
String proxy = "http://scrapenetwork.premium=true:" + apiKey + "@proxy-server.scrapenetwork.com";
URL server = new URL("http://httpbin.org/ip");
Properties systemProperties = System.getProperties();
systemProperties.setProperty("http.proxyHost", proxy);
systemProperties.setProperty("http.proxyPort", "8001");
HttpURLConnection httpURLConnection = (HttpURLConnection) server.openConnection();
httpURLConnection.connect();
String readLine = null;
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Device Type
If your use case requires you to exclusively use either desktop or mobile user agents in the headers it sends to the website then you can use the device_type parameter.
- Set
device_type=desktopto have the API set a desktop (e.g. iOS, Windows, or Linux) user agent. Note: This is the default behavior. Not setting the parameter will have the same effect. - Set
device_type=mobileto have the API set a mobile (e.g. iPhone or Android) user agent.
Note: The device type you set will be overridden if you use keep_headers=true and send your own user agent in the requests header.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com?api_key=" + apiKey + "&url=http://httpbin.org/ip&device_type=mobile";
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
try {
String apiKey = "APIKEY";
String proxy = "http://scrapenetwork.device_type=mobile:" + apiKey + "@proxy-server.scrapenetwork.com";
URL server = new URL("http://httpbin.org/ip");
Properties systemProperties = System.getProperties();
systemProperties.setProperty("http.proxyHost", proxy);
systemProperties.setProperty("http.proxyPort", "8001");
HttpURLConnection httpURLConnection = (HttpURLConnection) server.openConnection();
httpURLConnection.connect();
String readLine = null;
int responseCode = httpURLConnection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(httpURLConnection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
Account Information
If you would like to monitor your account usage and limits programmatically (how many concurrent requests you’re using, how many requests you’ve made, etc.) you may use the /account endpoint, which returns JSON.
Note: the requestCount and failedRequestCount numbers only refresh once every 15 seconds, while the concurrentRequests number is available in real-time.
try {
String apiKey = "APIKEY";
String url = "http://api.scrapenetwork.com/account?api_key=" + apiKey;
URL urlForGetRequest = new URL(url);
String readLine = null;
HttpURLConnection conection = (HttpURLConnection) urlForGetRequest.openConnection();
conection.setRequestMethod("GET");
int responseCode = conection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
BufferedReader in = new BufferedReader(new InputStreamReader(conection.getInputStream()));
StringBuffer response = new StringBuffer();
while ((readLine = in.readLine()) != null) {
response.append(readLine);
}
in.close();
System.out.println(response.toString());
} else {
throw new Exception("Error in API Call");
}
} catch (Exception ex) {
ex.printStackTrace();
}
