Domain Top Pages (get_top_urls)

API v3 methods will be unavailable from 03/01/2022. Use a similar API v4 method.

The get_top_urls method returns website pages in hierarchical order. Also, it shows the number of keywords from Google top-100 or Yandex top-50 for each URL, approximate traffic of the page and Facebook shares. The data set is similar to the Top pages report of the Domain 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)

Following parameters can be used for sorting:
sort: field that needs to be sorted
order: sorting order (asc - ascending, desc - descending)

Response parameters
Parameter	Description
result	Contains the answer
total	The total number of the website pages
hits	Contains the answer
url	URL of the domain
organic_keywords	The number of keywords the URL ranks for in Google top-100 or Yandex top-50 results
facebook_shares	The number of Facebook shares of the researched domain's page
potencial_traff	The approximate traffic of the page by keywords depending on its volume and position
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:

{
    "url": "https://www.nike.com/",
    "organic_keywords": 65134,
    "facebook_shares": 701305,
    "potencial_traff": 39481276
},

Example

Request data:

api.serpstat.com/v3/get_top_urls?query=nike.com&se=g_us&token=XXX&order=desc&sort=organic_keywords&page_size=100&page=1

Response data:

{
    "result": {
        "total": 147181,
        "hits": [
            {
                "url": "https://www.nike.com/",
                "organic_keywords": 65134,
                "facebook_shares": 701305,
                "potencial_traff": 39481276
            },
            {
                "url": "https://jobs.nike.com/",
                "organic_keywords": 20392,
                "facebook_shares": 614,
                "potencial_traff": 121679
            }
        ]
    },
    "status_msg": "OK",
    "status_code": 200,
    "left_lines": 997717
}