v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

SERP Players

The top websites driving search traffic for a specified keyword or custom keyword list.

get/{keyword}/analysis/competitors

Path parameters

keywordstring required

Enter a keyword of interest or a keyword list by ID, without brackets {}. Keyword list ids should be prefixed with '*'.

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring

Start month (format: YYYY-MM)

end_datestring

End month (format: YYYY-MM)

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.

traffic_sourcestring

[optional] Set the traffic source type. Possible values: Organic, Paid, or All.

web_sourcestring

[optional] Select the web source. Possible values: Desktop, MobileWeb, or Total.

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. Possible values: Clicks or Position.

ascstring

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

Response

200

total_countinteger

Example response

{
  "competitors": [
    {
      "site": "cars.com",
      "domain": "cars.com",
      "clicks": 50775.49137690909,
      "traffic_share": 0.29779685273586604,
      "serp_features": [
        "organic_inline_sitelinks"
      ],
      "position": 3,
      "top_url": "cars.com"
    }
  ],
  "total_count": 261,
  "meta": {
    "query": {
      "limit": 10,
      "sort": "Clicks"
    },
    "request": {
      "web_source": "Total",
      "traffic_source": "All",
      "country": "us",
      "keyword": "car",
      "format": "json",
      "start_date": "2024-01-01",
      "end_date": "2024-01-01"
    },
    "status": "Success",
    "last_updated": "2024-11-30"
  }
}