Note that the structure of DataForSEO Labs API requests and responses was updated on 2022-03-19. However, we will continue supporting the legacy version documented here. You can review the documentation of the new version by this link.
This endpoint will provide you with the list of keywords that any domain or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as impressions, monthly searches and other data relevant to the returned keywords.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?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-access
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to set a task
$post_array[] = array(
"target" => "dataforseo.com",
"language_name" => "English",
"location_code" => 2840,
"filters" => [
["keyword_data.keyword_info.search_volume", "<>", 0],
"and",
[
["ranked_serp_element.serp_item.type", "<>", "paid"],
"or",
["ranked_serp_element.serp_item.is_malicious", "=", false]
]
]
);
try {
// POST /v3/dataforseo_labs/ranked_keywords/live
$result = $client->post('/v3/dataforseo_labs/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;
?>
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(
target="dataforseo.com",
location_name="United States",
language_name="English",
filters=[
["keyword_data.keyword_info.search_volume", "<>", 0],
"and",
[
["ranked_serp_element.serp_item.type", "<>", "paid"],
"or",
["ranked_serp_element.serp_item.is_malicious", "=", False]
]
]
)
# POST /v3/dataforseo_labs/ranked_keywords/live
response = client.post("/v3/dataforseo_labs/ranked_keywords/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_ranked_keywords_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-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
postData.Add(new
{
target = "dataforseo.com",
location_name = "United States",
language_name = "English",
filters = new object[]
{
new object[] { "keyword_data.keyword_info.search_volume", "<>", 0 },
"and",
new object[]
{
new object[] { "ranked_serp_element.serp_item.type", "<>", "paid" },
"or",
new object[] { "ranked_serp_element.serp_item.is_malicious", "=", false }
}
}
});
// POST /v3/dataforseo_labs/ranked_keywords/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/ranked_keywords/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.
You can specify the number of results you want to retrieve, filter and sort them.
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
target
string
domain required field
the domain name of the target website
the domain should be specified without https:// or www.
if you want to get the keywords a particular webpage ranks for, specify the filter by the ranked_serp_element.serp_item.relative_url parameter
example: "filters":[
"ranked_serp_element.serp_item.relative_url", "=", "/apis/rank-tracker-api"]
location_name
string
full name of the location
optional field
if you use this field, you don’t need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example: United Kingdom
location_code
integer
location code
optional field
if you use this field, you don’t need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example: 2840
language_name
string
full name of the language
optional field
if you use this field, you don’t need to 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
ignore this field to get the results for all available languages
example: English
language_code
string
language code
optional field
if you use this field, you don’t need to 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
ignore this field to get the results for all available languages
example: en
item_types
array
display results by item type
optional field
indicates the type of search results included in the response
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;
the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000
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
load_rank_absolute
boolean
return rankings distribution by rank_absolute
optional field
default value: false
if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements
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: <, <=, >, >=, =, <>, 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: ["ranked_serp_element.serp_item.rank_group","<=",10]
if you want to get the keywords a particular webpage ranks for, specify the filter by the ranked_serp_element.serp_item.relative_url parameter
example: ["ranked_serp_element.serp_item.relative_url", "=", "/apis/rank-tracker-api"]
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 type
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"]
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
target
string
target domain 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 number of results in our database relevant to your request
items_count
integer
the number of results returned in the items array
metrics
object
ranking data relevant to the specified domain
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements
organic
object
ranking and traffic data from organic search
pos_1
integer
number of organic SERPs where the domain ranks #1
pos_2_3
integer
number of organic SERPs where the domain ranks #2-3
pos_4_10
integer
number of organic SERPs where the domain ranks #4-10
pos_11_20
integer
number of organic SERPs where the domain ranks #11-20
pos_21_30
integer
number of organic SERPs where the domain ranks #21-30
pos_31_40
integer
number of organic SERPs where the domain ranks #31-40
pos_41_50
integer
number of organic SERPs where the domain ranks #41-50
pos_51_60
integer
number of organic SERPs where the domain ranks #51-60
pos_61_70
integer
number of organic SERPs where the domain ranks #61-70
pos_71_80
integer
number of organic SERPs where the domain ranks #71-80
pos_81_90
integer
number of organic SERPs where the domain ranks #81-90
pos_91_100
integer
number of organic SERPs where the domain ranks #91-100
etv
float
estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of organic SERPs that contain the domain
estimated_paid_traffic_cost
float
estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for all keywords that a domain ranks for
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for this domain
is_up
integer
rank went up
indicates how many ranked elements of this domain went up in Google Search
is_down
integer
rank went down
indicates how many ranked elements of this domain went down in Google Search
is_lost
integer
lost ranked elements
indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check
paid
object
ranking and traffic data from paid search
pos_1
integer
number of paid SERPs where the domain ranks #1
pos_2_3
integer
number of paid SERPs where the domain ranks #2-3
pos_4_10
integer
number of paid SERPs where the domain ranks #4-10
pos_11_20
integer
number of paid SERPs where the domain ranks #11-20
pos_21_30
integer
number of paid SERPs where the domain ranks #21-30
pos_31_40
integer
number of paid SERPs where the domain ranks #31-40
pos_41_50
integer
number of paid SERPs where the domain ranks #41-50
pos_51_60
integer
number of paid SERPs where the domain ranks #51-60
pos_61_70
integer
number of paid SERPs where the domain ranks #61-70
pos_71_80
integer
number of paid SERPs where the domain ranks #71-80
pos_81_90
integer
number of paid SERPs where the domain ranks #81-90
pos_91_100
integer
number of paid SERPs where the domain ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of paid SERPs that contain the domain
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic based on etv and cpc values
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for this domain
is_up
integer
rank went up
indicates how many ranked elements of this domain went up in Google Search
is_down
integer
rank went down
indicates how many ranked elements of this domain went down in Google Search
is_lost
integer
lost ranked elements
indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check
featured_snippet
object
ranking and traffic data from the featured snippet results in Google SERP
pos_1
integer
number of featured snippet items where the domain ranks #1
pos_2_3
integer
number of featured snippet items where the domain ranks #2-3
pos_4_10
integer
number of featured snippet items where the domain ranks #4-10
pos_11_20
integer
number of featured snippet items where the domain ranks #11-20
pos_21_30
integer
number of featured snippet items where the domain ranks #21-30
pos_31_40
integer
number of featured snippet items where the domain ranks #31-40
pos_41_50
integer
number of featured snippet items where the domain ranks #41-50
pos_51_60
integer
number of featured snippet items where the domain ranks #51-60
pos_61_70
integer
number of featured snippet items where the domain ranks #61-70
pos_71_80
integer
number of featured snippet items where the domain ranks #71-80
pos_81_90
integer
number of featured snippet items where the domain ranks #81-90
pos_91_100
integer
number of featured snippet items where the domain ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of featured snippet items that contain the domain
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the indicated target
is_up
integer
rank went up
indicates how many ranked elements of the indicated target went up
is_down
integer
rank went down
indicates how many ranked elements of the indicated target went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
local_pack
object
ranking and traffic data from the local pack results in SERP
pos_1
integer
number of local pack items where the domain ranks #1
pos_2_3
integer
number of local pack items where the domain ranks #2-3
pos_4_10
integer
number of local pack items where the domain ranks #4-10
pos_11_20
integer
number of local pack items where the domain ranks #11-20
pos_21_30
integer
number of local pack items where the domain ranks #21-30
pos_31_40
integer
number of local pack items where the domain ranks #31-40
pos_41_50
integer
number of local pack items where the domain ranks #41-50
pos_51_60
integer
number of local pack items where the domain ranks #51-60
pos_61_70
integer
number of local pack items where the domain ranks #61-70
pos_71_80
integer
number of local pack items where the domain ranks #71-80
pos_81_90
integer
number of local pack items where the domain ranks #81-90
pos_91_100
integer
number of local pack items where the domain ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of local pack items that contain the domain
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the indicated target
is_up
integer
rank went up
indicates how many ranked elements of the indicated target went up
is_down
integer
rank went down
indicates how many ranked elements of the indicated target went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
metrics_absolute
object
ranking data relevant to the specified domain
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements
organic
array
ranking data from organic search
pos_1
integer
number of organic SERPs where the domain ranks #1
pos_2_3
integer
number of organic SERPs where the domain ranks #2-3
pos_4_10
integer
number of organic SERPs where the domain ranks #4-10
pos_11_20
integer
number of organic SERPs where the domain ranks #11-20
pos_21_30
integer
number of organic SERPs where the domain ranks #21-30
pos_31_40
integer
number of organic SERPs where the domain ranks #31-40
pos_41_50
integer
number of organic SERPs where the domain ranks #41-50
pos_51_60
integer
number of organic SERPs where the domain ranks #51-60
pos_61_70
integer
number of organic SERPs where the domain ranks #61-70
pos_71_80
integer
number of organic SERPs where the domain ranks #71-80
pos_81_90
integer
number of organic SERPs where the domain ranks #81-90
pos_91_100
integer
number of organic SERPs where the domain ranks #91-100
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for this domain
is_up
integer
rank went up
indicates how many ranked elements of this domain went up in Google Search
is_down
integer
rank went down
indicates how many ranked elements of this domain went down in Google Search
is_lost
integer
lost ranked elements
indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check
paid
array
ranking data from paid search
pos_1
integer
number of paid SERPs where the domain ranks #1
pos_2_3
integer
number of paid SERPs where the domain ranks #2-3
pos_4_10
integer
number of paid SERPs where the domain ranks #4-10
pos_11_20
integer
number of paid SERPs where the domain ranks #11-20
pos_21_30
integer
number of paid SERPs where the domain ranks #21-30
pos_31_40
integer
number of paid SERPs where the domain ranks #31-40
pos_41_50
integer
number of paid SERPs where the domain ranks #41-50
pos_51_60
integer
number of paid SERPs where the domain ranks #51-60
pos_61_70
integer
number of paid SERPs where the domain ranks #61-70
pos_71_80
integer
number of paid SERPs where the domain ranks #71-80
pos_81_90
integer
number of paid SERPs where the domain ranks #81-90
pos_91_100
integer
number of paid SERPs where the domain ranks #91-100
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for this domain
is_up
integer
rank went up
indicates how many ranked elements of this domain went up in Google Search
is_down
integer
rank went down
indicates how many ranked elements of this domain went down in Google Search
is_lost
integer
lost ranked elements
indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check
featured_snippet
array
ranking and traffic data from the featured snippet results in Google SERP
pos_1
integer
number of featured snippet items where the domain ranks #1
pos_2_3
integer
number of featured snippet items where the domain ranks #2-3
pos_4_10
integer
number of featured snippet items where the domain ranks #4-10
pos_11_20
integer
number of featured snippet items where the domain ranks #11-20
pos_21_30
integer
number of featured snippet items where the domain ranks #21-30
pos_31_40
integer
number of featured snippet items where the domain ranks #31-40
pos_41_50
integer
number of featured snippet items where the domain ranks #41-50
pos_51_60
integer
number of featured snippet items where the domain ranks #51-60
pos_61_70
integer
number of featured snippet items where the domain ranks #61-70
pos_71_80
integer
number of featured snippet items where the domain ranks #71-80
pos_81_90
integer
number of featured snippet items where the domain ranks #81-90
pos_91_100
integer
number of featured snippet items where the domain ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of featured snippet items that contain the domain
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the indicated target
is_up
integer
rank went up
indicates how many ranked elements of the indicated target went up
is_down
integer
rank went down
indicates how many ranked elements of the indicated target went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
local_pack
array
ranking and traffic data from the local pack results in SERP
pos_1
integer
number of local pack items where the domain ranks #1
pos_2_3
integer
number of local pack items where the domain ranks #2-3
pos_4_10
integer
number of local pack items where the domain ranks #4-10
pos_11_20
integer
number of local pack items where the domain ranks #11-20
pos_21_30
integer
number of local pack items where the domain ranks #21-30
pos_31_40
integer
number of local pack items where the domain ranks #31-40
pos_41_50
integer
number of local pack items where the domain ranks #41-50
pos_51_60
integer
number of local pack items where the domain ranks #51-60
pos_61_70
integer
number of local pack items where the domain ranks #61-70
pos_71_80
integer
number of local pack items where the domain ranks #71-80
pos_81_90
integer
number of local pack items where the domain ranks #81-90
pos_91_100
integer
number of local pack items where the domain ranks #91-100
etv
float
estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
count
integer
total count of local pack items that contain the domain
estimated_paid_traffic_cost
float
estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
is_new
integer
number of new ranked elements
indicates how many new ranked elements were found for the indicated target
is_up
integer
rank went up
indicates how many ranked elements of the indicated target went up
is_down
integer
rank went down
indicates how many ranked elements of the indicated target went down
is_lost
integer
lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
items
array
contains ranked keywords and related data
keyword_data
array
keyword data for the returned keyword
keyword
string
returned keyword
location_code
integer
location code in a POST array
language_code
integer
language code in a POST array
keyword_info
array
keyword data for the returned keyword
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
competition
float
competition
represents the relative amount of competition associated with the given keyword
this value is based on Google Ads data and can be between 0 and 1 (inclusive)
if there is no data the value is null
cpc
float
cost-per-click
represents the average cost per click (USD) historically paid for the keyword
if there is no data then the value is null
search_volume
integer
average monthly search volume rate
represents the (approximate) number of searches for the given keyword on google.com
if there is no data then the value is null
monthly searches
represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations
if there is no data then the value is null
year
integer
year
month
integer
month
search_volume
integer
monthly average search volume rate
impressions_info
array
impressions data for the returned keyword daily_impressions values provide a more accurate alternative to Google search volume data;
the 999 bid is used to mitigate account-specific factors Google considers when calculating impressions
learn more about impressions in this help center article
last_updated_time
string
date and time when impressions data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00
bid
integer
the maximum CPC
it stands for the price you are willing to pay for an ad. The higher value, the higher positions and price you will get
we return the results for the 999 bid value to provide the highest number of impressions and level down the account-specific factors
match
string
keyword match-type
can take the following values: exact, broad, phrase
ad_position_min
float
the minimum ad position
represents the minimum position of the advertisement
ad_position_max
float
the maximum ad position
represents the maximum position of the advertisement
ad_position_average
float
the average ad position
represents the average position of the advertisement
cpc_min
float
the minimum value of cost-per-click
the minimum cost-per-click (USD) for the keyword given that a bid is set to 999; note: this field does not represent an actual CPC value;
you can find an actual CPC value for a keyword in the cpc field of the keyword_info array
cpc_max
float
the maximum value of cost-per-click
the maximum cost-per-click (USD) for the keyword given that a bid is set to 999; note: this field does not represent an actual CPC value;
you can find an actual CPC value for a keyword in the cpc field of the keyword_info array
cpc_average
float
the average value of cost-per-click
the average cost-per-click (USD) for the keyword given that a bid is set to 999; note: this field does not represent an actual CPC value;
you can find an actual CPC value for a keyword in the cpc field of the keyword_info array
daily_impressions_min
float
the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement given that that a bid is set to 999;
provides a more accurate alternative to Google search volume data
daily_impressions_max
float
the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement given that that a bid is set to 999;
provides a more accurate alternative to Google search volume data
daily_impressions_average
float
the average value of daily impressions
represents the average number of daily impressions of the advertisement given that that a bid is set to 999;
provides a more accurate alternative to Google search volume data
daily_clicks_min
float
the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
daily_clicks_max
float
the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
daily_clicks_average
float
the average value of daily clicks
represents the average number of daily clicks on the advertisement
daily_cost_min
float
the minimum daily charge value
represents the minimum daily cost of the advertisement (USD)
daily_cost_max
float
the maximum daily charge value
represents the maximum daily cost of the advertisement (USD)
daily_cost_average
float
the average daily charge value
represents the average daily cost of the advertisement (USD)
bing_keyword_info
array
keyword data based on bing ads note: bing data is available for a limited number of locations and languages
last_updated_time
string
date and time when keyword 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
search_volume
integer
monthly number of searches on bing
represents the number of searches for the given keyword on bing.com for the past month
monthly_searches
array
monthly searches
represents the number of monthly Bing searches on the returned keyword in the given location
serp_info
array
SERP data
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
serp_item_types
array
types of search results in SERP
contains types of search results (items) found in SERP
possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
string
number of search results for the returned keyword
keyword_difficulty
integer
difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
learn more about the metric in this help center guide
last_updated_time
string
date and time when SERP data was 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 date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-10-15 12:57:46 +00:00
ranked_serp_element
array
contains data on the domain’s SERP element found for the returned keyword
serp_item
array
contains data on the SERP element
the list of supported SERP elements can be found below
indicates whether the element is a featured_snippet
is_malicious
boolean
indicates whether the element is marked as malicious
description
string
description of the results element in SERP
pre_snippet
string
includes additional information appended before the result description in SERP
extended_snippet
string
includes additional information appended after the result description in SERP
amp_version
boolean
Accelerated Mobile Pages
indicates whether an item has the Accelerated Mobile Page (AMP) version
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
highlighted
array
words highlighted in bold within the results description
links
array
sitelinks
the links shown below some of Google’s search results
if there are none, equals null
type
string
type of element = ‘link_element‘
title
string
title of the result in SERP
description
string
description of the results element in SERP
url
string
sitelink URL
main_domain
string
primary domain name in SERP
relative_url
string
URL in SERP that does not specify the HTTPs protocol and domain name
etv
float
estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
learn more about how the metric is calculated in this help center article
estimated_paid_traffic_cost
float
estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for the returned keyword
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
rank_changes
array
changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time
previous_rank_absolute
integer
previous absolute rank in SERP
indicates previous rank of the element in Google SERP;
if this element is new, the value will be null
is_new
boolean
element was previously present in SERP
if the value is true, previously collected SERP didn’t contain this element
is_up
boolean
rank of this element went up
if the value is true, position of the element in SERP is higher compared to the previous check
is_down
boolean
rank of this element went down
if the value is true, position of the element in SERP is lower compared to the previous check
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
serp_item_types
array
types of search results in SERP
contains types of search results (items) found in SERP
possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
string
number of search results for the returned keyword
keyword_difficulty
integer
difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP
last_updated_time
string
date and time when SERP data was 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 date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-10-15 12:57:46 +00:00
words highlighted in bold within the results description
extra
array
additional information about the result
ad_aclk
string
the identifier of the ad
description_rows
array
extended description
if there is none, equals null
links
array
sitelinks
the links shown below some of Google’s search results
if there are none, equals null
type
string
type of element = ‘ad_link_element‘
title
string
title of the link element
description
string
description of the results element in SERP
url
string
URL link
ad_aclk
string
the identifier of the ad
main_domain
string
primary domain name in SERP
relative_url
string
URL in SERP that does not specify the HTTPs protocol and domain name
etv
float
estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
learn more about how the metric is calculated in this help center article
estimated_paid_traffic_cost
float
estimated cost of paid monthly search traffic
represents the estimated cost of paid monthly traffic based on etv and cpc values
learn more about how the metric is calculated in this help center article
rank_changes
array
changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time
previous_rank_absolute
integer
previous absolute rank in SERP
indicates previous rank of the element in Google SERP;
if this element is new, the value will be null
is_new
boolean
element was previously present in SERP
if the value is true, previously collected SERP didn’t contain this element
is_up
boolean
rank of this element went up
if the value is true, position of the element in SERP is higher compared to the previous check
is_down
boolean
rank of this element went down
if the value is true, position of the element in SERP is lower compared to the previous check
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
serp_item_types
array
types of search results in SERP
contains types of search results (items) found in SERP
possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
string
number of search results for the returned keyword
keyword_difficulty
integer
difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP
last_updated_time
string
date and time when SERP data was 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 date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-10-15 12:57:46 +00:00
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
main_domain
string
primary domain name in SERP
relative_url
string
URL in SERP that does not specify the HTTPs protocol and domain name
etv
float
estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
learn more about how the metric is calculated in this help center article
estimated_paid_traffic_cost
float
estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for the returned keyword
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
rank_changes
array
changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time
previous_rank_absolute
integer
previous absolute rank in SERP
indicates previous rank of the element in Google SERP;
if this element is new, the value will be null
is_new
boolean
element was previously present in SERP
if the value is true, previously collected SERP didn’t contain this element
is_up
boolean
rank of this element went up
if the value is true, position of the element in SERP is higher compared to the previous check
is_down
boolean
rank of this element went down
if the value is true, position of the element in SERP is lower compared to the previous check
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
serp_item_types
array
types of search results in SERP
contains types of search results (items) found in SERP
possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
string
number of search results for the returned keyword
keyword_difficulty
integer
difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP
last_updated_time
string
date and time when SERP data was 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 date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-10-15 12:57:46 +00:00
the content of the table
one line of the table in this element of the array
main_domain
string
primary domain name in SERP
relative_url
string
URL in SERP that does not specify the HTTPs protocol and domain name
etv
float
estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
learn more about how the metric is calculated in this help center article
impressions_etv
float
estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impression values of the returned keyword
learn more about how the metric is calculated in this help center article
estimated_paid_traffic_cost
float
estimated cost of converting organic search traffic into paid
represents the estimated monthly cost of running ads for the returned keyword
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
rank_changes
array
changes in rankings
contains information about the ranking changes of the SERP element since the previous_updated_time
previous_rank_absolute
integer
previous absolute rank in SERP
indicates previous rank of the element in Google SERP;
if this element is new, the value will be null
is_new
boolean
element was previously present in SERP
if the value is true, previously collected SERP didn’t contain this element
is_up
boolean
rank of this element went up
if the value is true, position of the element in SERP is higher compared to the previous check
is_down
boolean
rank of this element went down
if the value is true, position of the element in SERP is lower compared to the previous check
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
serp_item_types
array
types of search results in SERP
contains types of search results (items) found in SERP
possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
string
number of search results for the returned keyword
keyword_difficulty
integer
difficulty of ranking in the first top-10 organic results for a keyword
indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP
last_updated_time
string
date and time when SERP data was 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 date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-10-15 12:57:46 +00:00
