Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Commit

Permalink
Add definition for /users/:user/emotes (justintv#497)
Browse files Browse the repository at this point in the history
* Update users.md

Add emotes documentation.

* Update users.md

Have description match index.

* Update README.md

Update index

* Update chat.md

Add reference in chat to new /users/... endpoint.
  • Loading branch information
cconger authored and FugiTech committed May 6, 2016
1 parent 8dacd43 commit ffe3ac0
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ We use an OAuth 2.0, an authentication protocol designed to make accessing user
| Endpoint | Description |
| ---- | --------------- |
| [GET /users/:user](/v3_resources/users.md#get-usersuser) | Get user object |
| [GET /users/:user/emotes](v3_resources/users.md#get-usersuseremotes) | Get list of user's emotes |
| [GET /user](/v3_resources/users.md#get-user) | Get user object |
| [GET /streams/followed](/v3_resources/users.md#get-streamsfollowed) | Get list of streams user is following |
| [GET /videos/followed](/v3_resources/users.md#get-videosfollowed) | Get list of videos belonging to channels user is following |
Expand Down
2 changes: 2 additions & 0 deletions v3_resources/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ curl -H 'Accept: application/vnd.twitchtv.v3+json' \

Returns a list of emoticons.

_Note:_ You can query a user's list of usable emoticons with [`GET /users/:user/emotes`](users.md#get-usersuseremotes)

### Parameters

<table>
Expand Down
45 changes: 45 additions & 0 deletions v3_resources/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ These are members of the Twitch community who have a Twitch account. If broadcas
| Endpoint | Description |
| ---- | --------------- |
| [GET /users/:user](/v3_resources/users.md#get-usersuser) | Get user object |
| [GET /users/:user/emotes](/v3_resources/users.md#get-usersuseremotes) | Get list of user's emotes |
| [GET /user](/v3_resources/users.md#get-user) | Get user object |
| [GET /streams/followed](/v3_resources/users.md#get-streamsfollowed) | Get list of streams user is following |
| [GET /videos/followed](/v3_resources/users.md#get-videosfollowed) | Get list of videos belonging to channels user is following |
Expand Down Expand Up @@ -43,6 +44,50 @@ curl -H 'Accept: application/vnd.twitchtv.v3+json' \
}
```

## `GET /users/:user/emotes`

Returns a list of emoticons that the user is authorized to use.

*__Authenticated__*, required scope: `user_subscriptions`

### Example Request

```bash
curl -H 'Accept: application/vnd.twitchtv.v3+json' -H 'Authorization: OAuth <access_token>' \
-X GET https://api.twitch.tv/kraken/users/test_user1/emotes
```

### Example Response

```json
{
"emoticon_sets": {
"0": [
{
"id": 25,
"code": "Kappa"
},
{
"id": 1902,
"code": "Keepo"
},
...
],
"469": [
{
"id": 2412,
"code": "pipeKoppa"
},
{
"id": 33152,
"code": "pipeKappa"
},
...
]
}
}
```

## `GET /user`

Returns a user object.
Expand Down

0 comments on commit ffe3ac0

Please sign in to comment.