Chat is where Twitch users can interact with each other while watching a stream.
Endpoint | Description |
---|---|
GET /chat/:channel | Get links object to other chat endpoints |
GET /chat/:channel/badges | Get chat badges for channel |
GET /chat/emoticons | Get list of every emoticon object |
GET /chat/emoticon_images | Get list of emoticons |
Returns a links object to all other chat endpoints.
curl -H 'Accept: application/vnd.twitchtv.v3+json' \
-X GET https://api.twitch.tv/kraken/chat/kraken_test_user
{
"_links": {
"self": "https://api.twitch.tv/kraken/chat/kraken_test_user",
"emoticons":"https://api.twitch.tv/kraken/chat/kraken_test_user/emoticons",
"badges": "https://api.twitch.tv/kraken/chat/kraken_test_user/badges"
}
}
Returns a list of all emoticon objects for Twitch.
curl -H 'Accept: application/vnd.twitchtv.v3+json' \
-X GET https://api.twitch.tv/kraken/chat/emoticons
{
"_links": {
"self": "https://api.twitch.tv/kraken/chat/emoticons"
},
"emoticons": [
{
"regex": "\:-?\(",
"images": [
{
"emoticon_set": null,
"height": 18,
"width": 24,
"url": "http://static-cdn.jtvnw.net/jtv_user_pictures/chansub-global-emoticon-d570c4b3b8d8fc4d-24x18.png"
},
{
"emoticon_set": 33,
"height": 18,
"width": 21,
"url": "http://static-cdn.jtvnw.net/jtv_user_pictures/chansub-global-emoticon-c41c5c6c88f481cd-21x18.png"
}
]
},
...
]
}
Returns a list of emoticons.
Name | Required? | Type | Description |
---|---|---|---|
emotesets |
optional | string | Emotes from a comma separated list of emote sets. |
curl -H 'Accept: application/vnd.twitchtv.v3+json'
-X GET https://api.twitch.tv/kraken/chat/emoticon_images
Without specified emote sets:
{
"emoticons": [
{
"id": 25,
"code": "Kappa",
"emoticon_set": null
},
{
"id": 2412,
"code": "pipeKoppa",
"emoticon_set": 469
},
...
]
}
With specified emote sets:
{
"emoticon_sets": {
"0": [
{
"id": 25,
"code": "Kappa"
},
{
"id": 1902,
"code": "Keepo"
},
...
],
"469": [
{
"id": 2412,
"code": "pipeKoppa"
},
{
"id": 33152,
"code": "pipeKappa"
},
...
]
}
}
Returns a list of chat badges that can be used in the :channel
's chat.
curl -H 'Accept: application/vnd.twitchtv.v3+json' \
-X GET https://api.twitch.tv/kraken/chat/test_user1/badges
{
"global_mod": {
"alpha": "http://chat-badges.s3.amazonaws.com/globalmod-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/globalmod.png",
"svg": "http://chat-badges.s3.amazonaws.com/globalmod.svg"
},
"admin": {
"alpha": "http://chat-badges.s3.amazonaws.com/admin-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/admin.png",
"svg": "http://chat-badges.s3.amazonaws.com/admin.svg"
},
"broadcaster": {
"alpha": "http://chat-badges.s3.amazonaws.com/broadcaster-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/broadcaster.png",
"svg": "http://chat-badges.s3.amazonaws.com/broadcaster.svg"
},
"mod": {
"alpha": "http://chat-badges.s3.amazonaws.com/mod-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/mod.png",
"svg": "http://chat-badges.s3.amazonaws.com/mod.svg"
},
"staff": {
"alpha": "http://chat-badges.s3.amazonaws.com/staff-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/staff.png",
"svg": "http://chat-badges.s3.amazonaws.com/staff.svg"
},
"turbo": {
"alpha": "http://chat-badges.s3.amazonaws.com/turbo-alpha.png",
"image": "http://chat-badges.s3.amazonaws.com/turbo.png",
"svg": "http://chat-badges.s3.amazonaws.com/turbo.svg"
},
"subscriber": null,
"_links": {
"self": "https://api.twitch.tv/kraken/chat/test_user1/badges"
}
}