Authentication

Speed makes creating API keys and integrating bitcoin payments into any application a breeze.

Speed platform API authenticates via HTTP Basic Auth using your account's API keys. Provide your API key as the basic auth username value. You do not need to provide a password. There are two types of API keys: secret and publishable. While using HTTP endpoints, you must include your secret key in the request. If you do not include your key when making an API request or use one that is incorrect or outdated, Speed returns an error with a 401 HTTP response code.

A small number of API calls can be made through the publishable key API, whereas others require secret keys. Alternatively, you can use restricted API Keys for granular permissions.

Test mode keys are for development environments, whereas live mode keys are for production environments. Test mode secret keys have the prefix sk_test, whereas live mode secret keys have the prefix sk_live. You can view and manage your API keys through the Speed Web Application.

All API requests must be made over HTTPSCalls made over plain HTTP will fail. API requests without authentication will also fail.

🚧

Keep in mind that API keys carry a lot of privileges, so be cautious! Avoid sharing secret API keys with anyone or on public platforms like Github, client-side code, etc.