Displays the top organic ranking positions for the specified keywords, sorted from highest to lowest. To filter the results for a specific domain or URL, use the DOMAIN and URL parameters. The COUNTRY and MOBILE parameters allow you to specify the desired country and device type. If you want to analyze historical rankings for a specific domain or URL, use the HISTORY parameter. To get the values for specific weeks in the past, use the DATE parameter. The LIMIT parameter will restrict the number of displayed Google rankings.
Result
The result contains a list of the top ranking positions for the keyword. Each ranking entry includes the position of the ranking (position), the ranking domain (domain), and the corresponding URL (url).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
Defines the keyword to which the method is applied.
Parameters (Optional)
country
STRING / countrycode
Defines the country for which the method will be executed. You can find a list of available country codes here. If no Country parameter is provided, the default country associated with the Toolbox account will be used.
limit
INTEGER
Specifies the maximum numbers of organic rankings to be displayed in the result. By default, this parameter is set to 100, which limits the number of organic rankings returned by the function.
history
BOOLEAN
Retrieves historical ranking data for the specified DOMAIN or URL. This parameter only works in combination with DOMAIN or URL to provide weekly historical ranking information. If set to TRUE, it will return ranking data from previous weeks, allowing you to analyze changes over time.
domain
STRING
Specifies the domain for which the top-ranking positions of the specified keyword are retrieved. This parameter allows you to focus the analysis on a particular domain within the organic search results.
url
STRING
Specifies the URL for which the top-ranking positions of the specified keyword are retrieved. This parameter allows you to focus the analysis on a particular URL within the organic search results.
mobile
BOOLEAN
Defines whether mobile or desktop data should be returned. By default, this parameter is set to TRUE, meaning mobile data will be returned. If set to FALSE, only desktop data will be returned.
date
DATE
Specifies the week for which historical ranking data should be retrieved. Use this parameter to get the top organic ranking positions for a specific week in the past. If no data is available for the given week, the function will return an error.
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/keyword.seo";
$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/keyword.seo'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/keyword.seo \
let baseUrl = 'https://api.sistrix.com/keyword.seo';
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
})
