Authentication & API Keys

To utilize the Birdeye's APIs, an API key is required for authentication. You can obtain an API key by signing up for a account and generating an API key in your BDS Dashboard. Include this API key in the headers of your API requests for authentication.

Here's a step-by-step guide on how to obtain an API key:

1 - Create a Birdeye Account

  • A single Birdeye account can be used for both accessing website and using Birdeye Data Services (BDS).
  • You can create your Birdeye account using one of two methods:
    • Using sign-up page: Please check out detailed instructions HERE.
    • Using BDS sign-up page:
      Note: Both methods above result in one single account, and that account can be used in both systems. It is not possible to create two account in those two systems with the same email address.

2 - Get your API Keys

  • Log in to your BDS account: use your email and password to log into BDS Dashboard using this link:
  • Access the Security Tab: On your Dashboard, look for a section labeled "Security" or similar. This is where you'll find options related to API keys and security settings.
  • Generate API Key: Within the Security section, you'll find an option to generate an API key. This might be labeled as "Generate Key" or something similar. Click on this option to initiate the API key generation process.
  • Configure Key Settings (Optional): Depending on the platform, you might have the option to configure settings for your API key. This could include specifying the access permissions or adding a name/description to the key for better organization.
  • Generate the Key: After configuring any optional settings, click the "Generate" or "Create" button to generate your API key. The system will create a unique API key associated with your Birdeye account.
  • Copy the API Key: Once the API key is generated, you'll typically see it displayed on the screen. It might be a long string of alphanumeric characters. Make sure to copy this key and keep it in a secure place. You'll need to include this key in the headers of your API requests for authentication.

And that's it! You now have your API key from, which you can use to authenticate your API requests and access the services provided by the APIs.