commands
bot
/:channel/default
Changed onLists default commands
get/bot/commands/{channel}/default
Request
- Base URLhttps://api.streamelements.com/kappa/v2
- Auth
- HTTP bearer
- or OAuth 2Authorization codehttps://api.streamelements.com/oauth2/authorizeToken URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
channelstring required
Example:5b2e2007760aeb7729487dab
guid - Channel id
Query parameters
languagestring required
string - language iso code lowercase (eg. en)
Headers
Acceptstring required
Example:application/json
Response
Example response
[
{
"commandId": "raffle_join",
"command": "join",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "raffle",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Join an active raffle"
},
{
"commandId": "emotes",
"command": "emotes",
"subCommands": [
"ffz",
"bttv",
"update"
],
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Active BTTV emotes in chat: Clap KKaper gachiBASS gachiGASM monkaS"
},
{
"commandId": "srpause",
"command": "pause",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Pause songrequest playback."
},
{
"commandId": "leaderboard",
"command": "leaderboard",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"ranklist"
],
"regex": "",
"description": "Check out the $(pointsname) Leaderboard here https://StreamElements.com/${channel.alias}/leaderboard"
},
{
"commandId": "srqueue",
"command": "songqueue",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 10
},
"aliases": [
"songlist"
],
"regex": "",
"description": "you can see the songrequest queue here https://StreamElements.com/${channel.alias}/songrequest"
},
{
"commandId": "srplay",
"command": "play",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"resume"
],
"regex": "",
"description": "Resume songrequest playback."
},
{
"commandId": "level",
"command": "level",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Set a viewers access level. Reset with !level <username> reset."
},
{
"commandId": "givepoints",
"command": "givepoints",
"accessLevel": 100,
"enabled": false,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"transfer",
"give"
],
"regex": "",
"description": "Transfer points to another user."
},
{
"commandId": "commands",
"command": "commands",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"cmds"
],
"regex": "",
"description": "You can find a list of all Commands here https://StreamElements.com/${channel.alias}/commands"
},
{
"commandId": "slotmachine",
"command": "slots",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "slotmachine",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [
"slotmachine",
"slot",
"sm",
"smp"
],
"regex": "",
"description": "Play the slot machine"
},
{
"commandId": "hypecup",
"command": "hypecup",
"subCommands": [
"clear"
],
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 1,
"global": 1
},
"aliases": [],
"regex": "",
"description": "Control the HypeCup."
},
{
"commandId": "contest_bet",
"command": "bet",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 5,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Bet on a contest."
},
{
"commandId": "accountage",
"command": "accountage",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"accage",
"created"
],
"regex": "",
"description": "${user} was created 1 year 5 months 27 days 1 hour ago."
},
{
"commandId": "srremove",
"command": "removesong",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 10
},
"aliases": [
"songs.pop()"
],
"regex": "",
"description": "Remove a users songs, or a single song from the queue."
},
{
"commandId": "raffle_singleraffle",
"command": "sraffle",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "raffle",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"singleraffle"
],
"regex": "",
"description": "Start a raffle with a single winner"
},
{
"commandId": "top",
"command": "top",
"subCommands": [
"points",
"alltime",
"online",
"offline"
],
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 5,
"global": 2
},
"aliases": [],
"regex": "",
"description": "Show the top of the leaderboard."
},
{
"commandId": "giveaway",
"command": "giveaway",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Show the currently active giveaway."
},
{
"commandId": "followage",
"command": "followage",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"howlong"
],
"regex": "",
"description": "${user1} has been following ${user2} for 1 year 5 months 27 days 1 hour"
},
{
"commandId": "srskip",
"command": "skip",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 10
},
"aliases": [
"skipsong"
],
"regex": "",
"description": "Skip the current song"
},
{
"commandId": "wrongsong",
"command": "wrongsong",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [
"ctrl-z",
"heybuddyithinkyougotthewrongsong"
],
"regex": "",
"description": "Removes your last song from the queue"
},
{
"commandId": "eightball",
"command": "8ball",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "eightball",
"cost": 0,
"cooldown": {
"user": 10,
"global": 3
},
"aliases": [
"eightball",
"69ball",
"420ball"
],
"regex": "",
"description": "Ask the magic 8-ball a question"
},
{
"commandId": "store_redeem",
"command": "redeem",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 5,
"global": 1
},
"aliases": [
"buy"
],
"regex": "",
"description": "You successfully redeemed item1 for 420 points."
},
{
"commandId": "permit",
"command": "permit",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Prevent a viewer from getting timed out for 60 seconds."
},
{
"commandId": "roulette",
"command": "roulette",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "roulette",
"cost": 0,
"cooldown": {
"user": 60,
"global": 0
},
"aliases": [
"gamble"
],
"regex": "",
"description": "gamble your life away"
},
{
"commandId": "editpoints",
"command": "addpoints",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"editpoints",
"bonus"
],
"regex": "",
"description": "Give points to viewers. Use 'all' for all chatters"
},
{
"commandId": "module",
"command": "module",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Enable or disable modules via chat."
},
{
"commandId": "next",
"command": "next",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [
"nextsong",
"whatisthenextsonghomie"
],
"regex": "",
"description": "next song: MrSuicideSheep - WE WON ZULUL [2m3s] requested by LordFluffyButt https://youtu.be/9OG-Qr1qAe4"
},
{
"commandId": "store_items",
"command": "items",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"store"
],
"regex": "",
"description": "Available items are: item1, item2, item3 https://StreamElements.com/${channel.alias}/store"
},
{
"commandId": "srsongrequest",
"command": "songrequest",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "songrequest",
"cost": 0,
"cooldown": {
"user": 15,
"global": 3
},
"aliases": [
"sr"
],
"regex": "",
"description": "Request a song by youtube id, url or video title."
},
{
"commandId": "srwhen",
"command": "when",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 15
},
"aliases": [
"mysong"
],
"regex": "",
"description": "\"My Summer Car - Radio Chill\" is at #2 in the queue and is playing 2 mins 3 secs"
},
{
"commandId": "srvolume",
"command": "volume",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Change the songrequest volume."
},
{
"commandId": "kappagen",
"command": "kappagen",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"emotesplosion"
],
"regex": "",
"description": "KappaGen emotesplosions."
},
{
"commandId": "command",
"command": "command",
"subCommands": [
"add",
"remove",
"edit",
"options",
"show"
],
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 3,
"global": 0
},
"aliases": [
"cmd"
],
"regex": "",
"description": "Add, edit and delete chat commands."
},
{
"commandId": "ping",
"command": "ping",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleEnabled": true,
"moduleId": "admin",
"cost": 0,
"cooldown": {
"user": 0,
"global": 15
},
"aliases": [],
"regex": "",
"description": "streamelements has been running for 13 hours 47 mins!"
},
{
"commandId": "duel_accept",
"command": "accept",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "duel",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Accept a duel request from another chatter"
},
{
"commandId": "bot",
"command": "bot",
"subCommands": [
"mute",
"unmute",
"part"
],
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Mute, unmute or remove the bot."
},
{
"commandId": "raffle_cancel",
"command": "cancelraffle",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "raffle",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"rafflecancel"
],
"regex": "",
"description": "Cancel an active raffle"
},
{
"commandId": "bingo",
"command": "bingo",
"subCommands": [
"bttv",
"ffz",
"twitch",
"all",
"cancel"
],
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "bingo",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Play a game of emote-bingo"
},
{
"commandId": "pepes",
"command": "pepes",
"accessLevel": 1000,
"enabled": false,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Enable or disable pepes in bot responses."
},
{
"commandId": "edit_counter",
"command": "editcounter",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"editcount"
],
"regex": "",
"description": "Edit a custom ${count <name>}/${getcount <name>} counter"
},
{
"commandId": "voteskip",
"command": "voteskip",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "songrequest",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Vote to skip the current song"
},
{
"commandId": "raffle_multiraffle",
"command": "raffle",
"accessLevel": 500,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "raffle",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [
"mraffle",
"multiraffle"
],
"regex": "",
"description": "Start a raffle with multiple winners"
},
{
"commandId": "duel",
"command": "duel",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "duel",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Duel another chatter for points"
},
{
"commandId": "setpoints",
"command": "setpoints",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Set the points of a viewer."
},
{
"commandId": "watchtime",
"command": "watchtime",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 1
},
"aliases": [
"viewtime"
],
"regex": "",
"description": "${user} has spent ${user.time_online|'0 seconds'} watching ${channel}"
},
{
"commandId": "duel_cancel",
"command": "cancelduel",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "duel",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Cancel a duel request to another chatter"
},
{
"commandId": "quote",
"command": "quote",
"subCommands": [
"add",
"remove"
],
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Add, remove and show quotes."
},
{
"commandId": "points",
"command": "points",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 5,
"global": 1
},
"aliases": [],
"regex": "",
"description": "$(user) has $(user.points) $(pointsname) and is rank $(user.points_rank) on the leaderboard."
},
{
"commandId": "chatstats",
"command": "chatstats",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"twitchstats"
],
"regex": "",
"description": "https://stats.StreamElements.com/c/$(channel) PogChamp"
},
{
"commandId": "srsong",
"command": "song",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 15
},
"aliases": [],
"regex": "",
"description": "current song: harambe.waw - WE WON ZULUL [2m3s] requested by nuuls https://youtu.be/9OG-Qr1qAe4"
},
{
"commandId": "settitle",
"command": "settitle",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 15
},
"aliases": [
"setitle"
],
"regex": "",
"description": "Update the stream title."
},
{
"commandId": "duel_deny",
"command": "deny",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "duel",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [],
"regex": "",
"description": "Deny a duel request from another chatter"
},
{
"commandId": "giveaway_enter",
"command": "enter",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 10,
"global": 0
},
"aliases": [
"ticket"
],
"regex": "",
"description": "Buy tickets for a giveaway."
},
{
"commandId": "uptime",
"command": "uptime",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"downtime"
],
"regex": "",
"description": "${channel} has been streaming for 2 hours 20 mins"
},
{
"commandId": "contest_contest",
"command": "contest",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [],
"regex": "",
"description": "Show the currently active contest."
},
{
"commandId": "tip",
"command": "tip",
"accessLevel": 100,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 15,
"global": 5
},
"aliases": [
"donate"
],
"regex": "",
"description": "You can Tip to $(channel) using this link https://StreamElements.com/${channel.alias}/tip"
},
{
"commandId": "setgame",
"command": "setgame",
"accessLevel": 1000,
"enabled": true,
"enabledOnline": true,
"enabledOffline": true,
"moduleId": "",
"cost": 0,
"cooldown": {
"user": 0,
"global": 15
},
"aliases": [],
"regex": "",
"description": "Update the channels game."
}
]Changes
- info
api tag
botadded
- info
- warning
deleted the
headerrequest parameterContent-Type
- warning