v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Top Sites - Desktop

Returns last month's top websites in a given category. Based on desktop traffic.

get/${category}/topsites/desktop

Path parameters

categorystring required

Category can be either "$All" or "${Category}", where {Category} is one value from the list available here: https://api.similarweb.com/v1/TopSites/categories.

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring required

Must be set to the last month of available data, in the YYYY-MM format. To retrieve, use the Check Capabilities endpoint and get the value returned in web_desktop_data/snapshot_interval/end_date.

end_datestring required

Must be set to the last month of available data, in the YYYY-MM format. To retrieve, use the Check Capabilities endpoint and get the value returned in web_desktop_data/snapshot_interval/end_date.

countrystring required

Country filter, as a 2-letter ISO country code, or "world" for worldwide. To see the country filters you have access to, please refer to the Check Capabilities endpoint.

formatstring

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

limitstring

[optional] Select the number of results that are returned. Default: 100.

offsetstring

[optional] Specify an offset from where to start returning data.

sortstring

[optional] The metric you'd like the results to be ordered by.

ascstring

[optional] The order of results. Enter "true" for ascending, or "false" for descending.

Response

200

Example response

{
  "meta": {
    "query": {
      "limit": 5
    },
    "request": {
      "format": "json",
      "domain": "$Arts_and_Entertainment~Music",
      "start_date": "2022-09-01",
      "end_date": "2022-09-30",
      "country": "gb"
    },
    "status": "Success",
    "last_updated": "2022-09-30"
  },
  "top_sites": [
    {
      "rank": 1,
      "domain": "spotify.com"
    }
  ]
}