Light Bot

Appearance

Rest API Reference ​

Introduction ​

Since 2.2.0 the bot includes an expanded version of the JSON REST API. It now allows for generalization of use and third-party implementations.

If you’re just starting, authenticating is a great place to start. Every API endpoint (with an exception to the payment webhook IPN route) requires authentication.

Authenticating Requests ​

In order to use any of the endpoints, you need to authorize the request. You can do that using the X-Api-Key header.

First, configure your keys. In your Light Bot configuration, set api.keys to a list of your allowed keys. A key can be anything, but it should be long and secure. You can generate a secure key using a tool like this UUID v4 Generator.

Then, when sending a request, include any of the above-defined keys it in the request headers as X-Api-Key:

http
GET https://your.domain/endpoint
headers: {
	"X-Api-Key": "YOUR KEY HERE"
}
sh
$ https://your.domain/endpoint -H 'X-Api-Key: YOUR-KEY-HERE'
ts
fetch("https://your.domain/endpoint", {
  method: "GET",
  headers: {
    "X-Api-Key": "YOUR-KEY-HERE"
  }
})
  .then((res) => res.json())
  .then((data) => {
      console.log(data)
  }).catch((err) => {
      console.error(err)
  })
py
import requests

url = "https://your.domain/endpoint"
headers = {"X-Api-Key": "YOUR-KEY-HERE"}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")

After authenticating, the API will allow you to make actions.

DANGER

Never share your API key(s). They allow full, unmoderated control over your bot, and therefore, your Discord server and banking account(s) as well. Use with care.

Pagination ​

Some endpoints return a lot of data and hence allow paginating to reduce data sent at once. Here's how pagination works in Light Bot's Rest API:

TIP

If you’re wondering which endpoints allow pagination, look for a [Paginated] badge in the route's documentation.

Paginated endpoints allow query parameters:

  • page - show a certain page
  • limit - decides how many items there are per page

For example, for a request like: /paginated-endpoint?page=1&limit=10 the result will be 10 items on the first page.

Each endpoint that is paginated will also always return a totalCount property in the response JSON. The total pages calculation is given by the following formula:

totalPages = ceil(totalCount / limit)

This will give you the total number of pages needed to display all the data. You can then use this information to create your own pagination UI or to control how many pages are fetched at once when making requests programmatically.

You can also use the /<endpoint>/count endpoint to get the total count, if available.