Get the StreamElements channel that owns the configured token: channel id (_id), username, display name, provider (twitch/youtube/...), avatar and more. Use it to find your channel id.

Get public details of a StreamElements channel by channel id or channel name.

Get extended details for a channel (profile, settings and linked provider information).

List the emotes usable on a channel: Twitch, BetterTTV (BTTV) and FrankerFaceZ (FFZ).

POST /channels/{channel}/socket. StreamElements documents this endpoint without any description; it appears to relate to the channel's realtime socket connection. Only use it if you know what it does.

DELETE /channels/{channel}/accesstoken. Undocumented; it appears to revoke the channel's access token. WARNING: this may invalidate the token this server is using, so every later call fails until you put a new token in SE_JWT_TOKEN / SE_OAUTH_TOKEN. Only run it if the user explicitly asks for it.

Get the StreamElements user account behind the token, including the channels it can access.

List the channels the current StreamElements user can access.

List the channel's access list: users who have been granted access to manage this channel.

Get the StreamElements chat bot's status on the channel: whether it has joined, is muted, its language and name.

Make the StreamElements bot join the channel's chat.

Make the StreamElements bot leave (part) the channel's chat. Commands and timers stop working until it rejoins.

Mute the bot: it stays in chat but stops sending messages.

Unmute the bot so it sends messages in chat again.

Send a message to the channel's chat as the StreamElements bot. Visible to everyone in chat.

Set the language the bot uses for its built-in responses.

List users that have a custom bot permission level on the channel. StreamElements permission levels: 100 everyone, 250 subscriber, 300 regular, 400 VIP, 500 moderator, 1000 super moderator, 1500 broadcaster.

Give a user a custom bot permission level. StreamElements permission levels: 100 everyone, 250 subscriber, 300 regular, 400 VIP, 500 moderator, 1000 super moderator, 1500 broadcaster.

Remove a user's custom bot permission level, returning them to their default level.

Get the current value of a named bot counter (the counters that commands update and print with ${count}).

List the chat bot's modules (built-in games and features such as 8ball, roulette, duel and heist) with their settings.

List the channel's custom chat bot commands with their replies, cooldowns, costs and access levels.

Create a custom chat bot command.

List the channel's public commands, as shown on its public StreamElements command page.

List the bot's built-in default commands (e.g. !points, !followage) and their settings on the channel.

Change the settings of a built-in default command, e.g. { "enabled": false } or { "cooldown": { "user": 30, "global": 5 }, "accessLevel": 500 }. Get ids from commands_list_default.

Get one custom command by id.

Update a custom command. The API may treat this as a full replacement, so the safest approach is to send every field from commands_get with your changes applied.

Permanently delete a custom command.

List the channel's bot timers (messages the bot posts on a schedule).

Create a bot timer that posts a message every N minutes, optionally only after enough chat activity.

Get one bot timer by id.

Update a bot timer. The API may treat this as a full replacement, so the safest approach is to send every field from timers_get with your changes applied.

Permanently delete a bot timer.

Get the channel's spam filter configuration: the caps, links, emotes, symbols, paragraph and banphrases filters (under botFilters), banned phrase groups, and activity-feed word filtering.

Replace the channel's spam filter document. The API documents the body as { banphrases, filter }. Get the current document with filters_list, change it, and send it back. To change one filter, filters_update is simpler.

Update one bot spam filter. settings is that filter's object as returned under botFilters. by filters_list, e.g. for caps: { "enabled": true, "timeout": { "length": 300 }, "settings": { "limit": 50, "min": 8, "percent": 60 }, "exclude": 300 }.

Check whether a message would be caught by the channel's spam filters. StreamElements documents the body only as { origin, data } with no further detail.

Create a new, empty banned phrase group. Add phrases to it afterwards with filters_banphrases_update.

Update a banned phrase group (its name, phrases, enabled state and timeout). Send the group as returned in filters_list's banphrases list, with your changes applied.

Permanently delete a banned phrase group and all of its phrases.

Get the details of a banned phrase by its id.

Get the channel's loyalty (points) settings: currency name, points per interval (amount), subscriber multiplier, per-event bonuses (follow, tip, subscriber, cheer, host) and ignored users.

Update the channel's loyalty settings. StreamElements does not document the body. Send the document shape returned by loyalty_get_settings (at least its loyalty object) with your changes applied.

Get the channel's StreamElements statistics for a period (year, month, week or day) around a date.

Get a viewer's current points, all-time points and watchtime on the channel.

Get a viewer's rank on the channel's points leaderboard.

Add points to a viewer's current balance, or remove points with a negative amount.

Reset a viewer's current points by removing them from the points table. Cannot be undone.

Add to a viewer's all-time points total, or subtract with a negative amount.

Reset a viewer's all-time points. Cannot be undone.

List viewers ranked by all-time points.

List viewers ranked by current points (the points leaderboard).

List viewers ranked by watchtime.

Change points for many viewers at once. mode 'add' adds each amount to the balance; 'set' replaces the balance.

Reset the points of EVERY viewer on the channel for a leaderboard context. Cannot be undone. Only run it if the user explicitly asks.

List the channel's loyalty store items (name, cost, stock, cooldowns, redemption settings).

Add an item that viewers can redeem with loyalty points.

Get one store item by id.

Update a store item. The API may treat this as a full replacement, so the safest approach is to send every field from store_items_get with your changes applied.

Permanently delete a store item.

List store redemptions, newest first. Set pending=true to see only redemptions still to be fulfilled.

Search store redemptions by text, with optional date range, pending filter and sort.

List the store redemptions made by the token owner on this channel.

Get one store redemption by id, including the viewer's answers to the item's questions.

Update a store redemption, e.g. { "completed": true } to mark it fulfilled.

Permanently delete a store redemption record.

List the channel's tips (donations), with optional filters by date range, tipper, email and message.

Create a tip record on the channel, e.g. to import a donation received elsewhere. This writes to the channel's real tip history.

List the channel's top tippers with tip count, total, average, and first/last tip dates.

Get the channel's tips leaderboard.

List tips held for moderation before they are shown on stream.

Get one tip by id, with the tipper, amount, currency, message and status.

List the channel's activity feed (follows, subs, tips, cheers, raids, hosts, redemptions and more), newest first, filtered by type, date range and minimum amounts.

List the channel's top cheerers or tippers for a period.

Get one activity by id.

Update an activity. StreamElements documents this endpoint only as 'Update activity' and gives no body format; pass the fields to change in changes.

Replay an activity's alert on the channel's overlays, e.g. to re-show a follow or tip alert on stream.

Get the song currently playing in a media request room, looked up by provider and room instead of channel. StreamElements does not document these parameters.

Look up a YouTube video by id, or search YouTube by phrase, as the media request system sees it.

Get the channel's media (song) request settings: limits, costs, moderation and allowed sources.

Get the public subset of the channel's media request settings.

Get the media request queue with full video details.

Get the media request queue for public display, without video details.

Add a YouTube video to the channel's media request queue.

Remove a song from the media request queue. Get song ids from songrequests_queue.

List media requests waiting in the moderation queue.

Get the songs on the channel's playlist, which plays when the request queue is empty.

Get the media player's current state (playing or paused, volume and so on).

Play or pause the channel's media request player.

List previously played media requests.

Get the song currently playing on the channel.

Get the next song in the media request queue.

List the channel's contests (points betting on outcomes), including the active one.

Create a contest where viewers bet loyalty points on an outcome. Start it with contests_start.

List the channel's previous contests.

Get one contest by id, with its options, totals and state.

Update a contest that has not started yet.

DELETE /contests/{channel}/{contestId}. StreamElements labels it 'Close contest', the same as contests_close. Prefer contests_close to end a running contest and contests_refund to return bets.

Start a created contest so viewers can place bets.

Place a bet on a contest option as the token owner.

List the bets placed on a contest.

Settle a contest by choosing the winning outcome, which pays out points. StreamElements does not document the body; it presumably names the winning option, e.g. { "winnerId": "" }.

Cancel a contest and refund every participant's bet.

Close betting on a running contest, so no new bets are accepted, before picking a winner.

List the channel's giveaways, including the active one.

Create a giveaway where viewers buy tickets with loyalty points. Start it with giveaways_start.

List the channel's previous giveaways.

Get one giveaway by id, optionally with its entrants.

POST /giveaways/{channel}/{giveawayId}. StreamElements labels it 'Create a new Giveaway' and says the id may refer to the ongoing giveaway; the body format is undocumented. Prefer giveaways_create to create one.

Update a giveaway's settings.

Permanently delete a giveaway.

List the users who joined a giveaway and their tickets.

Start a giveaway so viewers can join.

Draw a random winner from the giveaway's entrants. Each call draws another winner.

Mark a giveaway as complete once winners are settled.

Reopen a closed giveaway so viewers can join again.

Cancel a giveaway and refund every entrant's tickets.

Close entries on a running giveaway, so no new tickets are accepted, before drawing a winner.

Get the channel's session data: latest follower/subscriber/tip/cheer, and the session, week, month and total counters that overlay widgets display.

Overwrite session data values, e.g. to correct a counter shown on overlays. Send the fields to change, keyed as they appear in sessions_get's data.

Get the channel's session settings, such as when the session resets and which events count toward it.

Update the channel's session settings. Get the current settings with sessions_get_settings, change them, and send them back.

Reset the channel's session data (session counters and latest events). Cannot be undone.

Get the top events (e.g. biggest tips or cheers) aggregated over an interval.

List the channel's overlays, optionally filtered by name or type.

Get one overlay with all of its widgets and their settings. Responses can be large.

Reload all of the channel's overlays, like refreshing every overlay browser source.

Control alerts on the channel's overlays: pause or play the alert queue, mute or unmute alert sounds, or reload.

Create a new overlay on the channel, empty by default. Undocumented endpoint: not in the official API reference, so it may change without notice. To copy an overlay, pass the widgets from overlays_get.

Permanently delete an overlay and all of its widgets. Browser sources pointing at it stop working. Undocumented endpoint: not in the official API reference, so it may change without notice.

Get global chat statistics across all channels that StreamElements chat stats tracks.

Search the channels tracked by chat stats by channel name.

Get a channel's chat stats summary by channel name.

Get a channel's 'emotes per minute' chat stats.

Get a channel's detailed chat stats: top chatters, emotes, commands, hashtags and more.

Get the chat stats for one item in a category, e.g. one emote or one chatter.

Browse the StreamElements theme gallery (ready-made overlay and alert packages).

Get one theme from the StreamElements gallery by id.

Change an overlay's name, canvas settings or individual widgets (position, size, visibility, text, colors and other widget fields). Fetches the current overlay, applies only the given changes and saves it back, so widgets you don't mention are kept intact. Use overlays_get first to find widget ids and field names. Undocumented endpoint (PUT /overlays/{channel}/{overlayId}): not in the official API reference, so it may change without notice.