The Related Keywords endpoint provides keywords appearing in the “searches related to” SERP element.
You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values.
Datasource: DataForSEO SERPs Database Search algorithm: depth-first search for queries appearing in the “search related to” element of SERP for the specified seed keyword. Examples:
Note: the depth parameter is set to 1
Specified seed keyword: “keyword research”
Resulting related keywords: •”free keyword research”, •”keyword research tools”, •”best free keyword research tool”, •”keyword research tips”, •”seo keyword research tool”, •”keyword research step by step”, •”how to do keyword research 2019″, •”keyword research google ads”
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/bing/related_keywords/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"keyword": "phone",
"language_name": "English",
"location_code": 2840,
"limit": 3
}
]"
<?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(
"keyword" => "phone",
"language_name" => "English",
"location_code" => 2840,
"filters" => [
["keyword_data.keyword_info.search_volume", ">", 10]
],
"limit": 3
);
try {
// POST /v3/dataforseo_labs/bing/related_keywords/live
$result = $client->post('/v3/dataforseo_labs/bing/related_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(
keyword="phone",
location_name="United States",
language_name="English",
filters=[
["keyword_data.keyword_info.search_volume", ">", 10]
],
limit=3
)
# POST /v3/dataforseo_labs/bing/related_keywords/live
response = client.post("/v3/dataforseo_labs/bing/related_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_bing_related_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
{
keyword = "phone",
location_name = "United States",
language_name = "English",
filters = new object[]
{
new object[] { "keyword_data.keyword_info.search_volume", ">", 10 }
},
limit = 3
});
// POST /v3/dataforseo_labs/bing/related_keywords/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/bing/related_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. The maximum number of requests that can be sent simultaneously is limited to 30.
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
keyword
string
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_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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only;
example: United States
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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only;
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
depth
integer
keyword search depth
optional field
default value: 1
number of the returned results depends on the value you set in this field
you can specify a level from 0 to 4
estimated number of keywords for each level (maximum):
0 – the keyword set in the keyword field
1 – 8 keywords
2 – 72 keywords
3 – 584 keywords
4 – 4680 keywords
include_seed_keyword
boolean
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_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
replace_with_core_keyword
boolean
return data for core keyword
optional field
if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to;
if false, serp_info and related_keywords will be returned for the specified keyword (if available);
refer to this help center article for more details;
default value: false
ignore_synonyms
boolean
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
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: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, 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_data.keyword_info.search_volume",">",0]
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: ["keyword_data.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_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
limit
integer
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
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
seed_keyword
string
keyword in a POST array
seed_keyword_data
array/td>
keyword data for the seed keyword
fields in the array are identical to that of keyword_data
location_code
integer
location code in a POST array
language_code
string
language code in a POST array
total_count
integer
total amount of results in our database relevant to your request
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_data
object
keyword data for the returned keyword
se_type
string
search engine type
keyword
string
related keyword
location_code
integer
location code in a POST array
language_code
string
language code in a POST array
keyword_info
object
keyword data for the returned keyword
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 Bing Ads data and can be between 0 and 1 (inclusive)
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 bing.com
monthly_searches
array
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
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
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 item types: answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search,questions_and_answers, recipes, related_searches, shopping, top_stories, video; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_count
integer
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
depth
integer
keyword search depth
related_keywords
array
list of related keywords
represents the list of search queries which are related to the keyword returned in the array above
