Related keywords
The SerpstatKeywordProcedure.getRelatedKeywords method shows all search queries that are semantically related to the searched keyword. The data set is similar to the Keyword research / Related keywords report.
General request parameters and instructions for using Serpstat API
Search databases available
Request parameter | |||||
Parameter | Description | Type | Optional | Default value | Value Options |
id | A request id: the response contains the same id. | int/string | no | Text or number value | |
method | API method name | string | no | SerpstatKeywordProcedure.getRelatedKeywords | |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | no | ||
keyword | Keyword to search for | string | no | Any string value (for example: seo) | |
se | ID of the search base to be searched. | string | no | For example: g_us (search databases list) | |
filters | Filter conditions | array | yes | Connection strengh of related keywords: Misspelled keywords: Keyword Volume: Keywords: "keyword_contain": string — Contains all (exact matching) Language: | |
sort | Sort by data (ascending and descending) | array | yes | "keyword" | "keyword" - Sort results alphabetically "weight" - Sort results by the number of URLs in the top 20 results |
order | Sort direction | array | yes | "desc" | Sort direction (asc — ascending, desc — descending) |
page | Page number in response | int | yes | 1 | "page": 5 (any number value) |
size | Number of results per page in response | int | yes | 100 | "size": 10 (any number value) |
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
data | Array with data |
keyword | Related keyword |
region_queries_count | Search volume in selected region |
cost | Cost per click (USD), that is monthly updated. |
concurrency | Keyword competition in the PPC (0-100%) |
geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
types | List of special elements shown in SERP (for example, video, carousel or map) |
right_spelling | Recommended correction of a misspelled keyword |
weight | The number of URLs in the top 20 results, which are ranked by the search keyword and the keyword from the report. |
difficulty | The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 1 to 100) |
summary_info | Object with data |
page | Page number |
total | Total number of related keywords found |
left_lines | API credits remaining |
Credits: the number of charged credits corresponds to the number of results obtained upon request. With the Serpstat API, you can only get the first 60,000 results, regardless of the number and size of the queries themselves. For more data - use the export option in the Domain Analysis, Keyword Analysis, or URL Analysis sections, or contact the manager for a personal upload of the results. Part of the API response, for which 1 credit is charged:
{
"6 plus portrait dimensions": {
"keyword": "6 plus portrait dimensions",
"region_queries_count": 1,
"cost": 0,
"concurrency": 0,
"geo_names": [],
"types": [
"also_asks",
"video",
"related_search",
"snip_breadcrumbs"
],
"right_spelling": null,
"weight": 1,
"difficulty": null
}
{
"id": 1,
"method": "SerpstatKeywordProcedure.getRelatedKeywords",
"params": {
"keyword": "seo",
"se": "g_us",
"filters": {
"keyword_contain": "competitor",
"types": "also_asks"
},
"sort": {"keyword":"asc"},
"page": 1,
"size": 3
}
}
{
"id": "1",
"result": {
"data": [
{
"keyword": "how to competitor website analysis in hindi",
"region_queries_count": 1,
"cost": 0,
"concurrency": 0,
"geo_names": [],
"types": [
"also_asks",
"related_search",
"snip_breadcrumbs"
],
"right_spelling": null,
"weight": 1,
"difficulty": 11.026413636841786
}
],
"summary_info": {
"page": 1,
"total": 1,
"left_lines": 994613
}
}
}