NAV
shell

Introduction

This is a lidl api that lets you get some data from OkayegBOT :)

Authentication

No authentication is requierd for now :)

Okayeg API

Get User

curl "https://api.okayeg.com/user?username=badoge"

The above command returns JSON structured like this:

{
"userid":59616430,
"username":"badoge",
"egs":2034,
"cooldown":1627548836
}

Get some information about a user.

HTTP Request

GET https://api.okayeg.com/user?username=<username>

Query Parameters

Parameter Description
username The Twitch username of the person that you want to lookup.

Get Rank

curl "https://api.okayeg.com/rank?username=badoge"

The above command returns JSON structured like this:

{
"username":"badoge",
"rank":4
}

Get a user's rank in the current season.

HTTP Request

GET https://api.okayeg.com/rank?username=<username>

URL Parameters

Parameter Description
username The Twitch username of the person that you want to lookup.

Get Commands

curl "https://api.okayeg.com/commands"

The above command returns JSON structured like this:

[
  {
    "_id": "join",
    "aliases": [],
    "enabled": 1,
    "desc": "Adds the bot to your channel. only works in the <a href=\"https://twitch.tv/okayegbot\">bot's chat.</a>",
    "cd": 2,
    "lvl": 1,
    "whisperable": 0,
    "cat": 1
  },
  {
    "_id": "leave",
    "aliases": [],
    "enabled": 1,
    "desc": "Removes the bot from your channel.",
    "cd": 2,
    "lvl": 2,
    "whisperable": 0,
    "cat": 1
  },
  {
    "_id": "eg",
    "aliases": [
      "ed",
      "+eg",
      "+egg",
      "egg"
    ],
    "enabled": 1,
    "desc": "Get some egs <br>eg count resets each season, each season is 1 month. Previous season leaderboards are available <a href=\"/leaderboard.html\">here</a>",
    "cd": 3600,
    "lvl": 1,
    "whisperable": 1,
    "cat": 2
  },
]

Showing first 3 results only.

This endpoint retrieves a detailed list of all commands.

HTTP Request

GET https://api.okayeg.com/commands

Get Channels

curl "https://api.okayeg.com/channels"

The above command returns JSON structured like this:

[
  "0kayga",
  "2alessandro2",
  "4weirdchampp",
  "782741",
  "actuallypepege",
  "agusnonames2",
  "alecbirdman",
  ...
]

Get a list of all channels that OkayegBOT is connected to.

HTTP Request

GET https://api.okayeg.com/channels

Get Settings

curl "https://api.okayeg.com/settings?channel=badoge"

The above command returns JSON structured like this:

{
  "channel": "badoge",
  "settings": {
    "_id": "badoge",
    "userid": 59616430,
    "lastuse": 1627549916,
    "uses": 0,
    "cd": 3,
    "usercd": 6,
    "pb1": "",
    "pb2": ""
  }
}

Retrieve a channel's OkayegBOT settings.

HTTP Request

GET https://api.okayeg.com/settings?channel=<channel>

URL Parameters

Parameter Description
channel The Twitch channel that you want to lookup.
shell