This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/dataforseo_labs/amazon/product_competitors/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"asin": "019005476X",
"location_code": 2840,
"language_code": "en"
}
]"
<?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" => "019005476X",
"language_name" => "English",
"location_code" => 2840
);
try {
// POST /v3/dataforseo_labs/amazon/product_competitors/live
$result = $client->post('/v3/dataforseo_labs/amazon/product_competitors/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;
?>
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
asin="019005476X",
location_name="United States",
language_name="English"
)
# POST /v3/dataforseo_labs/amazon/product_competitors/live
response = client.post("/v3/dataforseo_labs/amazon/product_competitors/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task dataforseo_labs_amazon_product_competitors_live()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
postData.Add(new
{
asin = "019005476X",
location_name = "United States",
language_name = "English"
});
// POST /v3/dataforseo_labs/amazon/product_competitors/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/amazon/product_competitors/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
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.
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
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, ilike, not_ilike, like, not_like
you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters
example: ["full_metrics.amazon_serp.pos_1",">", 20]
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: ["full_metrics.amazon_serp.pos_1,desc"] 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: ["full_metrics.amazon_serp.pos_1,desc","avg_position,desc"]
default rule: ["ranked_serp_element.serp_item.rank_group,asc"]
offset
integer
offset in the results array of returned product competitors
optional field
default value: 0
if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors
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
asin
string
ASIN of the product
unique product identifier on Amazon;
for more information, refer to this help center guide
avg_position
float
average position of the product in Amazon SERP Note: average position is calculated for intersected keywords only;
the value for a given product may differ when combined with different target products
sum_position
integer
sum of all product positions in Amazon SERP Note: average position is calculated for intersected keywords only;
the value for a given product may differ when combined with different target products
intersections
integer
number of intersecting keywords
competitor_metrics
object
metrics for intersecting keywords
ranking data relevant to the keywords that the provided asin shares with the target asin; Note: in this object ranking data is provided for the returned competitor’s asin
amazon_serp
object
ranking data from Amazon organic SERP
pos_1
integer
number of organic SERPs where the product ranks #1
pos_2_3
integer
number of organic SERPs where the product ranks #2-3
pos_4_10
integer
number of organic SERPs where the product ranks #4-10
pos_11_100
integer
number of organic SERPs where the product ranks #11-100
count
integer
total count of Amazon organic SERPs that contain the product
search_volume
integer
total search volume of the product’s ranking keywords in organic SERP
amazon_paid
object
ranking data from Amazon paid SERP
pos_1
integer
number of paid SERPs where the product ranks #1
pos_2_3
integer
number of paid SERPs where the product ranks #2-3
pos_4_10
integer
number of paid SERPs where the product ranks #4-10
pos_11_100
integer
number of paid SERPs where the product ranks #11-100
count
integer
total count of Amazon paid SERPs that contain the product
search_volume
integer
total search volume of the product’s ranking keywords in paid SERP
full_metrics
object
metrics for all keywords of the product
full overview of ranking data relevant to all keywords that the provided asin is ranking for
amazon_serp
object
ranking data from Amazon organic SERP
pos_1
integer
number of organic SERPs where the product ranks #1
pos_2_3
integer
number of organic SERPs where the product ranks #2-3
pos_4_10
integer
number of organic SERPs where the product ranks #4-10
pos_11_100
integer
number of organic SERPs where the product ranks #11-100
count
integer
total count of Amazon organic SERPs that contain the product
search_volume
integer
total search volume of the product’s ranking keywords in organic SERP
amazon_paid
object
ranking data from Amazon paid SERP
pos_1
integer
number of paid SERPs where the product ranks #1
pos_2_3
integer
number of paid SERPs where the product ranks #2-3
pos_4_10
integer
number of paid SERPs where the product ranks #4-10
pos_11_100
integer
number of paid SERPs where the product ranks #11-100
count
integer
total count of Amazon paid SERPs that contain the product
search_volume
integer
total search volume of the product’s ranking keywords in paid SERP