Learn how to customize ScraperAPI requests in Ruby with JavaScript rendering, geotargeting, sessions, headers, parsing, and output format. Maximize scraping flexibility.
Last updated
Was this helpful?
ScraperAPI enables you to customize the API’s functionality by adding additional parameters to your requests. The API will accept the following parameters:
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.
screenshot
Gves you the ability to take a screenshot of the target page through the use of the parameter screenshot=true. This parameter automatically enables JS rendering to get the full page content, before taking a screenshot.
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.
binary_target
Helpful when trying to scrape files or images. This tells our API that the target is a file.
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.
output_format
The output_format parameter allows you to instruct the API on what the response file type should be. Valid options:
markdown
text
valid options:
json
csv
markdown
text