URL Report

2.3.1. URL Organic Keywords (url_keywords)

API v3 methods will be unavailable from 12/31/2021. Use a similar API v4 method.

The url_keywords 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. You can get up to 60 000 results in this report.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000);
page: page number (set to the 1st page by default).

You can use the following parameters to filter the results:

Response parameters
Parameter	Description
result	Contains the answer
total	Number of keywords for which the page ranks in top-100
hits	Contains the answer
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 of a page which appears in SERP for the keyword
position	URL's position for a keyword
types	A list of special elements shown in SERP (for example, video, carousel or map)
found_results	The number of results found for keyword
cost	Cost per click, $
concurrency	Keyword competition in PPC (0-100%)
region_queries_count	Search volume in selected search engine database
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
status_msg	Response "Ok" or "Error" report on a successful or unsuccessful request
status_code	Response code 200 — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines	API credits remaining

Part of the API response for which you spend 1 credit:

{
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "keyword": "man nike",
    "keyword_length": 2,
    "keyword_id": "136766933",
    "keyword_crc": -686015656,
    "url": "https://www.nike.com/men",
    "position": 1,
    "types": [
        "snip_breadcrumbs"
        ],
    "found_results": 564000000,
    "cost": 0.38,
    "concurrency": 100,
    "region_queries_count": 40500,
    "region_queries_count_wide": 0,
    "url_crc": 866156381,
    "geo_names": [],
    "traff": 6071,
    "difficulty": null,
    "dynamic": 0,
    "modified_date": "2021-07-06",
    "_id": "136766933-1"
},

2.3.2. List of URLs that compete with a queried page (url_competitors)

API v3 methods will be unavailable from 12/31/2021. Use a similar API v4 method.

The url_competitors method returns the list of URL competitors to the queried URL. The data set is similar to the Competitors report in the URL analysis.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter	Description
result	Contains the answer
total	Number of keywords for which URL ranks in top-10
hits	Contains the answer
cnt	Number of keywords in the top 10 for which pages intersect
domain	Competitor's domain
url	Competitor's URL
status_msg	Response "Ok" or "Error" report on a successful or unsuccessful request
status_code	Response code 200 — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines	API credits remaining

Part of the API response for which you spend 1 credit:

{
    "cnt": 230,
    "domain": "nike.com",
    "url": "https://www.nike.com/w/mens-shoes-nik1zy7ok",
    "url_crc": -1410140829
},

2.3.3. Competitor's keywords that are missing from a queried page (url_missing_keywords)

API v3 methods will be unavailable from 12/31/2021. Use a similar API v4 method.

The url_missing_keywords method shows a list of keywords that competitors' URLs rank for in top-10 but that are missing from the queried page. The data set is similar to the Missing keywords report in the URL analysis.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

Response parameters
Metrics	Description
result	Contains the answer
total	Results found
hits	Contains the answer
region_queries_count	Search volume in selected search engine database
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
types	A list of special elements shown in SERP (for example, video, carousel or map)
cost	Cost per click, $
region_queries_count_wide	Search volume (broad match)
keyword	Keyword that competitors are ranking for in top-10 search results, while the analyzed page is not ranking for these search queries even in Google`s top-100 results.
concurrency	Keyword competition in PPC (0-100%)
weight	Connection strength (How many competitors rank for this keyword)
status_msg	Response "Ok" or "Error" report on a successful or unsuccessful request
status_code	Response code 200 — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines	API credits remaining

Part of the API response for which you spend 1 credit:

{
    "region_queries_count": 210,
    "geo_names": [],
    "types": [
        "carousel",
        "also_asks",
        "video",
        "snippet_breadcrumbs"
        ],
    "cost": 1.987967,
    "keyword_id": 35038615,
    "region_queries_count_wide": 0,
    "keyword": "buy nike online",
    "concurrency": 100,
    "weight": 10
},

2.3.4. 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

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		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 (there are both Google and Yandex databases available, for example: g_us or y_157)	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
},

2.3.5. URL lists competing with the page V4

The SerpstatUrlProcedure.getUrlCompetitors method returns the list of URL competitors to the queried URL. The data set is similar to the Competitors report in the URL analysis.

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.getUrlCompetitors
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	no
url	URLs for finding competing URLs	string	no		https://www.nike.com
se	ID of the search base to be searched	string	no		g_us
sort	Order of sorting the results in the format {{{field}}: {{order}}} field — field to sort by: * cnt order — sort direction (asc — ascending, desc — descending)	array	yes	[ ] empty array	{"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

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
domain	Competitor’s domain
url	Competitor’s page
cnt	Number of keywords in the top 10 for which pages intersect
summary_info	Object with data
page	Page number
total	Number of keywords in top-100
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": "footlocker.com",
    "url": "https://www.footlocker.com/category/brands/nike.html",
    "cnt": 93
},

2.3.6. Competitor’s keywords missing on the specified page V4 (SerpstatUrlProcedure.getUrlMissingKeywords)

The SerpstatUrlProcedure.getUrlMissingKeywords method returns keywords that competitors are ranking for but the given URL isn’t ranking for them. The data set is similar to Missing keywords report in the URL analysis.

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.getUrlMissingKeywords
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	no
url	Analyzed URL	string	no		https://www.nike.com
se	ID of the search base to be searched	string	no		g_us
sort	Order of sorting the results in the format {{{field}}: {{order}}} field — field to sort by: * weight order — sort direction (asc — ascending, desc — descending)	array	yes	[ ]empty array	{"weight": "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

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
region_queries_count	Search volume in selected region
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
types	List of special elements shown in SERP (for example, video, carousel or map)
cost	Cost per click, $
region_queries_count_wide	Search volume (broad match)
keyword	Keyword that competitors are ranking for in top-10 search results, while the analyzed page is not ranking for these search queries even in Google`s top-100 results.
concurrency	Keyword competition in PPC (0-100%)
weight	Connection strength shows the number of competitors who are ranking for the given keyword
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 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
    "region_queries_count": 1220000,
    "geo_names": [],
    "types": [
        "ads_bot",
        "also_asks",
        "kn_graph_carousel_list",
        "shopping_rhs",
        "shopping_top",
        "snip_breadcrumbs"
        ],
    "cost": 0.58999999999999997,
    "region_queries_count_wide": 0,
    "keyword": "shoes",
    "concurrency": 100,
    "weight": 2
},

2.3.7. Traffic by URL mask V4 (SerpstatUrlProcedure.getSummaryTraffic)

The SerpstatUrlProcedure.getSummaryTraffic method brings in traffic report by URL mask.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Optional	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.getSummaryTraffic
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	no
domain	Domain to be searched	string	no	adidas.com
se	ID of the search base to be searched	string	no	g_us
urlContains	Searched part of URL	string	no	/women-shoes

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
totalTraff	Total organic traffic found by URL mask
urls	Number of URLs to be searched
summary_info	Object with data
left_lines	API credits remaining

Credits: When calculating used credits any API queries are taken into account in accordance with you pricing plan. This method charges 1000 API limits for a query.

Метод	Название процедуры	Логика списания средств
1. Отправка ключевых фраз на Парсинг частотности	SerpstatTaskProcedure.addKeywordListFreq	Количество фраз * стоимость фразы = количество списанных средств
2. Получение результатов Парсинга частотности	SerpstatTaskProcedure.getTaskResult
3. Статус пробивки в рамках Парсинга частотности	SerpstatTaskProcedure.getTaskStatus