v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Paid Keyword Competitors - Desktop

Returns a list of websites that are competing for the same paid keywords as the given domain, overlap score and % of shared keywords.

get/{domain_name}/search-competitors/paidsearchcompetitors

Path parameters

domain_namestring required

Enter website of interest, without 'www.' or brackets {}.

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.

main_domain_onlystring

[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').

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

global_rankinginteger

categorystring

category_rankinginteger

Example response

{
  "meta": {
    "query": {
      "limit": 100
    },
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "start_date": "2023-01-01",
      "end_date": "2023-03-31",
      "country": "us"
    },
    "status": "Success"
  },
  "data": [
    {
      "url": "couponboa.com",
      "score": 1.60356309174151,
      "shared_keywords": 0.75
    }
  ],
  "global_ranking": 90,
  "category": "News_and_Media",
  "category_ranking": 13
}