Data API / DataForSEO / DataForSEO Labs

Ranked Keywords

The Amazon search terms a product ranks for. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is Labs' own Amazon index, so it pages and answers immediately - unlike seo-merchant, which queues a live scrape of the store.

Parameters

No path, query, or header parameters.

Request body

asinstringRequired
product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint
location_namestringOptional
full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States
location_codeintegerOptional
location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840
language_namestringOptional
full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
language_codestringOptional
language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
limitintegerOptional
the maximum number of products in the results array optional field default value: 100; maximum value: 1000
ignore_synonymsbooleanOptional
ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
filtersarrayOptional
array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , , >, >=, =, , in, not_in, like, not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["keyword_data.keyword_info.search_volume","in",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optional
results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: ["keyword_data.keyword_info.competition,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
offsetintegerOptional
offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/ranked_keywords/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "limit": 0,
  "ignore_synonyms": false,
  "filters": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
se_typestringOptional
search engine type
asinstringOptional
ASIN in a POST array
location_codeintegerOptional
location code in a POST array if there is no data, then the value is null
language_codestringOptional
language code in a POST array if there is no data, then the value is null
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains detected Amazon product competitors and related data
se_typestringOptional
search engine type
keyword_dataobjectOptional
keyword data for the returned keyword
se_typestringOptional
search engine type
keywordstringOptional
returned keyword
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
keyword_infoobjectOptional
keyword info for the returned keyword
se_typestringOptional
search engine type
last_updated_timestringOptional
date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: 2019-11-15 12:57:46 +00:00
search_volumeintegerOptional
average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon
ranked_serp_elementobjectOptional
contains data on the products’s SERP element found for the returned keyword
se_typestringOptional
search engine type
serp_itemobjectOptional
contains data on the SERP element the list of supported SERP elements can be found below
se_typestringOptional
search engine type
typestringOptional
type of element = ‘amazon_serp’
rank_groupintegerOptional
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in Amazon SERP absolute position among all the elements in SERP
positionstringOptional
the alignment of the element in Amazon SERP can take the following values: left, right
xpathstringOptional
the XPath of the element
domainstringOptional
Amazon domain
titlestringOptional
product title
urlstringOptional
URL of the product page
descriptionstringOptional
description of the product
asinstringOptional
ASIN of the product learn more about ASIN in this help center guide
image_urlstringOptional
URL of the product image featured in the results
price_fromnumberOptional
the regular price of a product example: 49.98
price_tonumberOptional
the upper limit of the product price range example: 384.99
currencystringOptional
currency in the ISO format example: USD
special_offersstring[]Optional
special offer details contains special offer details, including coupon and Subscribe & Save discounts
is_best_sellerbooleanOptional
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
is_amazon_choicebooleanOptional
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
ratingobjectOptional
the item’s rating the popularity rate based on reviews and displayed in SERP
rating_typestringOptional
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueintegerOptional
the value of the rating
votes_countintegerOptional
the amount of feedback
rating_maxintegerOptional
the maximum value for a rating_type
delivery_infoobjectOptional
delivery information delivery information including free and fast delivery date ranges
delivery_messagestringOptional
delivery information message accompanying the delivery information as posted by the seller
delivery_priceobjectOptional
price for the delivery price of the delivery based on the location you specified in the POST request; if free delivery is available, the value is null
currentnumberOptional
current delivery price
regularnumberOptional
regular undiscounted delivery price
max_valuenumberOptional
maximum undiscounted delivery price
currencystringOptional
currency in the ISO format
is_price_rangebooleanOptional
indicates whether the delivery price is a range
displayed_pricestringOptional
price line provided as displayed in Amazon listing
check_urlstringOptional
direct URL to Amazon results you can use it to make sure that we provided accurate results
serp_item_typesstring[]Optional
direct URL to Amazon results contains types of all search results (items) found in the returned SERP; possible item types: amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches
se_results_countintegerOptional
total number of results in Amazon SERP
last_updated_timestringOptional
date and time when SERP data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
previous_updated_timestringOptional
previous to the most recent update of SERP data in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2020-09-12T00:07:43.0733218Z
se_typestringOptional
search engine type
typestringOptional
type of element = ‘related_searches’
rank_groupintegerOptional
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in Amazon SERP absolute position among all the elements in SERP
positionstringOptional
the alignment of the element in Amazon SERP can take the following values: left, right
xpathstringOptional
the XPath of the element
domainstringOptional
Amazon domain
titlestringOptional
product title
urlstringOptional
URL of the product page
descriptionstringOptional
description of the product
asinstringOptional
ASIN of the product learn more about ASIN in this help center guide
image_urlstringOptional
URL of the product image featured in the results
price_fromnumberOptional
the regular price of a product example: 49.98
price_tonumberOptional
the upper limit of the product price range example: 384.99
currencystringOptional
currency in the ISO format example: USD
special_offersstring[]Optional
special offer details contains special offer details, including coupon and Subscribe & Save discounts
is_best_sellerbooleanOptional
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
is_amazon_choicebooleanOptional
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
ratingobjectOptional
the item’s rating the popularity rate based on reviews and displayed in SERP
rating_typestringOptional
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueintegerOptional
the value of the rating
votes_countintegerOptional
the amount of feedback
rating_maxintegerOptional
the maximum value for a rating_type
delivery_infoobjectOptional
delivery information delivery information including free and fast delivery date ranges
delivery_messagestringOptional
delivery information message accompanying the delivery information as posted by the seller
delivery_priceobjectOptional
price for the delivery price of the delivery based on the location you specified in the POST request; if free delivery is available, the value is null
currentnumberOptional
current delivery price
regularnumberOptional
regular undiscounted delivery price
max_valuenumberOptional
maximum undiscounted delivery price
currencystringOptional
currency in the ISO format
is_price_rangebooleanOptional
indicates whether the delivery price is a range
displayed_pricestringOptional
price line provided as displayed in Amazon listing
itemsstring[]Optional
contains
typestringOptional
type of element = ‘related_searches_element’
titlestringOptional
product title
urlstringOptional
the URL of the product page
image_altstringOptional
the alt tag of the product image featured in the results
image_urlstringOptional
URL of the product image featured in the results