URL keywords V4 (SerpstatUrlProcedure.getUrlKeywords)

The SerpstatUrlProcedure.getUrlKeywords method returns keywords that URL ranks for in Google top-100 or Yandex top-50 search results. The data set is similar to the URL analysis — SEO research — Keywords report.

General request parameters and instructions for using Serpstat API

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		SerpstatUrlProcedure.getUrlKeywords
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	no
url	URLs	string	no		https://www.nike.com/men
se	ID of the search base to be searched	string	no		g_us
filters	Filter conditions	array	yes	{"top_size": 100}	{ "cost_from": "0.1", "cost_to": "3" }
sort	Order of sorting the results in the format {{{field}}: {{order}}} field — field to sort by: * region_queries_count * cost * keyword_length * concurrency * difficulty * traff * region_queries_count_wide * dynamic * position * found_results order — sort direction (asc — ascending, desc — descending)	array	yes	[ ] empty array	"sort": {"cnt": "asc"}
page	Page number in response	int	yes	1	"page": "5"
size	Number of results per page in response	int	yes	100	"size": "10" min: 1, max: 1000

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 parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
domain	Domain
subdomain	Subdomain which ranks for the keyword
keyword	Keyword which the URL ranks for
keyword_length	Number of words divided by space in a keyword
url	URL appeared in the search result for the query
position	URL's position for a keyword
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)
region_queries_count	Search volume in selected region
region_queries_count_wide	Search volume (broad match)
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
traff	Approximate traffic by keyword depending on its volume and position
difficulty	The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)
dynamic	How the position of this keyword has changed
summary_info	Object with data
page	Page number
total	Number of found keywords ranking the given domain in top
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 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "keyword": "man nike",
    "keyword_length": 2,
    "url": "https://www.nike.com/men",
    "position": 1,
    "types": [
        "snip_breadcrumbs"
        ],
    "found_results": 656000000,
    "cost": 0.38,
    "concurrency": 100,
    "region_queries_count": 40500,
    "region_queries_count_wide": 0,
    "geo_names": [],
    "traff": 6071,
    "difficulty": null,
    "dynamic": 0
},

Example

Request data:

{
    "id": "1",
    "method": "SerpstatUrlProcedure.getUrlKeywords",
    "params": {
        "se": "g_us",
        "url": "https://www.nike.com/men",
        "filters": {"queries_from": "10000", "queries_to": "100000"},
        "sort": {"position": "asc"},
        "page": "1",
        "size": "10"
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "nike.com",
                "subdomain": "www.nike.com",
                "keyword": "man nike",
                "keyword_length": 2,
                "url": "https://www.nike.com/men",
                "position": 1,
                "types": [
                    "snip_breadcrumbs"
                ],
                "found_results": 656000000,
                "cost": 0.38,
                "concurrency": 100,
                "region_queries_count": 40500,
                "region_queries_count_wide": 0,
                "geo_names": [],
                "traff": 6071,
                "difficulty": null,
                "dynamic": 0
            },
            {
                "domain": "nike.com",
                "subdomain": "www.nike.com",
                "keyword": "mens nike",
                "keyword_length": 2,
                "url": "https://www.nike.com/men",
                "position": 1,
                "types": [
                    "snip_breadcrumbs"
                ],
                "found_results": 93,
                "cost": 0.38,
                "concurrency": 100,
                "region_queries_count": 40500,
                "region_queries_count_wide": 0,
                "geo_names": [],
                "traff": 6071,
                "difficulty": 81.58723943676779,
                "dynamic": 0
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 61,
            "left_lines": 998269
        }
    }
}