Piloterr

Similarweb Search

GET
/v2/similarweb/search

Search the public Similarweb page for websites, companies, and mobile apps related to a keyword.

Credit cost: 2 credits per call

Authentification

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Paramètres de requête

query*string

Domain name or keyword to search for in the Similarweb database.

Example:

google.com

Notes:

  • Domain search: Use a full domain (e.g. google.com) to find related websites, apps, companies, and technologies associated with that domain.
  • Keyword search: Use a plain keyword (e.g. amazon) to retrieve broader associations across the Similarweb index.
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Corps de la réponse

Successful response

application/json
  1. response
apps?
keywords?array<unknown>
websites?array<>
companies?array<>
technologies?array<unknown>
Example Request
curl -X GET 'https://api.piloterr.com/v2/similarweb/search?query=string'
Example Response
{  "apps": {    "appStore": [      {        "name": "Google Drive",        "author": "Google LLC",        "category": "productivity"      }    ],    "googlePlay": [      {        "name": "Google Photos",        "author": "Google LLC",        "category": "photography"      }    ]  },  "keywords": [],  "websites": [    {      "name": "google.com",      "image": "https://site-images.similarcdn.com/image?url=google.com&t=2&s=1&h=eb35e0fbafa3eb290132ffdfe47187d950d68daaa659ec1bd4b4e834b8f16461",      "isVirtual": false    }  ],  "companies": [    {      "name": "Google",      "domain": "google.com",      "category": "computers_electronics_and_technology/search_engines"    }  ],  "technologies": []}