SimilarWeb Digital Rank API

Overview

The SimilarWeb Digital Rank API provides free access to global website ranking data for benchmarking and competitive analysis. With the integration in SquadOS, your agents can retrieve lists of top-ranked sites by country and category, fetch rank tracker campaign metadata, and check subscription status to monitor available credit usage.

• Composio documentation: docs.composio.dev/toolkits/similarweb_digitalrank_api

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	API key generated in the SimilarWeb dashboard under Settings → API.

How to get credentials

1. Go to account.similarweb.com/standard-api and log in to your SimilarWeb account.
2. Click Generate A New API Key.
3. Enter a descriptive name for the key (e.g., SquadOS) and click Create.
4. Your new key will appear in the Generated Keys table — copy the displayed value.

Tip

Use a dedicated key for SquadOS. SimilarWeb lets you manage multiple keys individually, making it easy to revoke access without affecting other integrations.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for SimilarWeb Digital Rank API.
3. Click the card to open the details and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to agents. (Connection-flow details in Organization Tools.)

Available actions

Get Rank Tracker Campaign Metadata

SIMILARWEB_DIGITALRANK_API_GET_RANK_TRACKER_DESCRIBE

Tool to retrieve campaign metadata for rank tracking. Returns Campaign IDs and Scraping Configurations needed to query other Rank Tracker APIs.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error message if execution failed.
successful	boolean	Yes	Whether the action executed successfully.

Get Similar Rank Top Sites

SIMILARWEB_DIGITALRANK_API_GET_SIMILAR_RANK_TOP_SITES

Tool to retrieve a list of top-ranking websites globally or filtered by country and category. Use when you need to discover popular websites based on SimilarWeb’s traffic data.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of top sites to return. Controls pagination of results.
country	string	No	Country code to filter top sites by specific country (e.g., us, gb, fr). If not provided, returns global top sites.
category	string	No	Category to filter top sites by specific industry or topic (e.g., shopping, news, social_media). If not provided, returns all categories.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error message if execution failed.
successful	boolean	Yes	Whether the action executed successfully.

Get Subscription Status

SIMILARWEB_DIGITALRANK_API_GET_SUBSCRIPTION_STATUS

Tool to check the remaining subscription usage for the user.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error message if execution failed.
successful	boolean	Yes	Whether the action executed successfully.