This endpoint will provide you with Google historical search volume, current cost-per-click, and competition values for paid search, as well as current impressions and SERP. You can get historical search volume data since the beginning of 2019, depending on keywords along with location and language combination. You can find the list of supported locations and languages here.
Datasource: DataForSEO Keyword Database
The data is based on Google Ads API. We update keyword metrics once a month after the data source completes its updates. Note that sometimes Google tends to rewrite search volume values for a given month, and we update the values in this endpoint respectively.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/dataforseo_labs/google/historical_search_volume/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"keywords": [
"phone",
"watch"
],
"language_name": "English",
"location_code": 2840,
"include_serp_info": true
}
]"
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(
keywords=[
"phone",
"watch"
],
location_name="United States",
language_name="English"
)
# POST /v3/dataforseo_labs/google/historical_search_volume/live
response = client.post("/v3/dataforseo_labs/google/historical_search_volume/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_google_historical_search_volume_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
{
keywords = new[]
{
"phone",
"watch"
},
location_name = "United States",
language_name = "English"
});
// POST /v3/dataforseo_labs/google/historical_search_volume/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/google/historical_search_volume/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.
Description of the fields for setting a task:
Field name
Type
Description
keywords
array
keywords required field
The maximum number of keywords you can specify: 700
The maximum number of characters for each keyword: 80
The maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase format, data will be provided in a separate array
note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
you will not be charged for the keywords omitted in the results
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_name
string
full name of the location required field if you don’t specifylocation_code Note: it is required to specify either location_name or 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
example: United Kingdom
location_code
integer
location code required field if you don’t specifylocation_name Note: it is required to specify either location_name or location_code
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
example: 2840
language_name
string
full name of the language required field if you don’t specifylanguage_code Note: it is required to specify either language_name or language_code
you can receive the list of available locations 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 you don’t specifylanguage_name Note: it is required to specify either language_name or language_code
you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example: en
include_serp_info
boolean
include data from SERP for each keyword
optional field
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
default value: false
include_clickstream_data
boolean
include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request
learn more about how clickstream-based metrics are calculated in this help center article
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
location_code
integer
location code in a POST array
language_code
string
language code in a POST array
items_count
integer
the number of results returned in the items array
items
array
contains keywords and related data
se_type
string
search engine type
keyword
string
keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)
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
search_partners
boolean
indicates data for Google and partner sites
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only
keyword_info
object
keyword data for the returned keyword idea
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
competition
float
competition
represents the relative amount of competition associated with the given keyword;
the value is based on Google Ads data and can be between 0 and 1 (inclusive)
competition_level
string
competition level
represents the relative level of competition associated with the given keyword in paid SERP only;
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article
cpc
float
cost-per-click
represents the average cost per click (USD) historically paid for the keyword
search_volume
integer
average monthly search volume rate
represents the (approximate) number of searches for the given keyword idea on google.com
low_top_of_page_bid
float
minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request
high_top_of_page_bid
float
maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request
monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
year
integer
year
month
integer
month
search_volume
integer
monthly average search volume rate
clickstream_keyword_info
object
clickstream data for the returned keyword
to retrieve results for this field, the parameter include_clickstream_data must be set to true
search_volume
integer
monthly average clickstream search volume rate
last_updated_time
string
date and time when the clickstream dataset was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
gender_distribution
object
distribution of estimated clickstream-based metrics by gender
learn more about how the metric is calculated in this help center article
female
integer
number of female users in the relevant clickstream dataset
male
integer
number of male users in the relevant clickstream dataset
age_distribution
object
distribution of clickstream-based metrics by age
learn more about how the metric is calculated in this help center article
18-24
integer
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34
integer
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44
integer
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54
integer
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64
integer
number of users in the relevant clickstream dataset that fall within the 55-64 age range
monthly_searches
array
monthly clickstream search volume rates
array of objects with clickstream search volume rates in a certain month of a year
year
integer
year
month
integer
month
search_volume
integer
clickstream-based search volume rate in a certain month of a year
keyword_properties
object
additional information about the keyword
se_type
string
search engine type
core_keyword
string
main keyword in a group
contains the main keyword in a group determined by the synonym clustering algorithm
if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword
synonym_clustering_algorithm
string
the algorithm used to identify synonyms
possible values: keyword_metrics – indicates the algorithm based on keyword_info parameters text_processing – indicates the text-based algorithm
if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with 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
detected_language
string
detected language of the keyword
indicates the language of the keyword as identified by our system
is_another_language
boolean
detected language of the keyword is different from the set language
if true, the language set in the request does not match the language determined by our system for a given keyword
impressions_info
object
impressions data for the returned keyword idea
Note that all data in the impressions_info object is deprecated and provided only as legacy to avoid maintenance issues
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
se_type
string
search engine type
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_type
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 object
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 object
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 object
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)
serp_info
object
SERP data
the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database
se_type
string
search engine type
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 items types; 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
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
avg_backlinks_info
object
backlink data for the returned keyword
this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword
se_type
string
search engine type
backlinks
float
average number of backlinks
dofollow
float
average number of dofollow links
referring_pages
float
average number of referring pages
referring_domains
float
average number of referring domains
referring_main_domains
float
average number of referring main domains
rank
float
average rank
learn more about the metric and its calculation formula in this help center article
main_domain_rank
float
average main domain rank
learn more about the metric and its calculation formula in this help center article
last_updated_time
string
date and time when backlink data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00
keyword_info_normalized_with_bing
object
contains keyword search volume normalized with Bing search volume
last_updated_time
string
date and time when the dataset 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
current search volume rate of a keyword
monthly_searches
integer
monthly search volume rates
array of objects with search volume rates in a certain month of a year
year
integer
year
month
integer
month
search_volume
integer
search volume rate in a certain month of a year
keyword_info_normalized_with_clickstream
object
contains keyword search volume normalized with clickstream data
last_updated_time
string
date and time when the dataset 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
current search volume rate of a keyword
monthly_searches
integer
monthly search volume rates
array of objects with search volume rates in a certain month of a year
