logo

Plugins

View as Markdown

Use structured scraping plugins with the Async API for bulk data extraction

Plugins let you extract structured data from supported platforms using the Async API. Instead of sending raw URLs, you specify a plugin key and parameters for each task; the API handles session management, geo-targeting, and response parsing automatically.


Request Structure

POST https://q.scrape.do/api/v1/jobs
X-Token: YOUR_TOKEN
Content-Type: application/json
{
  "Plugin": {
    "Key": "<plugin_key>",
    "Params": [
      { "param1": "value1", "param2": "value2" },
      { "param1": "value3", "param2": "value4" }
    ]
  },
  "GeoCode": "us",
  "WebhookURL": "https://example.com/webhook",
  "WebhookHeaders": { "Authorization": "Bearer your-token" }
}

Targets and Plugin are mutually exclusive. Using both returns 400 Bad Request. Each entry in Params becomes one task in the job. Maximum 1000 params per job.

Param Values

Each key in a Params entry is sent to the plugin as one query parameter.

Value typeHow it is sent
StringAs-is
NumberExact text as written (2619533011 stays 2619533011, never 2.619533011e+09)
Booleantrue / false
nullTreated as "not set"; the param is left out
Array / objectRejected with 400. Send lists as a comma-separated string, e.g. "hotel_class": "4,5"
  • Send ZIP codes and store IDs with leading zeros as strings ("02134", "0595"). As a JSON number they lose the zero.
  • token, async and proxy_key are reserved (in any casing) and rejected with 400. The API sets them on every request, and the job's token is always the one billed.
  • Two keys in one entry that differ only in case (hl and HL) are rejected with 400. Use the lowercase form documented below; some plugins (google/lens) read keys case-sensitively.

HTTP Method

Plugin jobs use GET by default. Only lowes/store also accepts "Method": "POST"; every other method/key combination returns 400 at job creation. The job-level Body is sent with every task in the job.


Supported Plugins

Use the page sidebar to jump to a specific plugin's section.

KeyPlatformOutputDescription
amazon/pdpAmazonStructured JSONProduct Detail Page
amazon/searchAmazonStructured JSONSearch results
amazon/offer-listingAmazonStructured JSONAll seller offers
amazon/dealsAmazonStructured JSONDiscounted product grid
amazon/bestsellersAmazonStructured JSONBest Sellers / New Releases chart
amazon/sellerAmazonStructured JSONSeller profile
amazonAmazonHTMLRaw page fetched for a ZIP code
walmart/storeWalmartHTML / JSONStore-scoped request
walmart/searchWalmartStructured JSONSearch results
walmart/productWalmartStructured JSONProduct detail
samsclub/storeSam's ClubHTML / JSONClub-scoped request
lowes/storeLowesHTML / JSONStore-scoped request
homedepot/productHome DepotHTML / JSONStore-scoped product request
homedepot/storesHome DepotStructured JSONStore locator
google/searchGoogleStructured JSONSERP results
google/search/ai-modeGoogleStructured JSONAI Mode (udm=50) response
google/shoppingGoogleStructured JSONShopping product results
google/shopping/productGoogleStructured JSONFull product page and sellers
google/shopping/product/storesGoogleStructured JSONNext batch of sellers (continuation)
google/maps/searchGoogleStructured JSONMaps places list
google/maps/placeGoogleStructured JSONMaps place details
google/maps/reviewsGoogleStructured JSONPaginated place reviews
google/hotelsGoogleStructured JSONHotels listings
google/hotels/detailGoogleStructured JSONPer-vendor offer shelf for one property
google/flightsGoogleStructured JSONFlights itineraries + price insights
google/newsGoogleStructured JSONNews articles, topics, clusters
google/trendsGoogleStructured JSONTrends data for a keyword
google/trendingGoogleStructured JSONCurrently trending searches
google/youtubeGoogleStructured JSONYouTube search results
google/youtube/videoGoogleStructured JSONYouTube video detail
google/lensGoogleStructured JSONImage search
google/foodGoogleStructured JSONRestaurant pickup / delivery providers
google/play-storeGoogleStructured JSONPlay Store app search
google/play-store/productGoogleStructured JSONPlay Store app detail page
google/play-store/reviewsGoogleStructured JSONPlay Store app reviews
chatgpt/chatOpenAIStructured JSONChatGPT reply for a prompt
chatgpt/v2/chatOpenAIStructured JSONChatGPT reply (ads-capable route)
gemini/chatGoogleStructured JSONGemini reply for a prompt
naver/ai-searchNaverStructured JSONNaver AI search answer
waze/alertsWazeStructured JSONTraffic alerts in a bounding box
carrefour/searchCarrefourStructured JSONSearch results
carrefour/productCarrefourStructured JSONProduct detail
carrefour/rapid/searchCarrefourStructured JSONSearch results (rapid delivery catalogue)
carrefour/rapid/productCarrefourStructured JSONProduct detail (rapid delivery catalogue)
sheinSheinHTMLProduct page
trip/searchTrip.comStructured JSONFlight search
trip/detailTrip.comStructured JSONFare detail

google/search/ai-overview is not available as an Async API plugin: it needs a short-lived session_key from a previous google/search call. To get a deferred AI Overview in an async job, set await_ai_overview=true on google/search instead.


Amazon Plugins

amazon/pdp - Product Detail Page

Returns structured JSON with price, images, rating, buy box, reviews, BSR, and more.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/pdp",
      "Params": [
        { "asin": "B0CQMTCR9T", "zipcode": "32095", "geocode": "us" },
        { "asin": "B0DFK5Y3PQ", "zipcode": "10001", "geocode": "us" }
      ]
    }
  }'
ParamRequiredDescription
asinyesAmazon ASIN (10 chars)
geocode (alias country)yesMarketplace country code (us, gb, de, etc.)
zipcode or countryNamenoLocalizes price and availability to a delivery location. Pass at most one. zipcode for marketplaces with ZIP-level delivery (10001 for us, EC1A 1BB for gb, …); countryName otherwise. Validated only when set.
languagenoDisplay language ISO-2 (EN, DE, FR, …). Must be supported for the chosen marketplace.
currencynoISO-4217 display currency
devicenodesktop (default) or mobile
supernotrue for premium proxies
include_htmlnotrue to include raw HTML in response

amazon/search - Search Results

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/search",
      "Params": [
        { "keyword": "wireless earbuds", "zipcode": "32095", "geocode": "us" },
        { "keyword": "wireless earbuds", "zipcode": "32095", "geocode": "us", "page": 2 }
      ]
    }
  }'
ParamRequiredDescription
keywordyesSearch query
geocodeyesMarketplace country code
zipcode or countryNamenoLocalizes price and availability. Pass at most one. Validated only when set.
pagenoPage number ≥1 (default 1)
nodenoCategory node ID (string or integer)
low_price / high_pricenoPrice bounds
s / rh / inoRaw Amazon sort key, refinement string and search index (department)
field-keywordsnoRaw Amazon keyword field
sellernoRestrict results to one seller ID
languagenoDisplay language ISO-2. Must be supported for the chosen marketplace.
currencynoISO-4217 display currency
devicenodesktop (default) or mobile
supernotrue for premium proxies
include_htmlnotrue to include raw HTML

amazon/offer-listing - All Seller Offers

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/offer-listing",
      "Params": [
        { "asin": "B0CQMTCR9T", "zipcode": "32095", "geocode": "us" }
      ]
    }
  }'
ParamRequiredDescription
asinyesAmazon ASIN
geocodeyesMarketplace country code
zipcode or countryNamenoLocalizes price and availability. Pass at most one. Validated only when set.
pagenoOffer page, clamped to 1–50
languagenoDisplay language ISO-2
currencynoISO-4217 display currency
devicenodesktop (default) or mobile
supernotrue for premium proxies
include_htmlnotrue to include raw HTML

amazon/deals - Discounted Products

Returns the discounted product grid for a marketplace, optionally narrowed to a category node and price range.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/deals",
      "Params": [
        { "geocode": "us" },
        { "geocode": "us", "node": "172282", "low_price": 20, "high_price": 100, "sort_by": "price_low_to_high" }
      ]
    }
  }'
ParamRequiredDescription
geocodeyes (or set top-level GeoCode)Marketplace country code. Deals are currently available for us only; other marketplaces return 400.
nodenoCategory node ID. Without it the grid spans the whole marketplace.
low_price / high_pricenoPrice bounds (digits, max two decimals)
sort_bynoe.g. relevance, price_low_to_high, average_review, newest_arrivals
pageno1–20 (default 1)
zipcode or countryNamenoLocalizes prices to a delivery location. Pass at most one.
rh / i / snoRaw Amazon refinement, search index and sort keys
amazon_domainnoMarketplace domain (e.g. amazon.com), an alternative to geocode
language / currency / devicenoDisplay language, ISO-4217 currency, desktop (default) or mobile
supernotrue for premium proxies
include_htmlnotrue to include raw HTML

amazon/bestsellers - Best Sellers Chart

Returns the Best Sellers (or New Releases) ranking for a category.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/bestsellers",
      "Params": [
        { "category": "electronics", "geocode": "us" },
        { "category": "electronics", "geocode": "us", "page": 2, "type": "new-releases" }
      ]
    }
  }'
ParamRequiredDescription
categoryyesCategory slug, e.g. electronics. Slugs are marketplace-specific.
geocodeyesMarketplace country code
typenobestsellers (default) or new-releases
nodenoCategory node ID, narrowing the chart to a sub-category
pageno1 (positions 1–50) or 2 (51–100)
load_morenotrue to also fetch the positions Amazon loads on scroll. Costs twice a standard request.
zipcode or countryNamenoLocalizes prices to a delivery location. Pass at most one.
amazon_domainnoMarketplace domain (e.g. amazon.de), an alternative to geocode
language / currencynoDisplay language and ISO-4217 currency
supernotrue for premium proxies
include_htmlnotrue to include raw HTML

The Best Sellers chart is desktop-only. device=mobile returns 400 for this key.


amazon/seller - Seller Profile

Returns the seller's display name, description, rating summary and business details. Pairs with amazon/offer-listing, which reports the seller IDs offering an ASIN.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon/seller",
      "Params": [
        { "seller": "A2L77EE7U53NWQ", "geocode": "us" },
        { "seller": "AOPPU1CKKHCUB", "geocode": "de" }
      ]
    }
  }'
ParamRequiredDescription
selleryesAmazon seller ID, e.g. A2L77EE7U53NWQ
geocodeyesMarketplace country code
zipcode or countryNamenoLocalizes the page to a delivery location. Pass at most one.
amazon_domainnoMarketplace domain (e.g. amazon.de), an alternative to geocode
language / currency / devicenoDisplay language, ISO-4217 currency, desktop (default) or mobile
supernotrue for premium proxies
include_htmlnotrue to include raw HTML

amazon - Raw HTML

Returns the raw Amazon HTML for any Amazon URL, rendered from the perspective of a ZIP code. Use it when the structured plugins do not cover the page you need.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "amazon",
      "Params": [
        { "url": "https://www.amazon.com/dp/B0CQMTCR9T", "zipcode": "32095", "geocode": "us" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull Amazon URL (must be an amazon.* domain)
geocodeyesMarketplace country code
zipcode or country_namenoDelivery location. country_name applies where ZIP-level delivery does not. Validated only when set.
language / currencynoDisplay language and currency
devicenodesktop (default) or mobile
supernotrue for premium proxies
timeoutnoPer-request timeout in ms

This key always returns HTML. The top-level Output field is ignored for plugin jobs.


Walmart, Sam's Club, Lowes & Home Depot Plugins

These keys read no geo parameter, so a top-level GeoCode returns 400. Select the location with each plugin's own params (zipcode, storeid, store, clubid).

walmart/store - Store-Scoped Request

Fetches a Walmart URL with store-specific session cookies. Raw HTML response.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "walmart/store",
      "Params": [
        { "url": "https://www.walmart.com/ip/123456", "zipcode": "72712", "storeid": "100" },
        { "url": "https://www.walmart.com/ip/789012" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull Walmart URL (must be walmart domain)
zipcodeconditionalRequired with storeid, or omit both for a random store
storeidconditionalRequired with zipcode, or omit both for a random store. On walmart.ca, storeid alone is accepted.
disableretrynotrue to disable retry logic
transparentresponsenotrue to return raw response
timeoutnoCustom timeout in ms

walmart/search - Search Results

Returns structured search results (US only), scoped to a store or ZIP. Sponsored items are flagged "sponsored": true.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "walmart/search",
      "Params": [
        { "q": "laptop", "zipcode": "10001" },
        { "q": "laptop", "store": "925", "page": 2 }
      ]
    }
  }'
ParamRequiredDescription
q (alias query)yesSearch keyword
zipcode or storeyesPass exactly one. zipcode: 5-digit US ZIP. store: numeric store ID covered by the plugin (unknown IDs return 400).
pageno1–100 (default 1)
timeoutnoTimeout in ms (capped at the system maximum)

walmart/product - Product Detail

Returns structured product detail (US only), scoped to a store or ZIP.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "walmart/product",
      "Params": [
        { "item": "15586351437", "zipcode": "10001" },
        { "item": "15586351437", "store": "925" }
      ]
    }
  }'
ParamRequiredDescription
itemyesNumeric Walmart item ID (results[].item_id from walmart/search)
zipcode or storeyesPass exactly one. Same rules as walmart/search.
timeoutnoTimeout in ms (capped at the system maximum)

samsclub/store - Club-Scoped Request

Fetches a Sam's Club URL with club-specific session cookies. Returns the upstream body as-is: HTML for pages, JSON for Sam's Club API endpoints.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "samsclub/store",
      "Params": [
        { "url": "https://www.samsclub.com/ip/13791994380", "zipcode": "77065", "clubid": "8274" },
        { "url": "https://www.samsclub.com/s/coffee" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull samsclub.com URL (product, category, search or API)
zipcodeconditional5-digit US ZIP. Send together with clubid, or omit both for a random club.
clubid (alias storeid)conditionalClub number matching the ZIP. An invalid ZIP/club pair returns 400.
disableretrynotrue to disable retry logic
transparentresponsenotrue to return a partial body on timeout (instead of 502)
timeoutnoTimeout in ms

lowes/store - Store-Scoped Request

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "lowes/store",
      "Params": [
        { "url": "https://www.lowes.com/pd/item/123", "zipcode": "28202", "storeid": "0595" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull Lowes URL on lowes.com. Must match an accepted path pattern (see below).
zipcodeyesNumeric zip code (digits only)
storeidyesNumeric Lowes store ID (digits only). Send as a string to keep leading zeros.
disableretrynotrue to disable retry logic
timeoutnoPer-request timeout in ms (default: system max)

Accepted URL patterns:

PatternExample
/pd/<slug>/<itemId>https://www.lowes.com/pd/Disney-Airblown-Holiday-Stitch/5016066683
/wpd/<itemId>/productdetail/<storeId>/<auth>/<zipCode>https://www.lowes.com/wpd/1000002288/productdetail/0208/Guest/92253
/<2-letter-state>/<category>/<id>/productshttps://www.lowes.com/pl/power-tools/4294607842/products
/search…https://www.lowes.com/search?searchTerm=socket+holder
/collections/api/items/<groupId>/COLL_MANDATORY/<storeId>/<auth>/<zipCode>(Collections API)
/purchase/api/cart/cartitemsCart-add API endpoint

URLs that don't match return 400 valid lowes url expected. For /wpd/… URLs, the <storeId> and <zipCode> path segments must match the storeid and zipcode params exactly, otherwise the task fails with 400 valid lowes url expected and the message Please ensure that url match with the provided zipcode and storeid parameters.

Response shape depends on the URL pattern. /pd/… and /search… return rendered HTML, while /wpd/… and /pl/…/products return JSON from Lowes' own product APIs (productDetails and a paginated item list respectively).

URL and store validation happens per task, not at job creation. A job with an invalid URL, a missing zipcode, or a missing storeid is still accepted with 200 Job created successfully; the individual task then finishes with Status: "error" and a 400 body such as {"error":"zipcode is required"}. Always check task status, not just job status.

lowes/store is the only plugin that accepts "Method": "POST" (cart-add and similar endpoints). The job-level Body is sent with every task and is always sent as content-type: application/json.


homedepot/product - Store-Scoped Product Request

Fetches a Home Depot URL for a specific store and returns the upstream body as-is.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "homedepot/product",
      "Params": [
        { "url": "https://www.homedepot.com/p/315183357", "zipcode": "30339", "storeid": "0121" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull homedepot.com URL
zipcodeyesZIP code (digits only)
storeidyesStore ID (digits only, e.g. from homedepot/stores)
disableretrynotrue to disable retry logic
timeoutnoTimeout in ms (capped at the system maximum)

homedepot/stores - Store Locator

Returns Home Depot stores near a ZIP code or coordinates: store ID, name, phone, distance and address.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "homedepot/stores",
      "Params": [
        { "zipcode": "02134" },
        { "lat": "33.7490", "lng": "-84.3880", "pagesize": 5 }
      ]
    }
  }'
ParamRequiredDescription
zipcode or lat + lngyesZIP code (digits only), or both coordinates
pagesizenoNumber of stores (default 20)
disableretrynotrue to disable retry logic
timeoutnoTimeout in ms (capped at the system maximum)

Google Plugins

All Google plugins return structured JSON and use premium proxies internally — no super flag needed.

google/search - SERP Results

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/search",
      "Params": [
        { "q": "web scraping api", "gl": "us", "hl": "en" },
        { "q": "web scraping api", "gl": "gb", "hl": "en", "start": 10 }
      ]
    }
  }'
ParamRequiredDescription
qyes (or url)Search query
urlnoA full Google search URL instead of q. See url mode below.
glnoCountry code (default us)
hlnoLanguage code (default en)
google_domainnoGoogle domain (default google.com)
location / uulenoLocation targeting (UULE overrides location)
devicenodesktop (default) or mobile
startnoResult offset, 0–100 (default 0)
safenoactive to enable SafeSearch
time_periodnoTime filter
nfprnotrue to disable autocorrection
lr / crnoLanguage restrict (lang_tr) / country restrict (countryTR)
filterno0 to disable the similar/omitted results filter
tbsnoRaw Google tbs filter string
ludocidnoGoogle local business ID (send as a string)
include_htmlnotrue to include raw HTML
resolvegotonoDefault true: Google /goto?url= redirect links are replaced with their destination. false keeps them.
await_ai_overviewnotrue to wait for a deferred AI Overview and return it in the same response. 5 extra credits, charged only when the AI Overview is returned.
cachenofalse skips the result cache and fetches a fresh page (no_cache=true is the older form)
validateresultnotrue checks the returned page against the query and reports the verdict in the task's response headers (Scrape.do-Validation-*)

url mode. When an entry has url and no q, every Google parameter is read from inside url. The only params allowed next to it are device, include_html, resolvegoto, await_ai_overview, cache, no_cache and validateresult (keys are case-insensitive). Anything else (gl, hl, start, …), or a top-level GeoCode, returns 400 at job creation. Put gl inside the url instead.

Pagination runs in order. Tasks in one job that share every parameter except start are treated as pages of the same search. They run one at a time in ascending start order; each page starts after the previous one finishes (success or error). Tasks without start, and different searches, still run in parallel.


google/search/ai-mode - AI Mode

Returns Google's AI Mode (udm=50) response — ordered text blocks, source references, and shopping cards.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/search/ai-mode",
      "Params": [
        { "q": "best web scraping tools 2025", "gl": "us" },
        { "q": "how does web scraping work", "gl": "gb", "hl": "en" }
      ]
    }
  }'
ParamRequiredDescription
qyesSearch query (max 4096 bytes)
gl / hl / google_domainnoStandard localization
location / uulenoLocation targeting (UULE overrides location)
devicenodesktop or mobile
safenoactive to enable SafeSearch
include_htmlnotrue to include raw AI Mode HTML
resolvegotonoDefault true: redirect links in references are replaced with their destination. false keeps them.

google/shopping - Shopping Products

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/shopping",
      "Params": [
        { "q": "laptop", "min_price": 500, "max_price": 1500 },
        { "q": "wireless headphones", "sort_by": 1, "free_shipping": true }
      ]
    }
  }'
ParamRequiredDescription
qyesSearch query
min_price / max_pricenoPrice range filter (integer)
sort_byno0 relevance, 1 price asc, 2 price desc
free_shipping / on_salenoBoolean filters
shoprsnoOpaque filter token from a previous response. Individual params take precedence when both are set.
devicenodesktop or mobile
startnoPagination offset
hl / gl / google_domain / location / uulenoStandard localization

Each result carries a catalog_id (durable, persistable) and an immersive_product_page_token (short-lived) — pass either to google/shopping/product to expand a product.


google/shopping/product - Product Page

Returns the full product page: title, brand, gallery, description, ratings, sellers, and a next_page_token for paginating the rest of the sellers.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/shopping/product",
      "Params": [
        { "catalog_id": "12153035126592663857", "q": "PodTrak P8 ZP8", "gl": "us" },
        { "immersive_product_page_token": "eyJlaSI6...", "more_stores": true }
      ]
    }
  }'
ParamRequiredDescription
catalog_id*Region-scoped, durable catalog ID (digits; send as a string)
product_id*Product ID from a google/shopping result (send as a string)
immersive_product_page_token (alias page_token)*Short-lived (~hours). Returned by google/shopping.
qnoOriginal search query (relevance hint)
gpcidnoOffer cluster ID. Only with catalog_id; not combinable with sort_by or all_stores.
pvfnoToken mode only. Narrows sellers to one variant (from product_results.variants[].options[].pvf).
more_storesnoToken mode only. Widens the seller list from ~5 to ~10.
all_storesnotrue returns up to ~100 sellers in one call
sort_bynoSeller sort: base_price, total_price, promotion, seller_rating
include_htmlnotrue to include raw HTML
devicenodesktop (default), mobile, tablet
hl / gl / google_domain / location / uulenoStandard localization. With a token, locale defaults to the token's; an explicit value wins.

One of catalog_id, product_id, or immersive_product_page_token is required. When multiple are supplied, precedence is catalog_id > product_id > immersive_product_page_token. Catalog IDs are region-specific — if you need US, DE, and FR sellers for the same product, search once per region and persist each catalog_id.


google/shopping/product/stores - More Sellers

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/shopping/product/stores",
      "Params": [
        { "catalog_id": "17422476796203286923", "next_page_token": "eyJ2Ijoic3RvcmVzLTEi..." }
      ]
    }
  }'
ParamRequiredDescription
catalog_idyesSame catalog ID used to fetch the product page. Must match the catalog_id encoded inside the token — mismatch returns 400.
next_page_tokenyesproduct_results.next_page_token from a google/shopping/product response, or the token from a previous stores response. Tokens from gpcid requests are rejected.

The locale (q, gl, hl) is carried inside next_page_token. Any hl / gl values you pass here are ignored in favor of the token-embedded ones so the response stays deterministic across replays. For the same reason, a top-level GeoCode returns 400 for this key.


google/maps/search - Maps Places List

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/maps/search",
      "Params": [
        { "q": "pizza new york", "ll": "@40.7128,-74.0060,13z" },
        { "q": "hotels chicago", "start": 20, "hl": "en", "gl": "us" }
      ]
    }
  }'
ParamRequiredDescription
qyesSearch query
llnoLat/lng/zoom pin: @lat,lng,zoomz
startnoPage offset: a non-negative multiple of 20, up to 100
hl / gl / google_domainnoStandard localization

google/maps/place - Maps Place Details

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/maps/place",
      "Params": [
        { "place_id": "ChIJLSsVbGBZwokRR0LlGBSvMOI" },
        { "data_cid": "16313085445244584615" }
      ]
    }
  }'
ParamRequiredDescription
place_id*Google Place ID (ChIJ...)
data_cid*Numeric CID (send as a string)
data_id*Place ID in 0xHEX:0xHEX format
menunoDefault true. false drops the structured menu and keeps only the menu link (smaller responses for bulk runs).
hl / gl / google_domainnoStandard localization

One of place_id, data_cid, or data_id is required. All three come from google/maps/search local_results[].


google/maps/reviews - Maps Reviews

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/maps/reviews",
      "Params": [
        { "data_id": "0x864c28f004653715:0x57c504dbf0bc93a0", "num": 20 },
        { "data_id": "0x864c28f004653715:0x57c504dbf0bc93a0", "sort_by": "newest" }
      ]
    }
  }'
ParamRequiredDescription
data_id*Place ID in 0xHEX:0xHEX format (preferred). One of data_id or place_id is required.
place_id*Place ID in ChIJ... format (needs an extra resolution step)
numnoReviews per page (1–50, default 10)
sort_bynorelevance (default, alias most_relevant), newest, highest_rating, or lowest_rating
topic_idnoFilter by topic (from the response's topics[])
next_page_tokennoCursor from previous response's pagination.next_page_token
hl / gl / google_domainnoStandard localization

Free-text review filtering (query) is not supported and returns 400. Use topic_id.


google/hotels - Hotels Listings

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/hotels",
      "Params": [
        { "q": "Bali hotels", "check_in_date": "2026-05-01", "check_out_date": "2026-05-03" },
        { "q": "Paris hotels", "check_in_date": "2026-05-01", "check_out_date": "2026-05-03", "hotel_class": "4,5", "free_cancellation": true, "currency": "EUR" }
      ]
    }
  }'
ParamRequiredDescription
qyesHotel search query (use simple "<City> hotels" form)
check_in_date / check_out_dateyesYYYY-MM-DD; check-out must be after check-in
sort_byno3 lowest price, 8 highest rating, 13 most reviewed. Omit for relevance; any other value, including 0, returns 400.
min_price / max_pricenoNightly price filter (integer, ≥ 0; max_price ≥ min_price)
ratingno7 (3.5+), 8 (4.0+), 9 (4.5+)
hotel_classnoComma-separated star ratings 2–5
amenities / property_typesnoComma-separated codes (property_types=12 switches to vacation rentals)
free_cancellation / eco_certified / special_offersnoBoolean filters
next_page_tokennoPagination cursor
limitnoResults per page, 1–20 (default 20)
hl / gl / currencynoStandard localization

Occupancy parameters (adults, children, children ages) are not supported. Results always reflect 2 adults, 0 children.

Each property in the response carries a detail_token — pass it to google/hotels/detail to fetch the live per-vendor offer shelf.


google/hotels/detail - Per-Vendor Offer Shelf

Returns each booking source's rate_per_night, total_rate, and quoted occupancy for a single property — sponsored ("Featured options") and organic ("All options") entries unified into one ranked list.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/hotels/detail",
      "Params": [
        { "detail_token": "<token>", "check_in_date": "2026-05-15", "check_out_date": "2026-05-17", "currency": "USD" }
      ]
    }
  }'
ParamRequiredDescription
detail_token or property_tokenyesFrom a google/hotels listing response. detail_token is preferred (faster).
check_in_date / check_out_dateyesYYYY-MM-DD; check-out must be after check-in
currencynoISO 4217 (default USD)
qnoOriginal listing query (relevance hint)
hl / glnoStandard localization

google/flights - Flights Itineraries

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/flights",
      "Params": [
        { "departure_id": "JFK", "arrival_id": "LAX", "outbound_date": "2026-06-15" },
        { "departure_id": "IST", "arrival_id": "LHR", "outbound_date": "2026-07-01", "return_date": "2026-07-15", "travel_class": 3, "currency": "EUR" }
      ]
    }
  }'
ParamRequiredDescription
departure_id / arrival_idyesIATA codes (comma-separated for multi-airport)
outbound_dateyesYYYY-MM-DD
return_dateconditionalYYYY-MM-DD. Required for round trip (type=1).
typeno1 round trip, 2 one way (inferred from return_date when omitted)
adults / childrenno1–9 adults (default 1), 0–9 children (default 0)
infants_in_seat / infants_on_lapno0–4 each (default 0)
travel_classno1 economy, 2 premium economy, 3 business, 4 first
stopsno0 any, 1 nonstop, 2 ≤1 stop, 3 ≤2 stops
sort_byno1–6 (top, price, dep, arr, duration, emissions)
include_airlines / exclude_airlinesnoComma-separated IATA codes (mutually exclusive)
show_hiddennotrue appends the itineraries Google folds behind "View more flights" to other_flights. Some carry no price.
hl / gl / currencynoStandard localization

Multi-city (type=3), max_price, max_duration, and bags are not yet supported and return 400 if passed.


google/news - News Articles

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/news",
      "Params": [
        { "q": "openai", "so": "1" },
        { "topic_token": "CAAqJggKIiBDQkFTRWdvSUwy..." },
        { "kgmid": "/m/02_286" }
      ]
    }
  }'

Pass exactly one driver per task:

DriverFetches
qKeyword search
topic_tokenTopic stream
section_tokenSection within a topic
story_tokenFull-coverage story page
publication_tokenPublisher feed
kgmidKnowledge Graph entity (e.g., /m/02_286 = New York City)

Tokens come from news_results[] entries in previous responses. Optional: so (0 relevance, 1 date; only with q or kgmid), hl, gl, google_domain.


curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/trends",
      "Params": [
        { "q": "bitcoin", "geo": "US" },
        { "q": "ethereum", "geo": "US", "data_type": "RELATED_QUERIES" }
      ]
    }
  }'
ParamRequiredDescription
qyesSearch keyword
geonoLocation code (e.g., US, GB, US-CA; default worldwide)
hlnoLanguage code (default en)
datenoTime range (default today 12-m)
tznoTimezone offset in minutes from UTC (default 420)
data_typenoWidget filter: TIMESERIES, GEO_MAP, GEO_MAP_0, RELATED_QUERIES, RELATED_TOPICS
catnoCategory ID
gpropnoGoogle property: web, images, news, youtube, froogle
regionnoGranularity for geo data: COUNTRY, REGION, DMA, CITY

Returns currently trending search topics from Google Trends — the same data shown on trends.google.com/trending.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/trending",
      "Params": [
        { "geo": "US" },
        { "geo": "GB", "cat": 17, "hours": 48 }
      ]
    }
  }'
ParamRequiredDescription
geoyes (or set top-level GeoCode)Country code (e.g., US, GB)
hoursnoTime window: 4, 24 (default), 48, 168
catnoCategory ID (0 all, 17 sports, 18 technology, …)
sortnorelevance (default), search_volume, recency, title
statusnoall (default) or active
hlnoLanguage code (default en)

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/youtube",
      "Params": [
        { "search_query": "best laptop 2025" },
        { "search_query": "tech reviewer", "sp": "EgIQAg==" }
      ]
    }
  }'
ParamRequiredDescription
search_query (alias q)yesSearch terms
spnoYouTube's opaque filter/sort token (also used for pagination — extract from pagination.next)
numnoResults to return, 1–30. Cannot be combined with sp.
devicenodesktop (default) or mobile
hl / glnoStandard localization

google/youtube/video - YouTube Video Detail

Returns video metadata, channel, related videos and comments, with continuation tokens for each.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/youtube/video",
      "Params": [
        { "v": "dQw4w9WgXcQ" },
        { "v": "dQw4w9WgXcQ", "hl": "de", "gl": "de", "next_page_token": "Eg0SC2RRdzR3OVdnWGNR..." }
      ]
    }
  }'
ParamRequiredDescription
vyes11-character video ID. Required on paginated calls too.
next_page_tokennoAny continuation from a previous response: related_videos_next_page_token, comments_next_page_token, a comments_sorting_token[].token, or a comment's replies_next_page_token
hl / glnoStandard localization (default en / us). Invalid values return 400.

Returns visual matches, exact-image matches and related searches for an image URL.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/lens",
      "Params": [
        { "url": "https://example.com/images/sneaker.jpg" },
        { "url": "https://example.com/images/sneaker.jpg", "type": "visual", "q": "red", "gl": "gb" }
      ]
    }
  }'
ParamRequiredDescription
urlyesPublic http(s) URL of the image
typenoall (default), visual, exact
qnoText to refine the image search. Not allowed with type=exact.
safenoactive or off
include_htmlnotrue to include the raw results page
hl / glnoStandard localization (default en / us)

Param keys are case-sensitive for google/lens. Send them lowercase exactly as listed (url, not URL); other casings are ignored.


google/food - Food Ordering Providers

Returns the pickup and delivery providers Google lists for a restaurant: provider name, order link, ETA and fees.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/food",
      "Params": [
        { "mid": "/g/11x38c65wl" },
        { "mid": "11x38c65wl", "gl": "gb", "google_domain": "google.co.uk" }
      ]
    }
  }'
ParamRequiredDescription
midyesGoogle entity ID, /g/<id> or /m/<id>. A bare ID (11x38c65wl) is treated as /g/11x38c65wl.
google_domainnoDefault google.com. Must be a valid Google domain.
hl / glnoStandard localization

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/play-store",
      "Params": [
        { "q": "weather" },
        { "chart": "topselling_free" }
      ]
    }
  }'
ParamRequiredDescription
q / apps_category / chartyesPass at least one. apps_category accepts ART_AND_DESIGN, MEDICAL, GAME_PUZZLE, etc. chart accepts topselling_free, topselling_paid, topgrossing and combines with apps_category. When q is set it wins.
numnoResults per page (1–100, default 20)
next_page_tokennoPagination token from a previous response. Malformed tokens return 400.
store_devicenophone, tablet, tv, chromebook, watch, car. Only with apps_category / chart.
agenoAGE_RANGE1 (up to 5), AGE_RANGE2 (6–8), AGE_RANGE3 (9–12). Only with apps_category=FAMILY.
hl / glnoStandard localization

google/play-store/product - App Detail

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/play-store/product",
      "Params": [
        { "product_id": "com.discord" },
        { "product_id": "com.whatsapp" }
      ]
    }
  }'
ParamRequiredDescription
product_idyesApp package identifier (e.g., com.discord). Invalid IDs return 400.
hl / glnoStandard localization

google/play-store/reviews - App Reviews

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "google/play-store/reviews",
      "Params": [
        { "product_id": "com.tapblaze.coffeebusiness" }
      ]
    }
  }'
ParamRequiredDescription
product_idyesApp package identifier
sort_byno1 most relevant (default; only supported value — others return 400)
next_page_tokennoPagination token from a previous response
hl / glnoStandard localization

ChatGPT Plugins

chatgpt/chat - ChatGPT Reply

Sends a prompt to ChatGPT and returns the assembled reply as JSON, with sources, citations, shopping cards and local-business results. No browser automation or session management on your side — pass a prompt, get a structured response.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "chatgpt/chat",
      "Params": [
        { "q": "Explain quantum entanglement in one sentence" },
        { "q": "Was sind die wichtigsten Nachrichten heute", "geoCode": "de" }
      ]
    }
  }'
ParamRequiredDescription
qyesPrompt text (max 2048 characters, slightly less for some regions such as hk)
modelnoModel selector (auto default; e.g., gpt-5, gpt-4o)
geoCodenoISO-3166-1 alpha-2 country (case-insensitive, default us). Sets the exit country and reply language: us (English), de, tr, jp, … Unknown or blocked countries return 400.
raw_sseno1 to include the raw upstream stream body alongside the assembled response. Alias: include_raw=1.
shopping_placeholdersno1 to emit {{shopping:<id>}} tokens in output.markdown instead of inline product links
ads_formatnoflat (default) or grouped (ads grouped by brand)

Send single-turn prompts. Each task should be a standalone prompt. A conversation_id comes from a previous response, and async jobs cannot chain one task's output into the next. Tasks run concurrently, so a second turn on a conversation that is still answering returns 409, and a conversation expires 10 minutes after its last turn.


chatgpt/v2/chat - ChatGPT Reply (v2)

Same params and response as chatgpt/chat, plus follow_up_suggestions and richer local-business results. model is accepted but has no effect.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "chatgpt/v2/chat",
      "Params": [
        { "q": "best tablet under 500 usd", "geoCode": "us" },
        { "q": "hair salon near me", "geoCode": "us", "ads_format": "grouped" }
      ]
    }
  }'

v2 is the only route that returns sponsored ads (tool_data.ads). ChatGPT shows ads only on follow-up turns and mostly in the US, so single-turn async jobs normally return ads: [].


Gemini, Naver & Waze Plugins

These keys read no geo parameter, so a top-level GeoCode returns 400.

gemini/chat - Gemini Reply

Sends a prompt to Google Gemini and returns the reply as Markdown with grounding sources.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "gemini/chat",
      "Params": [
        { "q": "compare the iphone 16 and pixel 9" },
        { "q": "rezept für käsespätzle", "hl": "de" }
      ]
    }
  }'
ParamRequiredDescription
qyesPrompt text (max 4000 characters; each call is standalone)
hlnoReply UI language, BCP-47 (e.g., en-US, de, pt-BR)

Returns Naver's AI search answer for a query.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "naver/ai-search",
      "Params": [
        { "query": "서울 맛집 추천" }
      ]
    }
  }'
ParamRequiredDescription
queryyesSearch query
disableretrynotrue to return the first response without retrying

waze/alerts - Waze Alerts

Returns live Waze alerts (accidents, police, hazards, jams, …) inside a bounding box.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "waze/alerts",
      "Params": [
        { "top": 40.80, "bottom": 40.70, "left": -74.02, "right": -73.93 },
        { "top": 51.55, "bottom": 51.45, "left": -0.20, "right": 0.00, "types": "ACCIDENT,ROAD_CLOSED" }
      ]
    }
  }'
ParamRequiredDescription
top / bottomyesNorthern / southern edge (latitude, -90 to 90)
left / rightyesWestern / eastern edge (longitude, -180 to 180)
typesnoComma-separated categories, e.g. ACCIDENT,POLICE,HAZARD. Omit for all.

Swapped edges are corrected automatically. A zero-area box returns 400.


Carrefour Plugins

carrefour/* covers two catalogues: standard delivery (carrefour/search, carrefour/product) and rapid "15 mins" delivery (carrefour/rapid/search, carrefour/rapid/product). Prices and availability differ between them.

country is required on every task (or set top-level GeoCode). Only ae (United Arab Emirates) is enabled; other codes return 400.

carrefour/search - Search Results

Returns search results with prices, stock, and offer and seller IDs.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "carrefour/search",
      "Params": [
        { "q": "nutella", "country": "ae" },
        { "q": "nutella", "country": "ae", "page": 1, "page_size": 20, "filter": "deal:true" }
      ]
    }
  }'
ParamRequiredDescription
qyesSearch keyword
countryyesae
pagenoZero-based page (default 0)
page_sizeno1–40 (default 40)
sort_bynoStorefront sort order (default relevance)
filternoStorefront filter expression, e.g. deal:true

carrefour/product - Product Detail

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "carrefour/product",
      "Params": [
        { "product_id": "28561", "country": "ae" },
        { "product_id": "28561", "country": "ae", "offer_id": "offer_carrefour_", "seller_id": "0000" }
      ]
    }
  }'
ParamRequiredDescription
product_idyesresults[].product_id from search (up to 32 chars of A-Z a-z 0-9 _ -)
countryyesae
offer_idnoresults[].offer_id. Send with seller_id for marketplace items.
seller_idnoresults[].seller_id (send as a string, e.g. "0000")

Without offer_id / seller_id, the store's own offer is returned.


carrefour/rapid/search and carrefour/rapid/product

Same params and response as carrefour/search and carrefour/product, over the rapid ("15 mins") catalogue.

{
  "Plugin": {
    "Key": "carrefour/rapid/search",
    "Params": [
      { "q": "milk", "country": "ae" }
    ]
  }
}

Shein Plugin

shein - Product Page

Fetches a Shein product URL and returns the rendered product HTML. A 404 from Shein is passed through. Top-level GeoCode returns 400 for this key.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "shein",
      "Params": [
        { "url": "https://www.shein.com/Tropical-Print-Drawstring-Hooded-Jacket-p-12345678.html" }
      ]
    }
  }'
ParamRequiredDescription
urlyesFull shein.com URL
timeoutnoTimeout in ms

Trip.com Plugins

country selects the Trip.com edition (locale, language, pricing region) and is required on every task, either per-param or via top-level GeoCode. It must be one of th, vn, id, jp, au, sg, my, in. A missing or unsupported value returns 400 at job creation.

Returns itineraries in Trip.com's ranked order, with segments, fares, and the productId / policyId / shortPolicyId needed for trip/detail.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "trip/search",
      "Params": [
        { "departCity": "SIN", "arriveCity": "BKK", "departDate": "2026-12-15", "country": "sg" },
        { "departCity": "SYD", "arriveCity": "TYO", "departDate": "2026-12-20", "returnDate": "2027-01-05", "country": "au", "adults": 2, "cabinClass": "c", "currency": "AUD" }
      ]
    }
  }'
ParamRequiredDescription
departCity / arriveCityyesDeparture / arrival city IATA code (e.g., SIN, BKK)
departDateyesOutbound date, YYYY-MM-DD
countryyesTrip.com edition (see above)
returnDatenoInbound date, YYYY-MM-DD. Omit for one-way.
departAirport / arriveAirportnoSpecific airport IATA (e.g., JFK vs LGA)
adults / children / infantsnoPassenger counts (default 1 / 0 / 0). Invalid counts fall back to the default.
cabinClassnoy economy (default), s premium economy, c business, f first
currencynoISO-4217 (default USD)
sortBynoScore (default), Price, Duration

trip/detail - Fare Detail

Returns the full fare breakdown for one policy from trip/search: baggage, refund and change rules, fees and amenities.

curl -X POST "https://q.scrape.do/api/v1/jobs" \
  --header "X-Token: YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "Plugin": {
      "Key": "trip/detail",
      "Params": [
        { "policyId": "abc123...", "shortPolicyId": "xyz789...", "country": "sg" }
      ]
    }
  }'
ParamRequiredDescription
policyIdyespolicyId from a trip/search result
shortPolicyIdyesshortPolicyId from the same result
countryyesTrip.com edition. Use the same one as the search.
productIdnoproductId from the search result (default: policyId)
adults / children / infantsnoPassenger counts (default 1 / 0 / 0)
currencynoISO-4217 (default USD)

A sold-out policy returns 200 with {"error":"cabin_sold_out"}. Re-run trip/search for fresh fares.


GeoCode Behavior

GeoCode can be set at two levels:

LevelExampleApplies to
Top-level"GeoCode": "us"All tasks in the job
Per-param{ "geocode": "us", ... }, { "gl": "us", ... }, { "country": "sg", ... }, etc.That task only

Top-level GeoCode is translated into the per-task query parameter the target plugin expects, with per-plugin value normalization:

Plugin familyInjected paramValue normalization
amazon, amazon/*geocodeverbatim
google/trends, google/trendinggeouppercased
All other google/* (search, shopping, maps, hotels, flights, news, youtube, lens, food, play-store, …)gllowercased
chatgpt/chat, chatgpt/v2/chatgeoCodeverbatim (case-insensitive)
carrefour/*countrylowercased
trip/search, trip/detailcountrylowercased; must be a Trip.com edition

These keys read no geo parameter, so a top-level GeoCode returns 400 instead of being silently ignored: walmart/*, samsclub/store, lowes/store, homedepot/*, google/shopping/product/stores, gemini/chat, naver/ai-search, waze/alerts, shein. google/search in url mode also rejects it — put gl inside the url instead.

Specifying GeoCode at both levels (when the per-param key matches what the plugin expects, case-insensitive) returns 400:

geoCode must not be specified both at top level and in plugin params

Webhooks

Plugin jobs share the same webhook contract as regular Async API jobs — set WebhookURL (and optionally WebhookHeaders) on the job, and each completed task triggers a delivery with the task result. Retry policy, signature header, and domain blacklist behavior are identical. See Create Job for the full payload shape and delivery semantics.

{
  "Plugin": { "Key": "amazon/pdp", "Params": [...] },
  "WebhookURL": "https://example.com/webhook",
  "WebhookHeaders": { "Authorization": "Bearer your-token" }
}

Error Codes

These errors are returned at job creation; no tasks are created.

StatusMessageCause
400plugin key is requiredPlugin.Key is empty
400unsupported plugin key: <key>Unknown plugin key
400plugin params are requiredPlugin.Params is empty
400targets cannot be used together with pluginBoth Targets and Plugin provided
400plugin params exceed limit of 1000 (got N)Too many param entries
400method <M> is not supported for plugin <key>Non-GET method on a key that only accepts GET
400top-level GeoCode is not supported for plugin <key> (set geo per-param if the plugin needs it)Plugin has no geo parameter
400geoCode must not be specified both at top level and in plugin params (conflicts with "<param>" for <key>)GeoCode conflict (top-level + per-param)
400plugin params[i]: "<k>" is reserved and set by async-api; remove ittoken, async or proxy_key in params
400plugin params[i]: "<a>" and "<b>" differ only in case; send oneCase-duplicate keys in one entry
400plugin params[i].<k>: must be a string, number or boolean …Array or object value
400plugin params[i]: google/search url= cannot be combined with <params>; put every Google parameter inside urlSearch params next to url
400top-level GeoCode cannot be used with google/search url=; put gl inside urlTop-level GeoCode with google/search in url mode
400GeoCode "<v>" is not supported by trip/<x>; use one of …Top-level GeoCode is not a Trip.com edition
400plugin params[i]: country "<v>" is not supported by trip/<x>; use one of …Per-param country is not a Trip.com edition
400plugin params[i]: country is required for trip/<x> (or set top-level GeoCode); use one of …Trip entry with no country and no GeoCode

On this page

Request Structure
Param Values
HTTP Method
Supported Plugins
Amazon Plugins
amazon/pdp - Product Detail Page
amazon/search - Search Results
amazon/offer-listing - All Seller Offers
amazon/deals - Discounted Products
amazon/bestsellers - Best Sellers Chart
amazon/seller - Seller Profile
amazon - Raw HTML
Walmart, Sam's Club, Lowes & Home Depot Plugins
walmart/store - Store-Scoped Request
walmart/search - Search Results
walmart/product - Product Detail
samsclub/store - Club-Scoped Request
lowes/store - Store-Scoped Request
homedepot/product - Store-Scoped Product Request
homedepot/stores - Store Locator
Google Plugins
google/search - SERP Results
google/search/ai-mode - AI Mode
google/shopping - Shopping Products
google/shopping/product - Product Page
google/shopping/product/stores - More Sellers
google/maps/search - Maps Places List
google/maps/place - Maps Place Details
google/maps/reviews - Maps Reviews
google/hotels - Hotels Listings
google/hotels/detail - Per-Vendor Offer Shelf
google/flights - Flights Itineraries
google/news - News Articles
google/trends - Trends Data
google/trending - Currently Trending Searches
google/youtube - YouTube Search
google/youtube/video - YouTube Video Detail
google/lens - Image Search
google/food - Food Ordering Providers
google/play-store - App Search
google/play-store/product - App Detail
google/play-store/reviews - App Reviews
ChatGPT Plugins
chatgpt/chat - ChatGPT Reply
chatgpt/v2/chat - ChatGPT Reply (v2)
Gemini, Naver & Waze Plugins
gemini/chat - Gemini Reply
naver/ai-search - Naver AI Search
waze/alerts - Waze Alerts
Carrefour Plugins
carrefour/search - Search Results
carrefour/product - Product Detail
carrefour/rapid/search and carrefour/rapid/product
Shein Plugin
shein - Product Page
Trip.com Plugins
trip/search - Flight Search
trip/detail - Fare Detail
GeoCode Behavior
Webhooks
Error Codes