Skip to main content
Every request to the CabalSpy API needs an API key. Getting one is free and takes a minute, the free tier gives you 10,000 credits every month with no credit card.

​
Get your key

Create an account and copy your key from the dashboard.
1

Create a free account

Sign up at apidashboard.cabalspy.xyz/register. No credit card is required for the free tier.
2

Open the API Dashboard

After signing in, go to the API Dashboard. Your API key is shown there.
3

Copy your key

Copy the key and keep it somewhere safe. Treat it like a password, anyone with your key can spend your credits.
Depending on your plan you can hold more than one key. Free and Starter include one key, Pro up to three, and Business up to five. Multiple keys let you separate environments or projects and revoke one without affecting the others.

​
Use your key

You can authenticate two ways. Pick whichever fits your setup, they are equivalent.

​
REST requests

Pass the key as the api_key query parameter, or as an Authorization Bearer header.

​
WebSocket connections

Pass the key when you open the connection, either as the apiKey query parameter or as a Bearer header. A connection without a valid key is closed immediately.

​
Keeping your key safe

Your key is a secret. A few good habits keep it that way. Do not commit it to source control or paste it into client side code that ships to users. Load it from an environment variable or a secrets manager instead. If a key is ever exposed, create a new one in the dashboard and stop using the old one. When you need to separate projects or environments, use separate keys on a plan that allows several rather than sharing one everywhere.

​
Managing usage and billing

Your plan, current credit usage, and keys all live in the API Dashboard. You can upgrade or downgrade at any time, upgrades take effect immediately and are pro-rated, downgrades apply on your next billing date. See Pricing for what each plan includes and how credits work.