Returns a list of products, sellers, brands, or categories found in the environment of a specified keyword. The keyword environment includes all keywords that contain the terms of the searched keyword (e.g., for the keyword "white shelf," related keywords like "white shoe shelf" or "white wall shelf" would be included). You can specify whether to return the organic, sponsored, or global environment using the type parameter. Additionally, results can be refined with a variety of filters for more precise targeting.
Result
The result contains a list of objects defined by the requested object type. Each object includes details such as its identifier (asin/id), title (title), the count of keyword appearances for the requested keyword (count), its rating (stars), the average minimum ranking (avg_min_position), and the average traffic score in percentage (traffic_score_percent).GET-Parameters
Parameters (Mandatory)
api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
kw
STRING
The keyword parameter specifies the search term for which the environment, including related products, sellers, brands, or categories, will be analyzed and returned.
Parameters (Optional)
country
STRING / countrycode
Defines the country for which the method will be executed. You can find a list of available marketplace country codes here. If no country parameter is provided, the default country is 'de'.
limit
INTEGER
Specifies the maximum number of products, sellers, brands, or categories to be displayed in the result. By default, this parameter is set to 100, limiting the number of results returned by the function.
offset
INTEGER
The OFFSET parameter specifies the starting point in the list of results, enabling you to skip a certain number of items.
type
STRING
Specifies the type of environment to retrieve. Available options include organic, sponsored, or global (which combines both organic and sponsored results). If no type is specified, the default setting is organic.
kw_order
STRING
If the kw_order parameter is set to "traffic," the results will be sorted by the traffic of the corresponding keywords. If set to "all," the results will be sorted by the similarity of the used keywords. The default setting is "traffic."
kw_limit
INTEGER
Limits the number of keywords considered for creating the keyword environment based on the value provided in this parameter. Only the top keywords specified by this parameter will be taken into account.
top_3
BOOLEAN
If set to "1", only keywords with top 3 rankings will be displayed.
object
The values "product," "seller," "category," or "brand" can be set to specify what type of object the function should return. The default is product.
high_traffic
BOOLEAN
If set to "1", only keywords with a traffic of 100 or more will be considered in the result list.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/marketplace.keyword.environment";
$post = [
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);import requests
baseUrl = 'https://api.sistrix.com/marketplace.keyword.environment'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/marketplace.keyword.environment \
let baseUrl = 'https://api.sistrix.com/marketplace.keyword.environment';
let form = new FormData();
fetch(baseUrl, {
method: 'POST',
body: form
}).then(function(response){
return response.text();
}).then(function(data){
//data contains the results of the request
})
