Documentation

Welcome to the Azura Documentation


Notice

We would kindly ask you to release everything related to our Service under the GNU-GPL 3.0 license.
This still is your own decision, and we will respect your choice. But we would love to see the community grow and share openly!

Notice

Not yet finished, waiting on Error.

Documentation

Welcome to the Public-API Documentation


Development


Setup

The only thing we need is an APIKey, to obtain an APIKey we recommend you to use the ?key command on our Discord Server.
We also recommend using a API-Wrapper such as ours.


Usage

Before we can start to use the API, we have to decide what endpoint we want to use, for this you can look at all the available Endpoints below!

Usage

After choicing the right Endpoint for your work, we can start with the Implementation!


Headers

We will need two Headers.
1. User-Agent: Mozilla/5.0 Gecko/20100316 Firefox/3.6.2 AzuraX/X
2. API-Key:YOUR_KEY


Url

The base URL for our API is: api.azura.best. (Format: Endpoint:Path)
Userlookup: /public/user/lookup/USERNAME
Userstats: /public/stats/user
Applicationstats: /public/stats/application
This means if you want to lookup for example Error you would need to call:
api.azura.best/public/user/lookup/Error


Result

You will always receive an JSON-response with an boolean called success, and a small message.