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.

Cached endpoint

This endpoint is cached and won't always be fully up-to-date. See the Cached endpoints page for more information.

Emotes - Get emotes for a Twitch channel

Gets the available emotes for the specified Twitch channel, such as bits emotes, subscriber emotes and follower emotes.

Optional filtering can be done via the types query parameter.

Only Twitch emotes

This endpoint only retrieves Twitch-native emotes. It does not include third-party emotes from services such as BetterTTV, FrankerFaceZ or 7TV.

For BetterTTV emotes, you can use the BetterTTV emotes endpoint.

Likewise, for FrankerFaceZ emotes, you can use the FrankerFaceZ emotes endpoint.

7TV is currently not supported by DecAPI.

Endpoint URL

https://decapi.me/twitch/emotes/CHANNEL_USERNAME_HERE

Required URL parameters

• channel - Required - Twitch channel to retrieve subscriber emotes for.

Query parameters

• types - Optional. Filter by emote "category" (type). Comma-separated list of the following values:
  • bitstier - Bits emotes
  • subscriptions - Subscriber emotes
  • follower - Follower emotes
  • The default (not specified) is to return all emotes of every type.

Examples

• All of LIRIK's emotes (all types): https://decapi.me/twitch/emotes/lirik
• Decicus' subscriber emotes: https://decapi.me/twitch/emotes/decicus?types=subscriptions
• Halifax's follower emotes: https://decapi.me/twitch/emotes/halifax?types=follower
• Katie's bits and subscriber emotes (no follower emotes): https://decapi.me/twitch/emotes/katie?types=bitstier,subscriptions

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  $(urlfetch https://decapi.me/twitch/emotes/$(channel))
• Get only bits and follower emotes
  $(urlfetch https://decapi.me/twitch/emotes/$(channel)?types=bitstier,follower)

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  $(customapi https://decapi.me/twitch/emotes/$(channel))
• Get only bits and follower emotes
  $(customapi https://decapi.me/twitch/emotes/$(channel)?types=bitstier,follower)

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  ${customapi.https://decapi.me/twitch/emotes/${channel}}
• Get only bits and follower emotes
  ${customapi.https://decapi.me/twitch/emotes/${channel}?types=bitstier,follower}

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  $readapi(https://decapi.me/twitch/emotes/$mychannel)
• Get only bits and follower emotes
  $readapi(https://decapi.me/twitch/emotes/$mychannel?types=bitstier,follower)

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  {readapi.https://decapi.me/twitch/emotes/{channel.name}}
• Get only bits and follower emotes
  {readapi.https://decapi.me/twitch/emotes/{channel.name}?types=bitstier,follower}

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  @customapi@[https://decapi.me/twitch/emotes/@stream@]
• Get only bits and follower emotes
  @customapi@[https://decapi.me/twitch/emotes/@stream@?types=bitstier,follower]

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.

• Get all emotes for a channel (bits, subscriber and follower emotes)
  (customapi https://decapi.me/twitch/emotes/(channelname))
• Get only bits and follower emotes
  (customapi https://decapi.me/twitch/emotes/(channelname)?types=bitstier,follower)