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
#2: Optional Parameters
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.
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 (and default) value for this parameter is 120000
.
device
string
Set desktop
(default), mobile
or tablet
, depending on whether the device type you want to your for your scraping request.
wait_until
string
Specify the option you would like to use as conditional for your scraping API request. Possible values are domcontentloaded
(default), load
, networkidle0
and networkidle2
.
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. Possible values for this parameter are in the range [100, 60000].
wait_for_css
string
Specify a CSS selector and the API will wait timeout
seconds until the selector appears. The default value of the timeout
is 120000.
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
json_response
boolean
Have the API return an JSON object instead of the plain HTML scraped from the URL.
Last updated