Hyra’s V2 monothlyic API allows you to securely interact with Hyra from outside applications. Every day, we see new and exciting integrations with Hyra, from automation from within games to interaction via Discord bots.

Our API is REST based, and uses JSON and Bearer authentication. It’s the exact same API we use to power our website.

At the moment, Hyra’s website uses two APIs.

  • V1 API (api-staging): Our original API is no longer being actively developed, but is still used by our website for some features. This API uses a different authentication method, and is not documented or supported. We cannot guanratee that this API will not change or be removed at any time.
  • V2 API (api): Our new API is being actively developed and more and more features are constantly being added to it. This API is the one you’ll find documented here.

A full technical API reference can be found here, but the documentation here is based on the API reference, and is more user friendly.

​
Authentication

Our V2 API uses Bearer authentication, which you can pass in via the Authorization header. You can get your API key from your Workspace Settings, under Developer API.

Authorizaton: Bearer <api_key>

​
Rate Limiting

On most of our API the global rate limit is 100 requests per minute, but you can check the ratelimit for every endpoint by using the X-Ratelimit-Limit and X-Ratelimit-Reset headers on all responses. If you exceed the limit, you will receive a 429 Too Many Requests response. If you need a higher rate limit, please contact us.

​
Errors

Our API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with Hyra’s servers.

​
Example Error

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Bad Request"
}