SimilarWeb API endpoint

Search SimilarWeb Info

Returns SimilarWeb data for a given query (typically a domain).

GETapiKey5 credits/requestsimilarweb.searchResponseDoc/similarweb/search

Parameters

Name	In	Type	Required	Enum	Example	Description
q	query	string	Yes			Domain or keyword to search
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 query param: q

Failure responses

Status	Description	Schema
400	Invalid query 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": {
    "apps": {
      "googlePlay": [
        {
          "id": "com.google.android.apps.photos",
          "name": "Google Photos",
          "publisher": "Google LLC",
          "appKey": "0_com.google.android.apps.photos",
          "store": "google",
          "ratings": 51693148
        }
      ],
      "appStore": [
        {
          "id": "507874739",
          "name": "Google Drive",
          "publisher": "Google LLC",
          "appKey": "1_507874739",
          "store": "apple",
          "ratings": 6753918
        }
      ]
    },
    "websites": [
      {
        "name": "google.com",
        "image": "https://site-images.similarcdn.com/image?url=google.com&t=2&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461",
        "isVirtual": false
      }
    ],
    "companies": [
      {
        "domain": "google.com",
        "name": "Google, LLC",
        "logoUrl": "https://static-us-east-1.similarcdn.com/si/company_data/merged_v2/firmographics_logos/bf9c398717b4c0c1ecee483a3c844e710eaff98658e8cc1f6ab..."
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/similarweb.searchResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	similarweb.SearchResp	No
data.apps	object	No
data.apps.appStore	array	No
data.apps.appStore[].appKey	string	No	1_1484366079
data.apps.appStore[].id	string	No	1484366079
data.apps.appStore[].image	string	No	https://site-images.similarcdn.com/url?url=https%3A%2F%2Fis1-ssl.mzstatic.com%2Fimage%2Fthumb%2FPurple211%2Fv4%2F1c%2F1c%2Fe3%2F1c1ce399-1181-5be1-56d8-ee74e9f0cef4%2FAppIcon-0-0-1x_U007emarketing-0-0-0-7-0-0-85-220.png%2F175x175bb.png
data.apps.appStore[].name	string	No	TwitterIt for Twitter X
data.apps.appStore[].publisher	string	No	BEST SOCIAL APPS DEVELOPMENT LTD
data.apps.appStore[].ratings	integer	No	38197
data.apps.appStore[].store	string	No	apple
data.apps.googlePlay	array	No
data.apps.googlePlay[].appKey	string	No	0_twittervideodownloader.twitter.videoindir.savegif.twdown
data.apps.googlePlay[].id	string	No	twittervideodownloader.twitter.videoindir.savegif.twdown
data.apps.googlePlay[].image	string	No	https://site-images.similarcdn.com/url?url=https%3A%2F%2Fplay-lh.googleusercontent.com%2FFi9-CFodjxpqvc3dC0XHDXHkFD3wkw9VccX_iL68U_3kmu2iIuHvIp5AZUoXGZ3mlQ%3Ds180
data.apps.googlePlay[].name	string	No	X Saver:Download Twitter Video
data.apps.googlePlay[].publisher	string	No	Shotcut Video Workshop
data.apps.googlePlay[].ratings	integer	No	159344
data.apps.googlePlay[].store	string	No	google
data.companies	array	No
data.companies[].domain	string	No	twitter.com
data.companies[].logoUrl	string	No	https://sw-df-production-internal-data.s3.amazonaws.com/si/company_data/merged_v2/firmographics_logos/30e41d95dd013b4ec1b8d9e614ec546807cb2152b1f54fa3031d7e6488f93ce4.jpg
data.companies[].name	string	No	Twitter
data.websites	array	No
data.websites[].image	string	No	https://site-images.similarcdn.com/image?url=twitter.com&t=2&s=1&h=05438debe431144d9c727828570d1754a25bd9286bc14f3aa65a4f05b9057e25
data.websites[].isVirtual	boolean	No	false
data.websites[].name	string	No	twitter.com
msg	string	No	OK

Example request

curl -X GET "https://api.crawlora.net/api/v1/similarweb/search" -H "x-api-key: <api-key>"

TypeScript fetch

const url = new URL("https://api.crawlora.net/api/v1/similarweb/search");
const headers = new Headers();
headers.set("x-api-key", "<api-key>");
const response = await fetch(url, {
  method: "GET",
  headers,
});
const payload = await response.json();

Open in Playground Back to group