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. |
[deprecated - will be removed soon :)] Get Twitch emotes & badges
curl "https://api.okayeg.com/emotes?channel=forsen"
The above command returns JSON structured like this:
{
"data": {
"id": "22484632",
"login": "forsen",
"display_name": "forsen",
"type": "",
"broadcaster_type": "partner",
"description": "Approach with caution! No roleplaying or tryharding allowed.",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/forsen-profile_image-48b43e1e4f54b5c8-300x300.png",
"offline_image_url": "",
"view_count": 158290291,
"created_at": "2011-05-19T00:28:28.310449Z",
"emotes": [
{
"id": "emotesv2_2f9a36844b054423833c817b5f8d4225",
"name": "forsenPls",
"images": {
"url_1x": "https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_2f9a36844b054423833c817b5f8d4225/static/light/1.0",
"url_2x": "https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_2f9a36844b054423833c817b5f8d4225/static/light/2.0",
"url_4x": "https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_2f9a36844b054423833c817b5f8d4225/static/light/3.0"
},
"tier": "1000",
"emote_type": "subscriptions",
"emote_set_id": "385292559"
},
...
],
"badges": [
{
"set_id": "subscriber",
"versions": [
{
"id": "0",
"image_url_1x": "https://static-cdn.jtvnw.net/badges/v1/eb0dceb5-9c55-4a8b-b9d9-bb414ab79bb9/1",
"image_url_2x": "https://static-cdn.jtvnw.net/badges/v1/eb0dceb5-9c55-4a8b-b9d9-bb414ab79bb9/2",
"image_url_4x": "https://static-cdn.jtvnw.net/badges/v1/eb0dceb5-9c55-4a8b-b9d9-bb414ab79bb9/3"
},
...
]
}
]
}
}
Showing 1 emote/badge only.
Get a Twitch channel's sub/bits/follower emotes and sub badges, includes some additional info about he channel also.
HTTP Request
GET https://api.okayeg.com/emotes?channel=<channel>
URL Parameters
| Parameter | Description |
|---|---|
| channel | The Twitch channel that you want to lookup. |
[deprecated - will be removed soon :)] Get Twitch global emotes
curl "https://api.okayeg.com/emotes/global"
The above command returns JSON structured like this:
{
"data": [
{
"id": "120232",
"name": "TriHard",
"images": {
"url_1x": "https://static-cdn.jtvnw.net/emoticons/v2/120232/static/light/1.0",
"url_2x": "https://static-cdn.jtvnw.net/emoticons/v2/120232/static/light/2.0",
"url_4x": "https://static-cdn.jtvnw.net/emoticons/v2/120232/static/light/3.0"
}
},
...
]
}
Showing 1 emote only.
Get all Twitch global emotes.
HTTP Request
GET https://api.okayeg.com/followlist?username=okayegbot
[deprecated - will be removed soon :)] Get Twitch follow list
curl "https://api.okayeg.com/emotes?channel=forsen"
The above command returns JSON structured like this:
{
"data": {
"id": "75501168",
"display_name": "OkayegBOT",
"broadcaster_type": "",
"description": "More info and a list of all commands can be found on the website Okayeg 👉 okayeg.com",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/03192260-dace-4932-9416-46d8d9bfa452-profile_image-300x300.png",
"view_count": 528,
"created_at": "2014-11-19T14:10:40.651774Z",
"total": 7,
"following": [
{
"from_id": "75501168",
"from_login": "okayegbot",
"from_name": "OkayegBOT",
"to_id": "22484632",
"to_login": "forsen",
"to_name": "forsen",
"followed_at": "2021-01-07T05:44:37Z",
"id": "22484632",
"login": "forsen",
"display_name": "forsen",
"type": "",
"broadcaster_type": "partner",
"description": "Approach with caution! No roleplaying or tryharding allowed.",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/forsen-profile_image-48b43e1e4f54b5c8-300x300.png",
"offline_image_url": "",
"view_count": 158290360,
"created_at": "2011-05-19T00:28:28.310449Z"
},
{
"from_id": "75501168",
"from_login": "okayegbot",
"from_name": "OkayegBOT",
"to_id": "120183018",
"to_login": "nam______________________",
"to_name": "NaM______________________",
"followed_at": "2020-09-08T19:02:16Z",
"id": "120183018",
"login": "nam______________________",
"display_name": "NaM______________________",
"type": "",
"broadcaster_type": "partner",
"description": "NaM",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/73eab48e-00a7-4e87-8303-c3da05aa3639-profile_image-300x300.png",
"offline_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/5dae0df8-78cb-4df4-959b-c075c29cb5b7-channel_offline_image-1920x1080.png",
"view_count": 250648,
"created_at": "2016-03-29T10:36:34.119078Z"
},
{
"from_id": "75501168",
"from_login": "okayegbot",
"from_name": "OkayegBOT",
"to_id": "59616430",
"to_login": "badoge",
"to_name": "badoge",
"followed_at": "2014-11-20T19:52:03Z",
"id": "59616430",
"login": "badoge",
"display_name": "badoge",
"type": "",
"broadcaster_type": "",
"description": ":)",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/47e5531a-78de-47c6-b293-d495ee30de8f-profile_image-300x300.png",
"offline_image_url": "",
"view_count": 4671,
"created_at": "2014-03-25T12:34:46.984599Z"
},
...
]
}
}
Showing 3 followed channels only.
Get a Twitch user's follow list with extra info about them and the users that they follow.
HTTP Request
GET https://api.okayeg.com/followlist?username=<username>
URL Parameters
| Parameter | Description |
|---|---|
| username | The Twitch username of the person that you want to lookup. |