Keywords selection
The SerpstatKeywordProcedure.getKeywords shows organic keywords associated with the researched keyword that domains are ranking for in Google`s top-100 results and for every found keyword you’ll see its volume, CPC and level of competition. The data set is similar to the Keyword research — SEO research — Keywords selection report.
General request parameters and instructions for using Serpstat API
Search databases available
Request parameters | |||||
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.getKeywords | |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | no |
| |
keyword | Keyword to search for | string | no | "iphone" (any text value) | |
se | ID of the search base to be searched. | string | no | g_us (search databases list) | |
minusKeywords | Negative keyword array | array | yes | ["app", "apple"] — array of excluding keywords | |
withIntents | Keyword intent | boolean | yes | false | true | false |
filters | Filter conditions | array | yes | Cost: Volume: Number of words in phrase: Difficulty: Concurrency: Right spelling: Intents: intents_contain — Contains one or several of intents, informational, navigational, commercial, transactional; intents_not_contain — Does not contain one of the intents, informational, navigational, commercial, transactional; | |
sort | Sort by data (ascending and descending) | array | yes | "cost": "asc" "region_queries_count": "desc | "keyword_length" — Sort results by keyword length "difficulty" — Sort the results by the level of keywords competition level to advance in organic search in the top-10 "cost" — Sort results by cost per click (in USD) "region_queries_count" — Sort results by frequency of a key phrase in the selected region |
order | sort direction | array | yes | "cost": "asc" "region_queries_count": "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 | Suggested keyword |
cost | Cost per click, $ |
concurrency | Keyword competition in the PPC (0-100%) |
found_results | Number of results found for the keyword |
region_queries_count | Search volume in a selected region |
region_queries_count_wide | Search volume in selected search engine database in broad match |
types | List of special elements shown in SERP (for example, video, carousel or map) |
geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
social_domains | Social domains listed top-10 for a selected keyword |
right_spelling | Recommended correction of a misspelled keyword |
lang | Language of the keyword |
intents | Intents of the analyzed keyword |
keyword_lenght | Number of words divided by space in a keyword |
difficulty | The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100) |
summary_info | Object with data |
page | Page number |
total | Number of found results |
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:
{
"keyword": "iphone c price canada",
"cost": 0,
"concurrency": 0,
"found_results": 0,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"types": [
"also_asks",
"a_box_fsnippet"
],
"geo_names": [
"canada"
],
"social_domains": [
"youtube",
"wikipedia"
],
"right_spelling": "iphone x price canada",
"lang": "en",
"keyword_length": 4
}
{
"id": "1",
"method": "SerpstatKeywordProcedure.getKeywords",
"params": {
"keyword": "iphone",
"se": "g_us",
"minusKeywords": ["app", "apple"],
"withIntents": true,
"filters": {
"lang": "en",
"intents_contain": ["commercial"],
"intents_not_contain":["navigational"]
},
"sort": {"region_queries_count": "asc"},
"page": 1,
"size": 2
}
}
{
"id": "1",
"result": {
"data": [
{
"region_queries_count": 0,
"region_queries_count_wide": 0,
"cost": 0,
"concurrency": 0,
"keyword": "best tws under 10000 for iphone",
"keyword_length": 6,
"found_results": 0,
"types": [],
"geo_names": [],
"social_domains": [],
"right_spelling": null,
"difficulty": null,
"lang": "en",
"intents": [
"commercial"
]
},
{
"keyword": "compare iphone 4 deals",
"cost": 0,
"concurrency": 0,
"found_results": 60700000,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"types": [],
"geo_names": [],
"social_domains": [],
"right_spelling": null,
"lang": "en",
"keyword_length": 4,
"difficulty": null,
"intents": [
"commercial"
]
}
],
"summary_info": {
"page": 1,
"total": 110101,
"left_lines": 499625
}
}
}
Serpstat API request drafts: link