Reference

API Reference

Adonis's API allows you to add and change data on the WebPanel and your Game from an external program/application

Base Url

https://api.adonis.dev/




Authentication

An API Key will be needed any time when making a request to the API Service. You can obtain your key in your user settings under security, this is also where you can reset your api key.

Authentication is preformed with the api-key HTTP header in the format "api-key": KEY.

Header Example

"api-key": 8c0fdb24c3e7f4e572e330f0cc9d5cea6067586b85628f2ef6e5b9621da67be8




Rate Limits

Adonis's API rate limits request to prevent abuse or overload of our servers. Our rate limit is 100 requests per 100 seconds. Due to the possibility of rate limit changes you should not hard code rate limiting into your program rather parse the rate limit headers returned by the server.

Rate Limit Header Examples

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 72
X-RateLimit-Reset: 1599178913

  • X-RateLimit-Limit
    • The maximum number of requests you're permitted to make per 100 seconds.
  • X-RateLimit-Remaining
    • The number of requests remaining in the current rate limit window.
  • X-RateLimit-Reset
    • The time at which the current rate limit window resets in UTC epoch seconds.