WebScrapingAPI Docs

SearchData and SERP APIs

Commerce and search result endpoints, engines, request fields, and response behavior.

SearchData commerce APIs return structured retailer and marketplace data. SERP APIs return structured search engine results or raw HTML, depending on the selected engine and response mode.

EndpointBase URLMethodsAPI type
SearchData commercehttps://ecom.webscrapingapi.com/v1GET, POSTProduct, search, review, seller, and async commerce engines.
SERPhttps://serpapi.webscrapingapi.com/v2GETGoogle, Bing, DuckDuckGo, Yandex, and specialized Google SERP engines.

SearchData common parameters

ParameterTypeRequiredNotes
api_keystring✅Authentication.
enginestringYes unless polling snapshot_idSelects the scraper or SERP engine.
devicestring❌Used by engines that support device selection.
bodyJSON string or body payloadFor async batch enginesBatch input. Batch engines accept up to 5000 input items.
snapshot_idstringOnly when pollingPolls a previously submitted async job.

If your key is entitled only for the newer SERP API, commerce /v1 requests return This endpoint is deprecated. Please use /v2.

Current SearchData engines

EngineType valuesRequired input
amazonproduct, search, bestsellers, category, new-releases, todays-deals, seller_products, seller_profile, seller_feedbackDepends on type: product_id, q, category_id, parent_alias, or seller_id
crateandbarrelproduct, reviewsurl
ebayproductepid or url
freedomproduct, reviewsproduct_id or url
homedepotproductproduct_id
johnlewisproduct, reviewsurl
lowesproductproduct_id
targetproductproduct_id
walmart_spreetailproductproduct_id or url
wayfair_spreetailproductproduct_id or url
westelmproducturl
bestbuy_asyncproductPOST body array
booking_asynchotel, hotel_pricing, searchPOST body array
chatgpt_asyncpromptPOST body array
nordstrom_asyncproductPOST body array
wayfair_asyncproductPOST body array

walmart_spreetail and wayfair_spreetail are the current input engine names. Responses may still normalize search_parameters.engine to walmart or wayfair for compatibility.

Amazon parameters

ParameterApplies toNotes
typeRequiredseller is accepted as an alias for seller_products.
product_idtype=productAmazon ASIN or product id.
qtype=searchSearch query.
category_idcategory, bestsellers, new-releases, todays-dealsCategory identifier.
parent_aliasbestsellers, new-releasesSub-category parent alias.
seller_idseller_products, seller_profile, seller_feedbackSeller identifier.
amazon_domainoptionalDefaults to amazon.com; also controls proxy country when known.
delivery_locationoptionalOne of au, br, ca, cn, de, es, fr, gb, in, jp, mx, us. Overrides proxy country.
hl, gl, zip_codeoptionalLocalization values forwarded to the scraper.
page, sort_by, filter_byoptionalSearch/listing controls.
lazy_loading, scroll_to_bottom, wait_bottom_carousel, wait_for_offers, wait_for_videooptional booleansRendering and page-load controls.

SERP common behavior

/v2 requires engine. Requests are validated against the selected engine, so unsupported parameters return Parameter '<name>' not allowed.

EngineRequired input
bingq
duckduckgoq
googleq
google_asyncq
google_flightsq
google_hotelstype=search with q, or type=place with pid
google_mapstype=search with q, or type=place with data
google_maps_reviewsfid
google_reverse_imageurl
google_trendsq
yandexq

Only engines listed here should be treated as supported SERP API engines. Additional planned or internal engines are not available until they appear in this reference.

SERP output

Some SERP engines support a response option:

ValueBehavior
htmlReturns raw HTML in result with search_parameters.
jsonReturns parsed JSON when the selected engine supports structured output.

Use the response field only when the selected engine documents it. Engines that do not expose response return their default format.

Examples

Amazon product:

curl --get "https://ecom.webscrapingapi.com/v1" \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "engine=amazon" \
  --data-urlencode "type=product" \
  --data-urlencode "product_id=B07G9MNF3Q"

Walmart product with current engine name:

curl --get "https://ecom.webscrapingapi.com/v1" \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "engine=walmart_spreetail" \
  --data-urlencode "type=product" \
  --data-urlencode "product_id=631259576"

Google SERP JSON:

curl --get "https://serpapi.webscrapingapi.com/v2" \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "engine=google" \
  --data-urlencode "q=coffee" \
  --data-urlencode "response=json" \
  --data-urlencode "device=desktop"

Google async SERP submit and poll:

curl --get "https://serpapi.webscrapingapi.com/v2" \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "engine=google_async" \
  --data-urlencode "q=events in new york city"
curl --get "https://serpapi.webscrapingapi.com/v2" \
  --data-urlencode "api_key=YOUR_API_KEY" \
  --data-urlencode "snapshot_id=RESPONSE_ID_FROM_SUBMIT" \
  --data-urlencode "type=serp"

On this page