Work in progress
This documentation page is currently work in progress.
Not all existing DecAPI endpoints are documented here yet - mostly Twitch and YouTube endpoints. The rest of the endpoints should have accurate documentation :)
For the currently active documentation, please visit docs.decapi.me.
List BetterTTV channel emotes
Returns a space-separated list of BetterTTV emotes available in the channel.
For users that have the BetterTTV browser extension installed (or use a BetterTTV-enabled chat client), the result will display as emotes in chat.
Endpoint URL
https://decapi.me/bttv/emotes/YOUR_TWITCH_CHANNEL_NAME
See examples below for different ways to use the endpoint, using a real Twitch channel name.
Required URL parameters
channel
- The Twitch channel name to retrieve emotes from.
Query parameters
types
- Optional - A comma-separated list of types to return. Your options are:all
- Default if not specified. Returns all types of emotes.gif
- Returns only animated GIF emotes.png
- Returns only static PNG image emotes.
Examples
These examples use the Twitch channel name: decicus
Make sure to replace decicus
in the URL with the correct Twitch channel name for the channel you wish to get the emotes for.
- Example with all types of emotes (default): https://decapi.me/bttv/emotes/decicus
- Example with only getting animated GIF emotes: https://decapi.me/bttv/emotes/decicus?types=gif
- Example with only getting static PNG emotes: https://decapi.me/bttv/emotes/decicus?types=png
- Example with explicitly getting all types of emotes: https://decapi.me/bttv/emotes/decicus?types=gif,png
- This practically works the same as
all
(default), but explicitly requests both types of emotes.
- This practically works the same as
Examples for bots
Nightbot
Note: Nightbot will automatically convert variables, such as$(channel)
or $(touser)
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
$(urlfetch https://decapi.me/bttv/emotes/$(channel))
-
Only animated GIF emotes
$(urlfetch https://decapi.me/bttv/emotes/$(channel)?types=gif)
-
Only static PNG emotes
$(urlfetch https://decapi.me/bttv/emotes/$(channel)?types=png)
Fossabot
Note: Fossabot will automatically convert variables, such as$(channel)
or $(user.login)
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
$(customapi https://decapi.me/bttv/emotes/$(channel))
-
Only animated GIF emotes
$(customapi https://decapi.me/bttv/emotes/$(channel)?types=gif)
-
Only static PNG emotes
$(customapi https://decapi.me/bttv/emotes/$(channel)?types=png)
StreamElements
Note: StreamElements will automatically convert variables, such as${channel}
or ${touser}
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
${customapi.https://decapi.me/bttv/emotes/${channel}}
-
Only animated GIF emotes
${customapi.https://decapi.me/bttv/emotes/${channel}?types=gif}
-
Only static PNG emotes
${customapi.https://decapi.me/bttv/emotes/${channel}?types=png}
Streamlabs Chat Bot
Note: Streamlabs Chat Bot will automatically convert variables, such as$mychannel
or $touserid
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
$readapi(https://decapi.me/bttv/emotes/$mychannel)
-
Only animated GIF emotes
$readapi(https://decapi.me/bttv/emotes/$mychannel?types=gif)
-
Only static PNG emotes
$readapi(https://decapi.me/bttv/emotes/$mychannel?types=png)
Streamlabs Cloudbot
Note: Streamlabs Cloudbot will automatically convert variables, such as{channel.name}
or {touser.name}
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
{readapi.https://decapi.me/bttv/emotes/{channel.name}}
-
Only animated GIF emotes
{readapi.https://decapi.me/bttv/emotes/{channel.name}?types=gif}
-
Only static PNG emotes
{readapi.https://decapi.me/bttv/emotes/{channel.name}?types=png}
Deepbot
Note: Deepbot will automatically convert variables, such as@stream@
or @user@
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
@customapi@[https://decapi.me/bttv/emotes/@stream@]
-
Only animated GIF emotes
@customapi@[https://decapi.me/bttv/emotes/@stream@?types=gif]
-
Only static PNG emotes
@customapi@[https://decapi.me/bttv/emotes/@stream@?types=png]
PhantomBot
Note: PhantomBot will automatically convert variables, such as(channelname)
or (touser)
to the correct channel name / username, when the command is used.
You do not have to change those variables.
-
All types of emotes (default)
(customapi https://decapi.me/bttv/emotes/(channelname))
-
Only animated GIF emotes
(customapi https://decapi.me/bttv/emotes/(channelname)?types=gif)
-
Only static PNG emotes
(customapi https://decapi.me/bttv/emotes/(channelname)?types=png)