Authentication
All authentication is performed via HTTP Basic Auth via the X-API-Key
header.
Follow these steps to authenticate your requests:
Get your API key
Navigate to the API keys page to obtain your secret API key for Crypto Rails.
The API key should be kept secure and never exposed publicly. We recommend storing it as an environment variable or in a secure configuration management system.
Include the API key in requests
Add your API key to the X-API-Key
header in every request:
💡 Quick Start: Use our discovery endpoint to get initial guidance:
Always use HTTPS, as we will reject all API requests over plain HTTP. No additional authentication (like passwords) is required.
Error handling
If authentication fails, you'll receive a 401 - Unauthorized
HTTP status code. This happens when:
- No API key is provided
- An invalid API key is used