API Parameters

Discover the full power of BrowserAPI by passing advanced parameters to your requests.

Parameters are being used to customize each request to the API. Understanding how to use these parameters will allow you to reach the full potential of the BrowserAPI and better interact with the targeted URL.

Because BrowserAPI offers high-level customization it will no longer have complete control over the scraping performance, so using this feature means charging 100% of the requests (both successful and failed).

Below is a list of all the parameters available in our API:

#1: Required Parameters

Parameter	Type	Description	More
api_key Required	string	Used for authentication	learn
url Required	string	Specify the URL of the web page you would like to scrape. IMPORTANT: Please make sure you URL encode the value of this parameter!	learn

#2: Optional Parameters

Parameter	Type	Description	More
country	string	Specify the 2-letter code of the country you would like to use as a proxy geolocation for your scraping API request. Please refer to the Geolocation section for details.	learn
timeout	int	Specify the maximum timeout in milliseconds you would like to use for your scraping API request. In order to force a timeout, you can specify a number such as 1000. This will abort the request after 1000ms and throw an error. The maximum value for this parameter is 120000. The default value for this parameter is also 120000.	learn
device	string	Set desktop (default), mobile or tablet, depending on whether the device type you want to your for your scraping request.	learn
wait_until	string	Specify the option you would like to use as conditional for your scraping API request. *Can only be used when the parameter render_js=1 is activated.	learn
wait_for	int	Some websites may use JavaScript frameworks that may require a few extra seconds to load their content. This parameters specifies the time in milliseconds to wait for the website. Recommended values are in the interval 5000 - 10000. *Can only be used when the parameter render_js=1 is activated.	learn
wait_for_css	string	Specify a CSS selector and the API will wait 10 seconds (the default value of the timeout parameter) until the selector appears. *Can only be used when the parameter render_js=1 is activated.	learn
window_width	int	Adjust the width of the web browser's Viewport. *Can only be used when the parameter render_js=1 is activated.	learn
window_height	int	Adjust the height of the web browser's Viewport. *Can only be used when the parameter render_js=1 is activated.	learn
screenshot	boolean	Set to 1 to get the scraped website as a screenshot. *Can only be used when the parameter render_js=1 is activated.	learn
screenshot_options	object	Of type object , this parameter is used to set the screenshot to return custom window sizing, full page or single CSS selector. *Can only be used when the parameter screenshot=1 is activated	learn
extract_rules	object	Get the scraped website based on various extraction rules.	learn
json_response	boolean	Have the API return an JSON object instead of the plain HTML scraped from the URL.	learn
json_dom	boolean	Get the scraped website in JSON format. It can be set to 0 (default) or 1.	learn
js_instructions	object	Perform JavaScript instructions before obtaining the scraped website. *Can only be used when the parameter screenshot=1 is activated	learn
block_resources	string	Block web browser's resources (i.e. block_resources=media,js) *Can only be used when the parameter render_js=1 is activated	learn
session	int	Set depending on whether or not to use the same proxy address to your request.	learn
cookies	object	Add custom cookies to your request. *It only works when the parameter render_js=1 is activated. If you want to add custom cookies when render_js=0 follow this link	learn
auto_solve	boolean	Enables the automatic Captcha solving. *Can only be used when the parameter render_js=1 is activated.	learn

For boolean parameters, you can provide values in multiple formats. If the parameter is set to '0' or 'false', it will be treated as false, meaning the feature will be disabled or set to off. If you send '1' or 'true', the parameter will be interpreted as true, enabling or turning on the feature. The system recognizes both numeric and string representations of boolean values for flexibility in different use cases.