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

NameInTypeRequiredEnumExampleDescription
domainpathstringYesDomain to fetch SimilarWeb data for
x-api-keyheaderstringYesAPI 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
PlanPriceIncluded creditsDaily capRate limitOverage
Free$0/mo2,000500 daily credits5/minNo overage
Starter$9/mo20,0005,000 daily credits15/min$0.75/1,000 overage credits when enabled
Growth$29/mo100,00025,000 daily credits45/min$0.45/1,000 overage credits when enabled
Pro$79/mo400,000No daily cap120/min$0.30/1,000 overage credits
Business$199/mo1,200,000No daily cap300/min$0.20/1,000 overage credits
Enterprise$499/mo5,000,000No daily cap1,000/min$0.12/1,000 overage credits

Catalog quality warnings

  • missing example for required path param: domain

Failure responses

StatusDescriptionSchema
400Invalid domain parameter#/definitions/app.Response
429Rate limit exceeded#/definitions/app.Response
500Internal 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

FieldTypeRequiredEnumBoundsExampleDescription
codeintegerNo200
datasimilarweb.SimilarWebRespNo
data.CategorystringNo
data.CategoryRankobjectNo
data.CategoryRank.CategorystringNo
data.CategoryRank.RankstringNo
data.CompetitorsobjectNo
data.Competitors.TopSimilarityCompetitorsarrayNo
data.CountriesarrayNo
data.Countries[].CodestringNo
data.Countries[].NamestringNo
data.Countries[].UrlCodestringNo
data.CountryRankobjectNo
data.CountryRank.CountryintegerNo
data.CountryRank.CountryCodestringNo
data.CountryRank.RankintegerNo
data.DescriptionstringNo
data.EngagmentsobjectNo
data.Engagments.BounceRatestringNo
data.Engagments.MonthstringNo
data.Engagments.PagePerVisitstringNo
data.Engagments.TimeOnSitestringNo
data.Engagments.VisitsstringNo
data.Engagments.YearstringNo
data.EstimatedMonthlyVisitsobjectNo
data.EstimatedMonthlyVisits.2024-09-01integerNo
data.EstimatedMonthlyVisits.2024-10-01integerNo
data.EstimatedMonthlyVisits.2024-11-01integerNo
data.GlobalCategoryRankunknownNo
data.GlobalRankobjectNo
data.GlobalRank.RankintegerNo
data.IsDataFromGabooleanNo
data.IsSmallbooleanNo
data.LargeScreenshotstringNo
data.NotificationobjectNo
data.Notification.ContentunknownNo
data.PolicyintegerNo
data.SiteNamestringNo
data.SnapshotDatestringNo
data.TitlestringNo
data.TopCountrySharesarrayNo
data.TopCountryShares[].CountryintegerNo
data.TopCountryShares[].CountryCodestringNo
data.TopCountryShares[].ValuenumberNo
data.TopKeywordsarrayNo
data.TopKeywords[].CpcnumberNo
data.TopKeywords[].EstimatedValuenumberNo
data.TopKeywords[].NamestringNo
data.TopKeywords[].VolumenumberNo
data.TrafficSourcesobjectNo
data.TrafficSources.DirectnumberNo
data.TrafficSources.MailnumberNo
data.TrafficSources.Paid ReferralsnumberNo
data.TrafficSources.ReferralsnumberNo
data.TrafficSources.SearchnumberNo
data.TrafficSources.SocialnumberNo
data.VersionintegerNo
msgstringNoOK

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();