Oxylabs Documentation
English
Search…
⌃K

Global Parameter Values

Below is the list of global parameter values which work the same way in all data sources. On the right side menu you can see the full list of parameters and click on any of them to jump to its section.

Callback_url

A callback is a POST request that we send to your machine, informing you that the data extraction task is completed and the result is ready to be downloaded. A callback URL, in turn, is the URL we will send the POST request to.

Parameter values

Use the callback_url parameter to specify the URL where we should POST our notification to.

Render

The render parameter lets you enable JavaScript execution. Use it when the target website requires JavaScript to load the necessary content or when the site uses an anti-bot tool that utilizes JavaScript to fingerprint their visitors.
NB: render only works via Push-Pull (a.k.a. Callback) method.

Parameter values

There are two available values for this parameter: html (get raw output) and png (get a Base64-encoded screenshot).
Value
Description
html
The output will include an HTML result.
png
The output will include a PNG screenshot of the result.

Source

source parameter is one of the most important parameters. It sets the scraper that we will use to process your request (e.g. google_search, baidu, etc.).

Parameter values

You can find the exact source parameter value on the documentation page of the domain of your choice.
The section below outlines the product-domain-source relationships.
E-Commerce Scraper API
Domain
Sources
Amazon
amazon, amazon_bestsellers, amazon_pricing, amazon_product, amazon_questions, amazon_reviews, amazon_search, amazon_sellers
google, google_shopping_search, google_shopping_product, google_shopping_pricing
Idealo
idealo, idealo_search, idealo_product
Wayfair
wayfair, wayfair_search
universal_ecommerce
SERP Scraper API
Domain
Sources
Google
google, google_search, google_ads, google_hotels, google_travel_hotels, google_images, google_suggest, google_msv_v2
Yandex
yandex, yandex_search
Bing
bing, bing_search
Baidu
baidu, baidu_search
Real Estate Scraper API
Domain
Sources
universal
Web Scraper API
Domain
Sources
universal

User_agent_type

The user_agent_type parameter lets you specify what kind of a User-Agent header value we should use to fulfil your request.
You can find a complete list of available values in the attachment or in the table below.
user_agent_type.json
1KB
Code
user_agent_type parameter values

Parameter values

Value
Description
desktop
A User-Agent of a desktop browser.
desktop_chrome
A User-Agent of one of the latest versions of a desktop Chrome browser.
desktop_edge
A User-Agent of one of the latest versions of a desktop Edge browser.
desktop_firefox
A User-Agent of one of the latest versions of a desktop Firefox browser.
desktop_opera
A User-Agent of one of the latest versions of a desktop Opera browser.
desktop_safari
A User-Agent of one of the latest versions of a desktop Safari browser.
mobile
A User-Agent of a mobile browser.
mobile_android
A User-Agent of one of the latest versions of an Android mobile browser.
mobile_ios
A User-Agent of one of the latest versions of an iOS browser.
tablet
A User-Agent of a tablet browser.
tablet_android
A User-Agent of one of the latest versions of an Android tablet browser.
tablet_ios
A User-Agent of one of the latest versions of an iPad tablet browser.