Keyword overview
The SerpstatKeywordProcedure.getKeywordsInfo method provides you with the keyword overview showing its volume,
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. Enter any number (number) or text (string) value | int/string | no | 1, test | |
| method | API method name | string | no | SerpstatKeywordProcedure.getKeywordsInfo | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | no |
| |
| keywords | Array with keywords to search for | array | no | ["iphone", "iphone 11"] | |
| se | ID of the search base to be searched. | string | no | g_us | |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} | array | yes | [ ]empty array | {"cost": "desc"} |
| filters | Filter conditions | array | yes |
"right_spelling": true$ "right_spelling": false "minus_keywords": ["case", "red"] "cost": "10"; "concurrency": "7"; "found_results": "100"; "region_queries_count": "1000"; "region_queries_count_wide": "1000"; | |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| keyword | Keyword |
| cost | Cost per click, $ |
| concurrency | Keyword competition in PPC (0-100%) |
| found_results | Number of results found for the keyword |
| region_queries_count | Search volume in the selected region |
| region_queries_count_wide | Search volume (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 by the keyword |
| right_spelling | Recommended correction of a misspelled keyword |
| lang | Language |
| difficulty | Competition level for a keyword to advance in organic search in the top-10 positions |
| suggestions_count | Number of search suggestions |
| keywords_count | Number of keywords |
| summary_info | Object with data |
| page | Page number |
| left_lines | API credits remaining |
Credits: the number of charged credits corresponds to the number of results obtained upon request. You can get no more than 1000 results per a query. Part of the API response, for which 1 credit is charged:
{
"region_queries_count": 1220000,
"region_queries_count_wide": 1000000,
"cost": 1.43,
"concurrency": 100,
"keyword": "iphone",
"found_results": 7450000000,
"types": [
"related_search",
"pic"
],
"geo_names": [],
"social_domains": [
"youtube",
"amazon",
"wikipedia",
"reddit"
],
"right_spelling": null,
"difficulty": 76,
"lang": "en",
"suggestions_count": 0,
"keywords_count": 54222
}{
"id": "1",
"method": "SerpstatKeywordProcedure.getKeywordsInfo",
"params": {
"keywords": [
"iphone",
"iphone 11"
],
"se": "g_us",
"filters": {
"cost_from": 0.7,
"region_queries_count_from": 100,
"minus_keywords": ["case","red"]
}
}
}{
"id": "1",
"result": {
"data": [
{
"region_queries_count": 1220000,
"region_queries_count_wide": 1000000,
"cost": 1.43,
"concurrency": 100,
"keyword": "iphone",
"found_results": 7450000000,
"types": [
"related_search",
"pic"
],
"geo_names": [],
"social_domains": [
"youtube",
"amazon",
"wikipedia",
"reddit"
],
"right_spelling": null,
"difficulty": 76,
"lang": "en",
"suggestions_count": 0,
"keywords_count": 54222
}
],
"summary_info": {
"page": 1,
"left_lines": 999977
}
}
}