For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authentication

How to authenticate with the BlueGamma API using your API key.

All BlueGamma API requests are authenticated with an API key that you issue yourself from the app.


Getting an API Key

You issue your own key. There is no form and no waiting:

  1. Sign in at app.bluegamma.io

  2. Open API Keys in the sidebar, under Developer

  3. Click Create API key

The key is shown once, when it is created, so copy it before you leave the page. The same page has a ready-made request you can copy and run.

Trial accounts can issue a key too. A trial key returns live data on every index for 14 days — see Trials and Billing for what changes when you pick a plan.


Using Your API Key

Include your API key in the x-api-key header with every request:

curl -X GET "https://api.bluegamma.io/v1/swap_rate?index=SOFR&start_date=0D&maturity_date=5Y&fixed_leg_frequency=6M" \
  -H "x-api-key: your_api_key_here"

Example Requests

Python:

JavaScript:


Error Responses

Status Code
Meaning

403

Missing or invalid API key, an expired trial key, or a request your key is not allowed to make — read the detail field, which says which

429

Rate limit exceeded — see Rate Limits


Security Best Practices

  • Keep your API key secret — Don't commit it to version control or expose it in client-side code

  • Use environment variables — Store your key in environment variables rather than hardcoding

  • Rotate if compromised — Contact us immediately if you suspect your key has been exposed


Need Help?

If you're having trouble authenticating or need a new API key:

Last updated

Was this helpful?