Supported Parameters

We support a range of parameters, that allow you to fine-tune request behavior by enabling JS Rendering, geotargeting, sending custom headers, using sticky IPs, device emulation, residential proxies, advanced unblocking mechanisms and more. These help you scrape domains with stricter protection.

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 JS content has been rendered.

Requests using this parameter cost 10 API credits, or 75 if used in combination with ultra_premium=true.

wait_for_selector

The wait_for_selector parameter instructs the API to wait until a specific element appears on the page before returning the response. This parameter must be used in combination with render=true and will not work if specified on its own.

screenshot

screenshot=true - Gives you the ability to take a screenshot of the target page. This parameter automatically enables JS rendering to get the full page content, before a screenshot is taken.

country_code

Activate country geotargeting. For example setting country_code=us will instruct the API to use US proxies. You can find list of supported countries here. This parameter does not increase the cost of the API request.

premium

Activate 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. (Can not be combined with ultra_premium).

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. (Can not be combined with premium).

session_number

Reuse the same proxy by setting session_number=123 for example.

This parameter does not increase the cost of the API request. (Can not be combined with premium/ultra_premium).

keep_headers

Tell the API to use your custom headers with the request by setting keep_headers=true .

This parameter does not increase the cost of the API request.

device_type

Set your requests to use mobile or desktop User Agent by setting device_type=desktop (default) or device_type=mobile.

This parameter does not increase the cost of the API request.

autoparse

Activate auto parsing for selected 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.

output_format

The output_format parameter allows you to instruct the API on what the response file type should be. Valid options:

  • markdown

  • text

SDEs valid options:

  • json

  • csv

  • markdown

  • text

follow_redirect

This parameter tells our API if you want to follow a redirect that a website might respond with. Default value is true. This parameter does not increase the cost of the API request.

Last updated