Keywords for V4 words (SerpstatKeywordProcedure.getKeywords)

SerpstatKeywordProcedure.getKeywords — this method performs a full-text search with a keyword and provides data for found keywords (frequency, cost per click, competition level).

Request parameters:

Parameter	Description	Type	Optional	Default value	Value Options
keyword	Keyword to search for	string	no		to buy a car
se	ID of the search base to be searched	string	no		g_ua, g_ru, ...
minusKeywords	Negative keyword array	array	yes	[ ]empty array
filters	Filter conditions	array	yes		{"cost_from": 0.1}
sort	Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	array	yes	['cost' => 'asc', 'region_queries_count' => 'desc']	{"keyword": "desc"} or ['cost' => 'asc', 'region_queries_count' => 'desc']
page	Page number in response	int	yes	1	5
size	Number of results per page in response	int	yes	100	"size": {{page_size}} min: 1, max: 1000

Sorting results is possible by the following fields:

Parameter

cost

concurrency

found_results

region_queries_count

region_queries_count_wide

keyword_length

To filter the results, use the following parameters:

Parameter	Description	Possible values
queries_from	min number of monthly searches	0-100000000
queries_to	max number of monthly searches	0-100000000
cost_from	min CPC	0-200
cost_to	max CPC	0-200
concurrency_from	min competition for PPC keyword	0-100
concurrency_to	max competition for PPC keyword	0-100
minus_keywords	Negative keywords filter (a list of keywords separated by a comma)	string

Response metrics:

Metrics	Description
result	Contains the answer
total	Number of ads found that appear for queries containing the search word
keyword	Contains the answer
cost	Search volume in selected search engine database
concurrency	Search volume (broad match)
found_results	Search volume (last month)
region_queries_count	Domain
region_queries_count_wide	Number of words divided by space in a keyword
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
keyword_length	Number of words divided by space in a keyword
lang	Language
left_lines	Number of remaining API lines

Limits: the number of charged limits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query.

Part of the API response, for which 1 credit is charged:

{
"keyword": "chrome google play music",
"cost": 0,
"concurrency": 14,
"found_results": 312000000,
"region_queries_count": 10,
"region_queries_count_wide": 0,
"types": [
  "pic",
  "related_search"
],
"geo_names": [
  
],
"social_domains": [
  "wikipedia",
  "reddit",
  "spotify"
],
"right_spelling": null,
"keyword_length": 4,
"lang": "en"
}

Example PHP Python

Request data:

{
 "id": {{any_num_or_string}},
 "method": "SerpstatKeywordProcedure.getKeywords",
 "params": {
   "keyword": {{keyword}},
   "se": {{search_engine}},
   (optional) "minusKeywords": [{{keyword}}],
   (optional) "sort": { {{field}}: {{"asc"|"desc"}}},
   (optional) "filters": { {{field}}: {{value}}},
   (optional) "page": {{page}},
   (optional) "size": {{page_size}}
 }
}

Response data:

{
  "id": {{your_num_or_string}},
  "result": {
    "data": [
      {
        "keyword": "chrome google play music",
        "cost": 0,
        "concurrency": 14,
        "found_results": 312000000,
        "region_queries_count": 10,
        "region_queries_count_wide": 0,
        "types": [
          "pic",
          "related_search"
        ],
        "geo_names": [
          
        ],
        "social_domains": [
          "wikipedia",
          "reddit",
          "spotify"
        ],
        "right_spelling": null,
        "keyword_length": 4,
        "lang": "en"
      },
      {
        "keyword": "google play music эквалайзер",
        "cost": 0,
        "concurrency": 8,
        "found_results": 0,
        "region_queries_count": 10,
        "region_queries_count_wide": 0,
        "region_queries_count_phrase": 0,
        "types": [
          
        ],
        "geo_names": [
          
        ],
        "social_domains": [
          
        ],
        "right_spelling": null,
        "keyword_length": 4,
        "lang": "",
      },
      ................................................
    ],
    "summary_info": {
      "page": 1,
      "left_lines": 99268,
      "total": 3809
    }
  }
}