Skip to main content

Authentication

Birdeye APIs use API-key authentication.

Get your API key

  1. Sign in at bds.birdeye.so
  2. Open the Security tab in the dashboard
  3. Click Generate key
  4. Copy the key and store it securely

Send the key in request headers

Include your key in the X-API-KEY header on every request.

JavaScript

Python

Notes

  • Generate keys from the Security page in BDS.
  • Rotate keys if they are exposed or shared accidentally.
  • Use whitelist and blacklist controls in the dashboard for tighter production security.
  • Some endpoints also require headers such as x-chain or x-perp.