Competitors
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
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.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 | 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" |
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
},
{
"id": "1",
"method": "SerpstatUrlProcedure.getUrlCompetitors",
"params": {
"se": "g_us",
"url": "https://www.nike.com",
"sort": {"cnt": "desc"},
"page": "1",
"size": "10"
}
}
{
"id": "1",
"result": {
"data": [
{
"domain": "footlocker.com",
"url": "https://www.footlocker.com/category/brands/nike.html",
"cnt": 93
},
{
"domain": "nike.com",
"url": "https://www.nike.com/w/sale-3yaep",
"cnt": 59
},
{
"domain": "finishline.com",
"url": "https://www.finishline.com/nike",
"cnt": 49
}
],
"summary_info": {
"page": 1,
"total": 356,
"left_lines": 998149
}
}
}