To access the Similarweb APIs, you need to authenticate your requests using an API key. Each user with API data credits can generate and manage their own API key directly within the Similarweb platform.
Creating an API Key
To generate an API Key, follow these steps:
- Log in to the Similarweb platform.
-
From the main menu to the left, select ‘Settings & Help’, then select ‘Account’.
-
Under ‘Data Credit Management’, you can create an API key that you can use for either REST API or Batch API.
-
Scroll down to the bottom section and select ‘API Keys’.
-
Click ‘Generate a New API Key’ to the right.
-
Type the name of the API Key, then select whether this is for yourself or another user if you are the account admin. If this is for someone else, simply enter their email address. They will be notified.
-
Click ‘Generate Key’ - your key will be displayed in the Generated Keys table.
Activating & Managing API Keys
How to confirm that your key is activated
To verify that the key is active, you can search by the ‘Key Name’ or the ‘Owner’ and then check if the specific key is toggled to active. You can also filter by ‘Key status’ or ‘Usage’.
Key Management
Admins can create and manage API keys for the entire account.
- Every user can have up to 50 active keys
- There's no expiry date on active keys
- When a user is removed from the account, there’s also an option of deactivating or reassigning their API keys.
-
Admins can set data credit limits in the ‘Users’ tab that will apply for any product consuming data credits, such as REST API, BATCH API, MCP, AI Studio, CRM Enrichment, etc. Only Admins can control limits. The limits are per user and not per key.
Important: Please don’t share your key publicly. Exposing your credentials can result in your account being compromised, and lead to unexpected charges.
Also important: If an API key has been created but not activated, then you will receive an "Invalid API key" error when trying to pull data with it.
FAQs
Q: How do I delete or transfer an API key?
When an admin user deletes or deactivates a user on their account, if there are any active API keys associated with that user, the admin will be prompted with 2 options:
- Transfer the API key(s) to a different active user on the same account.
- Disable the API key(s) so that all users on the account will no longer be able to use it.
Q: How many API keys can a user have?
There is no limit to how many API keys can be created for a user. However, 50 API keys can be active at a time.
Q: What does a user limit cover?
Everything that consumes data credits — REST API, Batch API, AI Studio and MCP, etc. One monthly cap per user, spent in whatever combination they like. A user with a 10,000-credit limit can spend it all on REST, or split it across products.
Q: What is the difference between an API Key and Data Credits?
The API Key grants you access to the API reports. The Data Credits are like the “currency” needed to pull data.
Q: Is there a publicly available API documentation that has more information about Similarweb’s API?
As a matter of fact, there is an entire subdomain made for just that! Check out our API documentation. It has tons of useful information on how to set up your APIs and Integrations, a more in-depth FAQ, and more.
Q: Who can create API keys now?
Everyone, including non-admin users. This was needed for MCP, which runs on REST API infrastructure and so requires each user to have a key.
Q: Are Batch and REST keys still separate?
No. Any key works for both, managed in one table.
Q: Who is usage attributed to?
The owner of the key. A key that consumes 1,000 credits counts against its owner's usage and limit.
Comments
Article is closed for comments.