To begin utilizing our API, you'll need to create an API key. This key is essential for all API requests, serving as your authentication method to access the API.
The process to obtain your API key is straightforward
Authorization: Bearer YOUR_API_KEY
Obtaining Your API Key
Once you have your API key, include it in the header of each API request to authenticate your access. Detailed information on making requests and handling responses will be provided in the subsequent sections of this documentation.
The API has a rate limit of 10 requests per second.
Exceeding this limit will result in a 429 Too Many Requests response.
The API uses conventional HTTP response codes to indicate the success or failure of a request.
Codes in the 2xx range indicate success, codes in the 4xx range indicate an error from the client side, and codes in the 5xx range indicate an error with our servers.
| Status | Description |
|---|---|
| 200 | Your request was successful! |
| 400 | There was an error in your request |
| 401 | Please provide a valid API key. |
| 403 | You don't have permission to do this. |
| 404 | The thing you're looking for isn't here. |
| 429 | You're sending too many requests too quickly. |
| 5xx | We encountered an unexpected error. |