Introduction
Understand general concepts, response codes, and authentication strategies.
Base URL
The Syrax API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.
All requests contain the following base URL:
Authentication
To unlock higher rate limits, you need to use the X-API-Key Header, free users can use no header.
Error codes
Syrax uses standard HTTP codes to indicate the success or failure of your requests.
In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.
| Status | Description |
|---|---|
| 200 | Successful request. |
| 400 | Check that the parameters were correct. |
| 401 | The API key used was missing. |
| 403 | The API key used was invalid. |
| 404 | The resource was not found. |
| 429 | The rate limit was exceeded. |
| 5xx | Indicates an error with Syrax servers. |
Ratelimiting
The response headers describe your current rate limit following every request in conformance with the IETF standard:
| Header | Description |
|---|---|
| x-ratelimit-limit | Maximum number of requests allowed within a window. |
| x-ratelimit-remaining | How many requests you have left within the current window. |
| x-ratelimit-reset | How many seconds until the limits are reset. |
The default ratelimit is 10 requests per second for users on a pay-as-you-go plan. Subscriptions start from 25 requests per second.
After that, you’ll hit the rate limit and receive a 429 response error code.