NAVNavbar
Logo
cURL php NodeJS Python cSharp

Ranked Keywords


This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
   "asin" => "B00R92CL5E",
   "language_name" => "English",
   "location_code" => 2840
);
try {
   // POST /v3/dataforseo_labs/amazon/ranked_keywords/live
   $result = $client->post('/v3/dataforseo_labs/amazon/ranked_keywords/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20220216",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.2091 sec.",
    "cost": 0.011,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "02231139-2806-0377-0000-c70efa444ae6",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0708 sec.",
            "cost": 0.011,
            "result_count": 1,
            "path": [
                "v3",
                "dataforseo_labs",
                "amazon",
                "ranked_keywords",
                "live"
            ],
            "data": {
                "api": "dataforseo_labs",
                "function": "ranked_keywords",
                "se_type": "amazon",
                "asin": "B00R92CL5E",
                "location_code": 2840,
                "language_code": "en",
                "limit": 10
            },
            "result": [
                {
                    "se_type": "amazon",
                    "asin": "B00R92CL5E",
                    "location_code": 2840,
                    "language_code": "en",
                    "total_count": 11789,
                    "items_count": 10,
                    "items": [
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "baby girl",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-07 00:27:24 +00:00",
                                    "search_volume": 32700
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 44,
                                    "rank_absolute": 54,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[46]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_42?keywords=baby+girl&qid=1643911090&sr=8-42",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": [
                                        "Save 69%"
                                    ],
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68918,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=baby%20girl&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "editorial_recommendations",
                                    "related_searches",
                                    "top_rated_from_our_brands"
                                ],
                                "se_results_count": 179962,
                                "last_updated_time": "2022-02-04 12:38:33 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "car window stickers",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-07 00:21:14 +00:00",
                                    "search_volume": 20900
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 49,
                                    "rank_absolute": 53,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[51]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_46?keywords=car+window+stickers&qid=1643909825&sr=8-46",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68918,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=car%20window%20stickers&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_serp",
                                    "amazon_paid",
                                    "related_searches",
                                    "top_rated_from_our_brands"
                                ],
                                "se_results_count": 111829,
                                "last_updated_time": "2022-02-04 12:37:22 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "accessories for women jewelry",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-05 19:38:34 +00:00",
                                    "search_volume": 18700
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 30,
                                    "rank_absolute": 34,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[29]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_23?keywords=accessories+for+women+jewelry&qid=1643911700&sr=8-23",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68919,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=accessories%20for%20women%20jewelry&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches",
                                    "top_rated_from_our_brands"
                                ],
                                "se_results_count": 125038,
                                "last_updated_time": "2022-02-04 12:39:07 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "hunting gear for men",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 13:22:36 +00:00",
                                    "search_volume": 12600
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 36,
                                    "rank_absolute": 46,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[47]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_41?keywords=hunting+gear+for+men&qid=1643806343&sr=8-41",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68870,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=hunting%20gear%20for%20men&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches"
                                ],
                                "se_results_count": 44246,
                                "last_updated_time": "2022-02-04 12:00:54 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "police gear accessories",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 12:11:29 +00:00",
                                    "search_volume": 8000
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 41,
                                    "rank_absolute": 46,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[49]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_45?keywords=police+gear+accessories&qid=1643844118&sr=8-45",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68896,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=police%20gear%20accessories&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches"
                                ],
                                "se_results_count": 10353,
                                "last_updated_time": "2022-02-04 12:05:40 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "business clothes for women",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-05 19:21:21 +00:00",
                                    "search_volume": 7700
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 81,
                                    "rank_absolute": 102,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[33]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_78?keywords=business+clothes+for+women&qid=1643805628&sr=8-78",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68867,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=business%20clothes%20for%20women&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches"
                                ],
                                "se_results_count": 55933,
                                "last_updated_time": "2022-02-04 12:00:52 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "trailer accessories for outside",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 12:27:51 +00:00",
                                    "search_volume": 7700
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 48,
                                    "rank_absolute": 55,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[54]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_49?keywords=trailer+accessories+for+outside&qid=1643803612&sr=8-49",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68860,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=trailer%20accessories%20for%20outside&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp"
                                ],
                                "se_results_count": 32028,
                                "last_updated_time": "2022-02-04 12:00:45 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "car battery charger portable",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 12:38:17 +00:00",
                                    "search_volume": 7000
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 49,
                                    "rank_absolute": 69,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[4]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_51?keywords=car+battery+charger+portable&qid=1643803602&sr=8-51",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68860,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=car%20battery%20charger%20portable&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp"
                                ],
                                "se_results_count": 762,
                                "last_updated_time": "2022-02-04 12:00:45 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "network switch gigabit",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 12:51:48 +00:00",
                                    "search_volume": 6800
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 57,
                                    "rank_absolute": 78,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[6]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_52?keywords=network+switch+gigabit&qid=1643803768&sr=8-52",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68860,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=network%20switch%20gigabit&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches"
                                ],
                                "se_results_count": 1964,
                                "last_updated_time": "2022-02-04 12:00:46 +00:00",
                                "previous_updated_time": null
                            }
                        },
                        {
                            "se_type": "amazon",
                            "keyword_data": {
                                "se_type": "amazon",
                                "keyword": "phone ring grip",
                                "location_code": 2840,
                                "language_code": "en",
                                "keyword_info": {
                                    "se_type": "amazon",
                                    "last_updated_time": "2022-02-04 13:13:44 +00:00",
                                    "search_volume": 6300
                                }
                            },
                            "ranked_serp_element": {
                                "se_type": "amazon",
                                "serp_item": {
                                    "se_type": "amazon",
                                    "type": "amazon_serp",
                                    "rank_group": 79,
                                    "rank_absolute": 106,
                                    "position": "left",
                                    "xpath": "/html[1]/body[1]/div[1]/div[2]/div[1]/div[1]/div[1]/span[3]/div[2]/div[11]",
                                    "domain": "www.amazon.com",
                                    "title": "NETGEAR Wi-Fi Range Extender EX3700 - Coverage Up to 1000 Sq Ft and 15 Devices with AC750 Dual Band Wireless Signal Booster & Repeater (Up to 750Mbps Speed), and Compact Wall Plug Design",
                                    "url": "https://www.amazon.com/NETGEAR-Wi-Fi-Range-Extender-EX3700/dp/B00R92CL5E/ref=sr_1_74?keywords=phone+ring+grip&qid=1643803763&sr=8-74",
                                    "description": null,
                                    "asin": "B00R92CL5E",
                                    "image_url": null,
                                    "price_from": 39,
                                    "price_to": null,
                                    "currency": "USD",
                                    "special_offers": null,
                                    "is_best_seller": false,
                                    "is_amazon_choice": false,
                                    "rating": {
                                        "rating_type": "Max5",
                                        "value": 3,
                                        "votes_count": 68860,
                                        "rating_max": 5
                                    },
                                    "delivery_info": null
                                },
                                "check_url": "https://www.amazon.com/s/?field-keywords=phone%20ring%20grip&page=1&language=en_US",
                                "serp_item_types": [
                                    "amazon_paid",
                                    "amazon_serp",
                                    "related_searches"
                                ],
                                "se_results_count": 4946,
                                "last_updated_time": "2022-02-04 12:00:46 +00:00",
                                "previous_updated_time": null
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute. The maximum number of requests that can be sent simultaneously is limited to 30.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
asin string 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_name string 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_code integer 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_name string 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_code string 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
limit integer the maximum number of products in the results array
optional field
default value: 100;
maximum value: 1000
ignore_synonyms boolean 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
filters array 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
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_by array 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"]
offset integer 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
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

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer 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_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer 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_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            se_type string search engine type
            asin string ASIN in a POST array
            location_code integer location code in a POST array
if there is no data, then the value is null
            language_code string language code in a POST array
if there is no data, then the value is null
            total_count integer total amount of results in our database relevant to your request
            items_count integer the number of results returned in the items array
            items array contains detected Amazon product competitors and related data
                  se_type string search engine type
                  keyword_data object keyword data for the returned keyword
                      se_type string search engine type
                      keyword string returned keyword
                      location_code integer location code in a POST array
                      language_code string language code in a POST array
                      keyword_info object keyword info for the returned keyword
                          se_type string search engine type
                          last_updated_time string 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_volume integer average monthly search volume rate
represents the (approximate) number of searches for the returned keyword on Amazon
                  ranked_serp_element object contains data on the products’s SERP element found for the returned keyword
                      se_type string search engine type
                      serp_item object contains data on the SERP element
the list of supported SERP elements can be found below
                      ‘amazon_serp’ element
                          se_type string search engine type
                          type string type of element = ‘amazon_serp’
                          rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                          rank_absolute integer absolute rank in Amazon SERP
absolute position among all the elements in SERP
                          position string the alignment of the element in Amazon SERP
can take the following values:
left, right
                          xpath string the XPath of the element
                          domain string Amazon domain
                          title string product title
                          url string URL of the product page
                          description string description of the product
                          asin string ASIN of the product
learn more about ASIN in this help center guide
                          image_url string URL of the product image featured in the results
                          price_from float the regular price of a product
example:
49.98
                          price_to float the upper limit of the product price range
example:
384.99
                          currency string currency in the ISO format
example:
USD
                          special_offers array special offer details
contains special offer details, including coupon and Subscribe & Save discounts
                          is_best_seller boolean “Best Seller” label
if the value is true, the product is marked with the “Best Seller” label
                          is_amazon_choice boolean “Amazon’s choice” label
if the value is true, the product is marked with the “Amazon’s choice” label
                          rating object the item’s rating
the popularity rate based on reviews and displayed in SERP
                             rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                             value integer the value of the rating
                             votes_count integer the amount of feedback
                             rating_max integer the maximum value for a rating_type
                          delivery_info object delivery information
delivery information including free and fast delivery date ranges
                             delivery_message string delivery information
message accompanying the delivery information as posted by the seller
                             delivery_price object 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
                                 current float current delivery price
                                 regular float regular undiscounted delivery price
                                 max_value float maximum undiscounted delivery price
                                 currency string currency in the ISO format
                                 is_price_range boolean indicates whether the delivery price is a range
                                 displayed_price string price line provided as displayed in Amazon listing
                      check_url string direct URL to Amazon results
you can use it to make sure that we provided accurate results
                      serp_item_types array 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_count integer total number of results in Amazon SERP
                      last_updated_time string 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_time string 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
                      ‘amazon_paid’ element
                          se_type string search engine type
                          type string type of element = ‘amazon_serp’
                          rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                          rank_absolute integer absolute rank in Amazon SERP
absolute position among all the elements in SERP
                          position string the alignment of the element in Amazon SERP
can take the following values:
left, right
                          xpath string the XPath of the element
                          domain string Amazon domain
                          title string product title
                          url string URL of the product page
                          description string description of the product
                          asin string ASIN of the product
learn more about ASIN in this help center guide
                          image_url string URL of the product image featured in the results
                          price_from float the regular price of a product
example:
49.98
                          price_to float the upper limit of the product price range
example:
384.99
                          currency string currency in the ISO format
example:
USD
                          special_offers array special offer details
contains special offer details, including coupon and Subscribe & Save discounts
                          is_best_seller boolean “Best Seller” label
if the value is true, the product is marked with the “Best Seller” label
                          is_amazon_choice boolean “Amazon’s choice” label
if the value is true, the product is marked with the “Amazon’s choice” label
                          rating object the item’s rating
the popularity rate based on reviews and displayed in SERP
                             rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                             value integer the value of the rating
                             votes_count integer the amount of feedback
                             rating_max integer the maximum value for a rating_type
                          delivery_info object delivery information
delivery information including free and fast delivery date ranges
                             delivery_message string delivery information
message accompanying the delivery information as posted by the seller
                             delivery_price object 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
                                 current float current delivery price
                                 regular float regular undiscounted delivery price
                                 max_value float maximum undiscounted delivery price
                                 currency string currency in the ISO format
                                 is_price_range boolean indicates whether the delivery price is a range
                                 displayed_price string price line provided as displayed in Amazon listing
                      check_url string direct URL to Amazon results
you can use it to make sure that we provided accurate results
                      serp_item_types array 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_count integer total number of results in Amazon SERP
                      last_updated_time string 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_time string 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
                      ‘editorial_recommendations’ element
                          se_type string search engine type
                          type string type of element = ‘amazon_serp’
                          rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                          rank_absolute integer absolute rank in Amazon SERP
absolute position among all the elements in SERP
                          position string the alignment of the element in Amazon SERP
can take the following values:
left, right
                          xpath string the XPath of the element
                          domain string Amazon domain
                          title string product title
                          url string URL of the product page
                          description string description of the product
                          asin string ASIN of the product
learn more about ASIN in this help center guide
                          image_url string URL of the product image featured in the results
                          price_from float the regular price of a product
example:
49.98
                          price_to float the upper limit of the product price range
example:
384.99
                          currency string currency in the ISO format
example:
USD
                          special_offers array special offer details
contains special offer details, including coupon and Subscribe & Save discounts
                          is_best_seller boolean “Best Seller” label
if the value is true, the product is marked with the “Best Seller” label
                          is_amazon_choice boolean “Amazon’s choice” label
if the value is true, the product is marked with the “Amazon’s choice” label
                          rating object the item’s rating
the popularity rate based on reviews and displayed in SERP
                             rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                             value integer the value of the rating
                             votes_count integer the amount of feedback
                             rating_max integer the maximum value for a rating_type
                          delivery_info object delivery information
delivery information including free and fast delivery date ranges
                             delivery_message string delivery information
message accompanying the delivery information as posted by the seller
                             delivery_price object 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
                                 current float current delivery price
                                 regular float regular undiscounted delivery price
                                 max_value float maximum undiscounted delivery price
                                 currency string currency in the ISO format
                                 is_price_range boolean indicates whether the delivery price is a range
                                 displayed_price string price line provided as displayed in Amazon listing
                      check_url string direct URL to Amazon results
you can use it to make sure that we provided accurate results
                      serp_item_types array 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_count integer total number of results in Amazon SERP
                      last_updated_time string 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_time string 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_results_count integer total number of results in Amazon SERP
                      last_updated_time string 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_time string 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
                      ‘top_rated_from_our_brands’ element
                          se_type string search engine type
                          type string type of element = ‘amazon_serp’
                          rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                          rank_absolute integer absolute rank in Amazon SERP
absolute position among all the elements in SERP
                          position string the alignment of the element in Amazon SERP
can take the following values:
left, right
                          xpath string the XPath of the element
                          domain string Amazon domain
                          title string product title
                          url string URL of the product page
                          description string description of the product
                          asin string ASIN of the product
learn more about ASIN in this help center guide
                          image_url string URL of the product image featured in the results
                          price_from float the regular price of a product
example:
49.98
                          price_to float the upper limit of the product price range
example:
384.99
                          currency string currency in the ISO format
example:
USD
                          special_offers array special offer details
contains special offer details, including coupon and Subscribe & Save discounts
                          is_best_seller boolean “Best Seller” label
if the value is true, the product is marked with the “Best Seller” label
                          is_amazon_choice boolean “Amazon’s choice” label
if the value is true, the product is marked with the “Amazon’s choice” label
                          rating object the item’s rating
the popularity rate based on reviews and displayed in SERP
                             rating_type string the type of rating
here you can find the following elements: Max5, Percents, CustomMax
                             value integer the value of the rating
                             votes_count integer the amount of feedback
                             rating_max integer the maximum value for a rating_type
                          delivery_info object delivery information
delivery information including free and fast delivery date ranges
                             delivery_message string delivery information
message accompanying the delivery information as posted by the seller
                             delivery_price object 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
                                 current float current delivery price
                                 regular float regular undiscounted delivery price
                                 max_value float maximum undiscounted delivery price
                                 currency string currency in the ISO format
                                 is_price_range boolean indicates whether the delivery price is a range
                                 displayed_price string price line provided as displayed in Amazon listing
                      check_url string direct URL to Amazon results
you can use it to make sure that we provided accurate results
                      serp_item_types array 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_count integer total number of results in Amazon SERP
                      last_updated_time string 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_time string 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
                      ‘related_searches’ element
                          se_type string search engine type
                          type string type of element = ‘related_searches’
                          rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                          rank_absolute integer absolute rank in Amazon SERP
absolute position among all the elements in SERP
                          xpath string the XPath of the element
                          items array contains
                             type string type of element = ‘related_searches_element’
                             title string product title
                             url string the URL of the product page
                             image_alt string the alt tag of the product image featured in the results
                             image_url string URL of the product image featured in the results

‌‌