SimilarWeb API endpoint
Get SimilarWeb Web Info
Returns traffic and engagement data from SimilarWeb for a specific domain.
GETapiKey5 credits/requestsimilarweb.webResponseDoc
/similarweb/web/{domain}Parameters
| Name | In | Type | Required | Enum | Example | Description |
|---|---|---|---|---|---|---|
| domain | path | string | Yes | Domain to fetch SimilarWeb data for | ||
| x-api-key | header | string | Yes | API key required |
Authentication
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Billing
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
- Credit cost
- 5 credits/request
- Charged response
- Successful 2xx responses
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
Catalog quality warnings
- missing example for required path param: domain
Failure responses
| Status | Description | Schema |
|---|---|---|
| 400 | Invalid domain parameter | #/definitions/app.Response |
| 429 | Rate limit exceeded | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
Example response
{
"code": 200,
"msg": "OK",
"data": {
"Version": 1,
"SiteName": "twitter.com",
"Description": "From breaking news and entertainment to sports and politics, get the full story with all the live commentary.",
"TopCountryShares": [
{
"Country": 392,
"CountryCode": "JP",
"Value": 0.3886359126251819
}
],
"Title": "X. It’s what’s happening",
"Engagments": {
"BounceRate": "0.626620066147028",
"Month": "3",
"Year": "2025",
"PagePerVisit": "4.291857840125687",
"Visits": "108138913",
"TimeOnSite": "116.0778597932444"
}
}
}Request schema
No body schema
Response schema
#/definitions/similarweb.webResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | similarweb.SimilarWebResp | No | ||||
| data.Category | string | No | ||||
| data.CategoryRank | object | No | ||||
| data.CategoryRank.Category | string | No | ||||
| data.CategoryRank.Rank | string | No | ||||
| data.Competitors | object | No | ||||
| data.Competitors.TopSimilarityCompetitors | array | No | ||||
| data.Countries | array | No | ||||
| data.Countries[].Code | string | No | ||||
| data.Countries[].Name | string | No | ||||
| data.Countries[].UrlCode | string | No | ||||
| data.CountryRank | object | No | ||||
| data.CountryRank.Country | integer | No | ||||
| data.CountryRank.CountryCode | string | No | ||||
| data.CountryRank.Rank | integer | No | ||||
| data.Description | string | No | ||||
| data.Engagments | object | No | ||||
| data.Engagments.BounceRate | string | No | ||||
| data.Engagments.Month | string | No | ||||
| data.Engagments.PagePerVisit | string | No | ||||
| data.Engagments.TimeOnSite | string | No | ||||
| data.Engagments.Visits | string | No | ||||
| data.Engagments.Year | string | No | ||||
| data.EstimatedMonthlyVisits | object | No | ||||
| data.EstimatedMonthlyVisits.2024-09-01 | integer | No | ||||
| data.EstimatedMonthlyVisits.2024-10-01 | integer | No | ||||
| data.EstimatedMonthlyVisits.2024-11-01 | integer | No | ||||
| data.GlobalCategoryRank | unknown | No | ||||
| data.GlobalRank | object | No | ||||
| data.GlobalRank.Rank | integer | No | ||||
| data.IsDataFromGa | boolean | No | ||||
| data.IsSmall | boolean | No | ||||
| data.LargeScreenshot | string | No | ||||
| data.Notification | object | No | ||||
| data.Notification.Content | unknown | No | ||||
| data.Policy | integer | No | ||||
| data.SiteName | string | No | ||||
| data.SnapshotDate | string | No | ||||
| data.Title | string | No | ||||
| data.TopCountryShares | array | No | ||||
| data.TopCountryShares[].Country | integer | No | ||||
| data.TopCountryShares[].CountryCode | string | No | ||||
| data.TopCountryShares[].Value | number | No | ||||
| data.TopKeywords | array | No | ||||
| data.TopKeywords[].Cpc | number | No | ||||
| data.TopKeywords[].EstimatedValue | number | No | ||||
| data.TopKeywords[].Name | string | No | ||||
| data.TopKeywords[].Volume | number | No | ||||
| data.TrafficSources | object | No | ||||
| data.TrafficSources.Direct | number | No | ||||
| data.TrafficSources.Mail | number | No | ||||
| data.TrafficSources.Paid Referrals | number | No | ||||
| data.TrafficSources.Referrals | number | No | ||||
| data.TrafficSources.Search | number | No | ||||
| data.TrafficSources.Social | number | No | ||||
| data.Version | integer | No | ||||
| msg | string | No | OK |
Example request
curl -X GET "https://api.crawlora.net/api/v1/similarweb/web/%3Cdomain%3E" -H "x-api-key: <api-key>"
TypeScript fetch
const url = new URL("https://api.crawlora.net/api/v1/similarweb/web/%3Cdomain%3E");
const headers = new Headers();
headers.set("x-api-key", "<api-key>");
const response = await fetch(url, {
method: "GET",
headers,
});
const payload = await response.json();