Advanced Functionality List

The ScrapeOps Proxy API Aggregator enables you to use the more advanced functionality of our underlying proxy providers by adding additional parameters to your requests. The API will accept the following parameters:

Parameter	Description
`optimize_request`	Request with request optimization enabled. Example: `optimize_request=true`
`max_request_cost`	Used in conjunction with `optimize_request` to set the maximum number of API credits a request can use. Example: `max_request_cost=30`
`bypass`	Request with anti-bot bypass enabled. List of bypasses. Example: `bypass=cloudflare_level_1`
`auto_extract`	Use maintained parsers to automatically extract data from HTML and return data in JSON format. List of parsers. Example: `auto_extract=amazon`
`render_js`	Request with Javascript rendering enabled. Example: `render_js=true`
`wait`	Tell headless browser to wait a specfic period of time before returning response. Example: `wait=3000`
`wait_for`	Tell headless browser to wait a specfic page element to appear before returning response. Example: `wait_for=.loading-done`
`scroll`	Tell headless browser to scroll the page down a defined number of pixels before returning the response. Example: `scroll=5000`
`file_type`	Specify the type of file being requested to optimize proxy selection. Example: `file_type=pdf`
`screenshot`	Tell the headless browser to take a screenshot of the rendered page. The screenshot will be returned in a base64 encoded string. Parameters needed: `screenshot=true&render_js=true&json_response=true`. Docs
`js_scenario`	Send a sequence of commands to a headless browser before returning the response. Examples
`premium`	Request using premium proxy pools. Example: `premium=level_1` or `premium=level_2`. See Premium Proxies documentation for more details.
`residential`	Request using residential proxy pools. Example: `residential=true`
`mobile`	Request using mobile proxy pools. Example: `mobile=true`
`country`	Make requests from specific country. Example: `country=us`
`keep_headers`	Use your own custom headers when making the request. Example: `keep_headers=true`
`device_type`	Tell API to use desktop vs mobile user-agents when making requests. Default is `desktop`. Example: `device_type=mobile`
`session_number`	Enable sticky sessions that use the same IP address for multiple requests by setting a `session_number`. Example: `session_number=7`
`follow_redirects`	Tell API to not follow redirects by setting `follow_redirects=false`.
`initial_status_code`	Tell API to return the inital status code the website responses with in the headers by setting `initial_status_code=true`.
`final_status_code`	Tell API to return the final status code the website responses with in the headers by setting `final_status_code=true`.

Certain advanced functionality consumes more than 1 API credit. To see how much each request will consume then check out this list of request costs.