URL keywords V4 (SerpstatUrlProcedure.getUrlKeywords)

SerpstatUrlProcedure.getUrlKeywords — this method brings in top keywords in the search engine for the given URL.

Request parameters:

Parameter	Description	Type	Optional	Default value	Value Options
url	URLs	string	no		https://allo.ua/
se	ID of the search base to be searched	string	no		g_ua, g_ru, ...
filters	Filter conditions	array	yes	{"top_size": 100}	{ "cost_from": "0.1", "cost_to": "3" }
sort	Sort order the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	array	yes	[ ] empty array	"sort": {"cnt": "asc"}
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

region_queries_count

cost

keyword_length

concurrency

difficulty

traff

region_queries_count_wide

dynamic

position

found_results

To filter the results, use the following parameters:

Parameter	Description	Possible values
position_from	Min keyword position	1-100
position_to	Max keyword position	1-100
queries_from	Min volume of monthly searches	0-100000000
queries_to	Max volume of monthly searches	0-100000000
cost_from	Min CPC	0-200
cost_to	Max CPC	0-200
concurrency_from	Min competition value	0-100
concurrency_to	Max competition value	0-100

Response metrics:

Metrics	Description
result	Contains the answer
total	Number of found keywords ranking the given domain in top-100
region_queries_count	Search volume in selected region
region_queries_count_wide	Search volume (broad match)
domain	Domain
keyword_length	Number of words divided by space in a keyword
keyword	Keyword
url	URL appeared in the search result for the query
dynamic	Position change for the keyword
traff	Estimated traffic to a website (number of visitors)
types	List of special elements shown in SERP (for example, video, carousel or map)
found_results	Number of results found for “keyword"
cost	Cost per click, $
concurrency	Keyword competition in the PPC (0-100)
position	Keyword position in search results
subdomain	Subdomain appeared in search results for a given keyword
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)
date	Position check date
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:

{
"domain": "allo.ua",
"subdomain": null,
"keyword": "алло",
"keyword_length": 1,
"url": "https://allo.ua/",
"position": 1,
"date": "2019-04-06",
"types": [
  "pic",
  "local_pack",
  "ads_top",
  "a_box_some",
  "kn_graph_card",
  "kn_graph_brand",
  "related_search",
  "snip_sitelinks",
  "snip_https",
  "snip_search_box"
],
"found_results": 13100000,
"cost": 0.00769553,
"concurrency": 61,
"region_queries_count": 550000,
"region_queries_count_wide": 0,
"geo_names": [
  
],
"traff": 550000,
"dynamic": 0,
}

Example PHP Python

Request data:

Response data: