List of domain URLs

The SerpstatDomainProcedure.getDomainUrls method returns the list of URLs within the analyzed domain and the number of keywords for each URL. The data set is similar to the Top pages report of the Domain Analysis, excluding the information about traffic and number of Facebook shares.

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. getDomainUrls
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 (there are both Google and Yandex databases available, for example: g_us or y_157).	no	-	g_us
sort	Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by: * keywords order — sort direction (asc — ascending, desc — descending)	yes	{"keywords":"desc"}	{"keywords":"asc"}
page	Page number in response	yes	1	"page": "5"
size	Number of results per page in response	yes	100	"size": "3" min: 1, max: 1000
filters	Filter conditions	yes		{"url_prefix": "https://www.apple.com/ipad/"} {"url_contain": "/ipad/"} {"url_not_contain": "/mac/"}

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
url	Domain's URL
keywords	Number of keywords which the URL ranks for
summary_info	Object with data
page	Page number
total	Number of found URLs
left_lines	API credits remaining

Part of the API response, for which 1 credit is charged:

{
    "url": "https://www.nike.com/",
    "keywords": 64785
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatDomainProcedure.getDomainUrls",
 "params": {
   "domain": "nike.com",
   "se": "g_us",
   "sort": {"keywords": "desc"},
   "page": "1",
   "size": "3"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "https://www.nike.com/",
                "keywords": 64785
            },
            {
                "url": "https://jobs.nike.com/",
                "keywords": 21450
            },
            {
                "url": "https://www.nike.com/w/womens-tops-t-shirts-5e1x6z9om13",
                "keywords": 16472
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 147457,
            "left_lines": 997007
        }
    }
}