VOOZH about

URL: https://docs.similarweb.com/api-v5/getting-started/authentication

⇱ Authentication - Similarweb API V5 Documentation

Getting Started

Sections

Theme switcher

Authentication

Secure API Access with API Keys

All Similarweb API requests require authentication using API keys. This guide covers everything you need to know about creating, managing, and using your API keys securely.

Before You Begin

You must have the following:

  • Active Similarweb account with API access (contact your Account Manager if you need access)
  • Admin-level permissions (required for API key generation and management)

API Keys Creation

1

Access Your Account Settings

  1. Log in to your Similarweb platform
  2. Navigate to Settings → Account from the left menu
  3. Look for the Data Tools section
2

Generate Your API Key

  1. Select either REST API or Batch API
  2. Scroll down and click Generate a new API key
  3. Give your API key a name
  4. Select the primary use for this key (your email or another user)
  5. Click Create
  6. Your new API key will appear in the Generated Keys table under the user name you selected
  7. Make sure the Activation toggle is enabled (switched on)

Important: Only activated API keys can access data. If your key shows as inactive, you'll receive "Invalid API key" errors.

API Keys Management

Admins can create and manage API keys for the entire account.

  1. Every user can have up to 3 active keys.
  2. There's no expiry date on active keys.
  3. When a user is removed from the account his API key is revoked, there’s also an option of specifically removing users API keys.
  4. Admins can set credit limits per user under each API, for example a user can have 10K on REST API and 10K on Batch API. Only Admins can control limits. The limits are per user and not per key.
Was this section helpful?
On this page
  • Authentication