API reference · DataForSEO

dataforseo/v3/merchant/amazon/products/live/advanced

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDdataforseo/v3/merchant/amazon/products/live/advanced
01

Input Schema

16 parameters · 1 required · 15 optional

ParameterTypeRequiredDescription
keywordstringRequiredkeywordrequired fieldyou can specify up to 700 characters in this fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your ke...
tagstringOptionaluser-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object...
urlstringOptionaldirect URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields
depthintegerOptionalparsing depthoptional fieldnumber of results to be retrieved from the Amazon results pagedefault value: 100max value: 700Your account will be billed per each SERP containing up to 100 results; Setting...
sort_bystringOptionalresults sorting rulesoptional fieldthe following sorting rules are supported:relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrivalexample:sort_by:"relevance"No...
price_maxintegerOptionalmaximum product priceoptional fieldmaximum price of the returned products listed on Amazon for the specified queryexample:100Note: if you specify price_max, the search_param parameter will be ignored
price_minintegerOptionalminimum product priceoptional fieldminimum price of the returned products listed on Amazon for the specified queryexample:5Note: if you specify price_min, the search_param parameter will be ignored
se_domainstringOptionalsearch engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this...
departmentstringOptionalamazon product departmentoptional fieldspecify one of the following amazon departments for extracting product listings:"Arts & Crafts", "Automotive", "Baby", "Beauty & Personal Care", "Books", "Comput...
search_paramstringOptionaladditional parameters of the search queryoptional fieldyou can use the following Amazon search URL parameters for customizing the searchexample:&low-price=52 - search for products that cost more than ...
language_codestringOptionalsearch engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their lan...
language_namestringOptionalfull name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with t...
location_codeintegerOptionalsearch engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive ...
location_namestringOptionalfull name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can ...
max_crawl_pagesintegerOptionalpage crawl limitoptional fieldnumber of search results pages to crawlmax value: 7Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
location_coordinatestringOptionalGPS coordinates of a locationrequired field if you don't specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parame...
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "dataforseo/v3/merchant/amazon/products/live/advanced",
  "prompt": "a beautiful sunset over mountains"
}'