keyword | string | keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
url | string | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example:
https://www.amazon.com/s/?field-keywords=shoes&language=en_US |
priority | integer | task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. |
location_name | string | full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example:
HA1,England,United Kingdom |
location_code | integer | search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the
https://api.dataforseo.com/v3/merchant/amazon/locations example:
9045969 |
location_coordinate | string | GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code
location_coordinate parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude": 7 the minimum value for "radius": 199.9 example:
53.476225,-2.243572,200 |
language_name | string | full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the
https://api.dataforseo.com/v3/merchant/amazon/languages example:
English (United Kingdom) |
language_code | string | search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example:
en_GB |
se_domain | string | search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example:
amazon.com, amazon.co.uk, amazon.fr, etc. |
depth | integer | parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page. |
max_crawl_pages | integer | page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center |
department | string | amazon product department optional field specify one of the following amazon departments for extracting product listings:
"Arts & Crafts", "Automotive", "Baby", "Beauty & Personal Care", "Books", "Computers", "Digital Music", "Electronics", "Kindle Store", "Prime Video", "Women's Fashion", "Men's Fashion", "Girls' Fashion", "Boys' Fashion", "Deals", "Health & Household", "Home & Kitchen", "Industrial & Scientific", "Luggage", "Movies & TV", "Music, CDs & Vinyl", "Pet Supplies", "Software", "Sports & Outdoors", "Tools & Home Improvement", "Toys & Games", "Video Games" |
search_param | string | additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example:
&low-price=52 - search for products that cost more than 52 USD;
&high-price=45 - search for products that cost less than 45 USD;
&sort=relevancerank - sort results by relevance;
&sort=featured-rank - sort results by featured products;
&sort=price-asc-rank - sort by ascending price;
&sort=price-desc-rank - sort by descending price;
&sort=review-rank - sort by the average customer reviews value;
&sort=date-desc-rank - sort by the newest arrival Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by |
price_min | integer | minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example:
5 Note: if you specify price_min, the search_param parameter will be ignored |
price_max | integer | maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example:
100 Note: if you specify price_max, the search_param parameter will be ignored |
sort_by | string | results sorting rules optional field the following sorting rules are supported:
relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival example:
sort_by:"relevance" Note: if you specify sort_by, the search_param parameter will be ignored |
tag | string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
postback_url | string | URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example:
http://your-server.com/postbackscript?id=$id
http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center |
postback_data | string | postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values:
advanced, html |
pingback_url | string | notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example:
http://your-server.com/pingscript?id=$id
http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center |