API keys

Short version: API keys let your own code talk to your account. Create one under Tools, API keys, keep the secret out of anything you share, and delete keys you don't use.

API keys are for managing your account from code. They're not proxy credentials: to send traffic through a proxy you still use its host, port, username and password.

Create a key

1. Confirm your email first. You can't create a key until you have.
2. In the sidebar, open Tools, then API keys.
3. Click Generate new key.
4. Copy the API key and the API secret into wherever your code reads secrets from, like an environment variable or a secrets manager.

Requests send the key and the secret in the X-Api-Key and X-Api-Secret headers.

Try it out

Tools, API playground lets you try requests against your account from the dashboard before you write code. Tools, Webhooks lets your server hear about events instead of polling.

Revoke a key

On the API keys page, click Delete next to the key, then Delete key to confirm. Anything still using it stops working. Do this straight away if a secret ends up in a public repo, a screenshot or a chat.

Keep it safe

• One key per app or server, so you can revoke one without breaking the rest.
• Never paste the secret into a support message. We don't need it.
• The secret stays visible on the API keys page, so keep your dashboard login locked down too: see Keeping your account secure.