Parameters
Web Scraping API Parameters
Parameters supported by Web Scraping API solution
Supported parameters differ for Core and Advanced plan users. Find a more detailed comparison here.
Note that supported parameters may vary slightly depending on the target template. Read more.
Parameter | Default value | Description | Example | Core |
---|---|---|---|---|
|
| Mandatory.
Some target templates support |
| ✅ Only |
|
| Necessary for specific target templates |
| |
|
| Enable JavaScript rendering.
Supported:
– |
| |
| auto-randomized | The geographical location on which the result depends. Read more. |
| ✅ Supported geo locations:
|
|
| Specify top-level domain: com, co.uk, fr, etc. |
| |
| Matched with | This will change the search page web interface language (not the results). Example: – en-US – en-GB |
| |
|
| Adds request headers to the target request. |
| |
|
| Client cookie. Allows users to open up pages as if they are logged in. |
| |
|
| By default, user-provided cookies are not forwarded to the target. Set this parameter to |
| |
|
| By default, user-provided headers are not forwarded to the target. Set this parameter to |
| |
|
| Device type and browser. Supported: – desktop – desktop_chrome – desktop_firefox – mobile – mobile_android – mobile_ios |
| |
|
| For certain target templates dedicated parsers are available. To retrieve structured data, set
|
| |
|
| Session to re-use the same IP for multiple requests for up to 10 minutes |
| |
|
| Used to make a |
| ✅ |
|
| Base64 encoded |
| ✅ |
|
| Define one or more |
| ✅ |
|
| Parses HTML output into Markdown. Results in less tokens when feeding results into LLM models. Read more. |
| |
|
| Retrieves a list of XHR and fetch requests.Read more. |
|
Support
Still can't find an answer? Want to say hi? We take pride in our 24/7 customer support. Alternatively, you can reach us via our support email at [email protected].
Updated 4 days ago