Data API / DataForSEO / DataForSEO Labs

Keyword Suggestions

Long-tail variants containing one keyword - the phrase-match view, where post_dataforseo_labs_google_keyword_ideas_live is the semantic one. Returns seed_keyword, seed_keyword_data, total_count, offset_token and items. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.

Parameters

No path, query, or header parameters.

Request body

keywordstringOptional
keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestringOptional
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_codeintegerOptional
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_namestringOptional
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 example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
language_codestringOptional
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 example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
include_seed_keywordbooleanOptional
include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false
include_serp_infobooleanOptional
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_databooleanOptional
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, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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
exact_matchbooleanOptional
search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false
ignore_synonymsbooleanOptional
ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
filtersarrayOptional
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, match, not_match, 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: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc"," for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optional
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 a comma is used as a separator example: ["keyword_info.competition,desc"] default rule: ["keyword_info.search_volume,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: ["keyword_info.search_volume,desc","keyword_info.cpc,desc"]
limitintegerOptional
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetintegerOptional
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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.
offset_tokenstringOptional
offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/keyword_suggestions/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "include_seed_keyword": false,
  "include_serp_info": false,
  "include_clickstream_data": false
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
se_typestringOptional
search engine type
seed_keywordstringOptional
keyword in a POST array
seed_keyword_dataobjectOptional
keyword data for the seed keyword fields in this object are identical to those of the items array
location_codeintegerOptional
location code in a POST array if there is no data, then the value is null
language_codestringOptional
language code in a POST array if there is no data, then the value is null
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
offsetintegerOptional
current offset value
offset_tokenstringOptional
offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task
itemsstring[]Optional
contains keywords and related data
se_typestringOptional
search engine type
keywordstringOptional
keyword suggestion
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
keyword_infoobjectOptional
keyword data for the returned keyword
se_typestringOptional
search engine type
last_updated_timestringOptional
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
competitionnumberOptional
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_levelstringOptional
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
cpcnumberOptional
cost-per-click represents the average cost per click (USD) historically paid for the keyword
search_volumeintegerOptional
average monthly search volume rate represents the (approximate) number of searches for the given keyword idea on google.com
low_top_of_page_bidnumberOptional
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_bidnumberOptional
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
categoriesstring[]Optional
product and service categories you can download the full list of possible categories
monthly_searchesstring[]Optional
monthly searches represents the (approximate) number of searches for this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
yearintegerOptional
year
monthintegerOptional
month
search_volumeintegerOptional
monthly average search volume rate
search_volume_trendobjectOptional
search volume trend changes represents search volume change in percent compared to the previous period
monthlyintegerOptional
search volume change in percent compared to the previous month
quarterlyintegerOptional
search volume change in percent compared to the previous quarter
yearlyintegerOptional
search volume change in percent compared to the previous year
clickstream_keyword_infoobjectOptional
clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true
search_volumeintegerOptional
monthly average clickstream search volume rate
last_updated_timestringOptional
date and time when the clickstream dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
gender_distributionobjectOptional
distribution of estimated clickstream-based metrics by gender learn more about how the metric is calculated in this help center article
femaleintegerOptional
number of female users in the relevant clickstream dataset
maleintegerOptional
number of male users in the relevant clickstream dataset
age_distributionobjectOptional
distribution of clickstream-based metrics by age learn more about how the metric is calculated in this help center article
18-24integerOptional
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerOptional
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerOptional
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerOptional
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerOptional
number of users in the relevant clickstream dataset that fall within the 55-64 age range
monthly_searchesstring[]Optional
monthly clickstream search volume rates array of objects with clickstream search volume rates in a certain month of a year
yearintegerOptional
year
monthintegerOptional
month
search_volumeintegerOptional
clickstream-based search volume rate in a certain month of a year
keyword_propertiesobjectOptional
additional information about the keyword
se_typestringOptional
search engine type
core_keywordstringOptional
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_algorithmstringOptional
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_difficultyintegerOptional
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_languagestringOptional
detected language of the keyword indicates the language of the keyword as identified by our system
is_another_languagebooleanOptional
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
words_countintegerOptional
number of words in the keyword indicates how many words the keyword consists of
serp_infoobjectOptional
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_typestringOptional
search engine type
check_urlstringOptional
direct URL to search engine results you can use it to make sure that we provided accurate results
serp_item_typesstring[]Optional
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, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_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, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_countstringOptional
number of search results for the returned keyword
last_updated_timestringOptional
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_timestringOptional
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_infoobjectOptional
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 webpages ranking organically for the keyword
se_typestringOptional
search engine type
backlinksnumberOptional
average number of backlinks
dofollownumberOptional
average number of dofollow links
referring_pagesnumberOptional
average number of referring pages
referring_domainsnumberOptional
average number of referring domains
referring_main_domainsnumberOptional
average number of referring main domains
ranknumberOptional
average rank learn more about the metric and its calculation formula in this help center article
main_domain_ranknumberOptional
average main domain rank learn more about the metric and its calculation formula in this help center article
last_updated_timestringOptional
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
search_intent_infoobjectOptional
search intent info for the returned keyword learn about search intent in this help center article
se_typestringOptional
search engine type possible values: google
main_intentstringOptional
main search intent possible values: informational, navigational, commercial, transactional
foreign_intentstring[]Optional
supplementary search intents possible values: informational, navigational, commercial, transactional
last_updated_timestringOptional
date and time when search intent 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
keyword_info_normalized_with_bingobjectOptional
contains keyword search volume normalized with Bing search volume
last_updated_timestringOptional
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_volumeintegerOptional
current search volume rate of a keyword
is_normalizedbooleanOptional
keyword info is normalized if true, values are normalized with Bing data
monthly_searchesintegerOptional
monthly search volume rates array of objects with search volume rates in a certain month of a year
yearintegerOptional
year
monthintegerOptional
month
search_volumeintegerOptional
search volume rate in a certain month of a year
keyword_info_normalized_with_clickstreamobjectOptional
contains keyword search volume normalized with clickstream data
last_updated_timestringOptional
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_volumeintegerOptional
current search volume rate of a keyword
is_normalizedbooleanOptional
keyword info is normalized if true, values are normalized with clickstream data
monthly_searchesintegerOptional
monthly search volume rates array of objects with search volume rates in a certain month of a year
yearintegerOptional
year
monthintegerOptional
month
search_volumeintegerOptional
search volume rate in a certain month of a year