Сompetitors in organic search results (deprecated)

The SerpstatDomainProcedure.getCompetitors method brings in the list of domain competitors in top 20 Google search results. The data set is similar to the Competitors report of the domain.

This request is deprecated. Please use a valid Competitors API request following this link.

General request parameters and instructions for using Serpstat API

Search databases available

Request parameters
Parameter	Description	Optional	Default value	Value options
id	A request id: the response contains the same id. Enter any number (number) or text (string) value	no		1, test
method	API method name	no		SerpstatDomainProcedure.getCompetitors
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	no
domain	Domain name	no	-	nike.com
se	ID of the search base to be searched.	no	-	g_us
sort	Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by: * visible * keywords * traff * visible_dynamic * keywords_dynamic * traff_dynamic * ads_dynamic * new_keywords * out_keywords * rised_keywords * down_keywords * ad_keywords * ads * intersected * relevance * new_relevance * our_relevance order — sort direction (asc — ascending, desc — descending)	yes	{"relevance":"desc"}	{"ads":"desc"}
size	Number of results per page in response	yes	100	"size": "50" min: 1, max: 1000
filters	Filter conditions	yes		"visible": 35 "visible_from":30 "visible_to": 70 "traff": 1000 "traff_from": 500 "traff_to": 5000 "minus_domains": ["domain.com". "domain2.com] "exluded_competitors": ["domain.com". "domain2.com] "keywords": 1000 "keywords_from": 1000 "keywords_to": 5000 relevance : 10 relevance_from : 5 relevance_to : 10

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
visible	Site visibility
domain	Domain
keywords	Number of keywords found in the chosen search engine
traff	Approximate traffic by keyword depending on its volume and position
visible_dynamic	Dynamics of visibility since the last update
keywords_dynamic	Dynamics of the number of keywords since the last update
traff_dynamic	Dynamics of estimate traffic since the last update
ads_dynamic	Dynamics of changes in PPC Ads
new_keywords	Number of new keywords for the domain since the last monitoring
out_keywords	Number of keywords lost by a domain since the last monitoring
rised_keywords	Number of domain keywords for which positions have improved since the last monitoring
down_keywords	Number of domain keywords for which positions have dropped since the last monitoring
ad_keywords	Number of keywords in the PPC
ads	Number of ads
intersected	Keywords domains have in common
not_intersected	Number of missed keywords of the domain that the competing domain ranks for
relevance	Relevance - calculates the percentage of similar keywords domains share (0-100%)
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. Part of the API response, for which 1 credit is charged:

 {
    "domain": "thesolesupplier.co.uk",
    "visible": 1.57363,
    "keywords": 273939,
    "traff": 987621,
    "visible_dynamic": 0.21043000000000012,
    "keywords_dynamic": 2761,
    "traff_dynamic": 82601,
    "ads_dynamic": 0,
    "new_keywords": 6341,
    "out_keywords": 3580,
    "rised_keywords": 11264,
    "down_keywords": 6878,
    "ad_keywords": 0,
    "ads": 0,
    "intersected": 192486,
    "not_intersected": 81453,
    "relevance": 70.27,
    "new_relevance": 7.04,
    "our_relevance": 7.26
},

Example PHP Python

Request data:

{
 "id": "1",
 "method": "SerpstatDomainProcedure.getCompetitors",
 "params": {
   "domain": "nike.com",
   "se": "g_us",
   "sort": {"relevance":"desc"},
   "size": "50"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "thesolesupplier.co.uk",
                "visible": 1.57363,
                "keywords": 273939,
                "traff": 987621,
                "visible_dynamic": 0.21043000000000012,
                "keywords_dynamic": 2761,
                "traff_dynamic": 82601,
                "ads_dynamic": 0,
                "new_keywords": 6341,
                "out_keywords": 3580,
                "rised_keywords": 11264,
                "down_keywords": 6878,
                "ad_keywords": 0,
                "ads": 0,
                "intersected": 192486,
                "not_intersected": 81453,
                "relevance": 70.27,
                "new_relevance": 7.04,
                "our_relevance": 7.26
            },
            {
                "domain": "snipesusa.com",
                "visible": 7.97392,
                "keywords": 211891,
                "traff": 4062386,
                "visible_dynamic": -0.3913399999999996,
                "keywords_dynamic": 1943,
                "traff_dynamic": -93418,
                "ads_dynamic": 6,
                "new_keywords": 13579,
                "out_keywords": 11636,
                "rised_keywords": 7644,
                "down_keywords": 10531,
                "ad_keywords": 30,
                "ads": 29,
                "intersected": 144601,
                "not_intersected": 67290,
                "relevance": 68.24,
                "new_relevance": 5.32,
                "our_relevance": 5.45
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 999311
        }
    }
}