Skip to main content
Use Similarweb through Corsair: one client, typed API calls. Get an API key from the Similarweb platform under API, then pass it as the plugin’s key option or store it on the account. Similarweb reads it as the api_key query parameter. Similarweb has no product called the Digital Rank API; rank data comes from the Website Traffic API (per-domain rank routes), the App Rank route and the Top Sites list. These nine operations are those routes. Things to know before you query:
  • Domains must be bare and lower case. Send cnn.com, not CNN.COM and not a URL with a path. Similarweb answers a capitalised domain with a 401 rather than data, so the plugin lower-cases the domain and trims it before sending.
  • Both dates or neither. websites.globalRank and websites.countryRank take start_date and end_date as YYYY-MM. Sending only one is accepted but answered with the default 28-day window, so the schema rejects it instead of returning the wrong months.
  • Global rank covers desktop and mobile together, one point per month. There is no desktop-only or mobile-only variant of this route.
  • Industry rank is a single reading. It returns the domain’s industry and its rank in that industry worldwide, with no date range.
  • App rank needs a matching store and device. Use androidphone with Google, and iphone or ipad with Apple. The plugin rejects a mismatched pair, because the API answers it with an empty series rather than an error. Call apps.describe for the accepted stores, modes and countries.
  • Errors are plain text, not JSON. A 401 is either the literal invalid API key (no key or a wrong one) or Data not found (a domain it has no data on, or a mistyped one); the plugin treats the second as not-found, not as an auth failure. A 403 means either a bad key or an exhausted credit balance, and Similarweb documents no way to tell them apart. Check capabilities.get and usage.get before concluding the key is wrong.
  • Rate limit. Similarweb allows 10 requests per second per account and answers 429 past it. Core retries those three times with backoff.
  • Credits. Most routes cost data credits per result, and usage.get itself is free. usage.get returns the allowance and what is left; used is derived from the two.
What you get:
  • 9 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

Read a domain’s global rank for three months
List the stores and modes app rank accepts
See the full list on the API page.

What’s next

API reference

Every similarweb.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.