GET
/
{domain_name}
/
search-competitors
/
paidsearchcompetitors
Paid Keyword Competitors - Desktop
curl --request GET \
  --url https://api.similarweb.com/v4/website/{domain_name}/search-competitors/paidsearchcompetitors
"{\n  \"meta\": {\n    \"query\": {\n      \"limit\": 100,\n      \"offset\": 0,\n      \"asc\": null,\n      \"sort\": null\n    },\n    \"request\": {\n      \"main_domain_only\": false,\n      \"show_verified\": false,\n      \"state\": null,\n      \"format\": \"json\",\n      \"domain\": \"cnn.com\",\n      \"start_date\": \"2023-01-01\",\n      \"end_date\": \"2023-03-31\",\n      \"country\": \"us\"\n    },\n    \"status\": \"Success\"\n  },\n  \"data\": [\n    {\n      \"url\": \"couponboa.com\",\n      \"score\": 1.60356309174151,\n      \"shared_keywords\": 0.75\n    },\n    {\n      \"url\": \"dealsdiscountcode.com\",\n      \"score\": 1.414208477577366,\n      \"shared_keywords\": 0.375\n    },\n    {\n      \"url\": \"infinitevouchers.com\",\n      \"score\": 0.9701373018650982,\n      \"shared_keywords\": 0.2857142857142857\n    },\n    {\n      \"url\": \"couponfreecodes.com\",\n      \"score\": 0.6488776322716807,\n      \"shared_keywords\": 0.07142857142857142\n    },\n    {\n      \"url\": \"coupontemple.com\",\n      \"score\": 0.6246866662387317,\n      \"shared_keywords\": 0.06451612903225806\n    },\n    {\n      \"url\": \"foreo.com\",\n      \"score\": 0.6246866662387317,\n      \"shared_keywords\": 0.06451612903225806\n    },\n    {\n      \"url\": \"shipthedeal.com\",\n      \"score\": 0.42531032018892073,\n      \"shared_keywords\": 0.015873015873015872\n    },\n    {\n      \"url\": \"alrigh.com\",\n      \"score\": 0.3980015176533657,\n      \"shared_keywords\": 0.02197802197802198\n    },\n    {\n      \"url\": \"couponmonger.com\",\n      \"score\": 0.365140989863244,\n      \"shared_keywords\": 0.05\n    },\n    {\n      \"url\": \"couponkind.com\",\n      \"score\": 0.24998911907822927,\n      \"shared_keywords\": 0.018518518518518517\n    },\n    {\n      \"url\": \"couponfollow.com\",\n      \"score\": 0.15449877125309963,\n      \"shared_keywords\": 0.0030303030303030303\n    },\n    {\n      \"url\": \"couponcause.com\",\n      \"score\": 0.12800447242618254,\n      \"shared_keywords\": 0.0013729977116704805\n    }\n  ],\n  \"global_ranking\": 90,\n  \"category\": \"News_and_Media\",\n  \"category_ranking\": 13\n}"

Path Parameters

​
domain_name
string
default:amazon.com
required

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

Query Parameters

​
api_key
string
default:Add_Your_API_KEY
required

Your Similarweb API key.

​
start_date
string
default:2023-01

Start month (format: YYYY-MM)

​
end_date
string
default:2023-03

End month (format: YYYY-MM)

​
country
string
default:us
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_only
string
default:false

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

​
format
string
default:json

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

​
limit
string
default:100

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

​
offset
string

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

​
sort
string

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

​
asc
string

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

Response

200 - application/json

200

The response is of type object.