mirror-chatterino2/src/providers/twitch/api/README.md

# Twitch API
this folder describes what sort of API requests we do, what permissions are required for the requests etc

## Kraken (V5)
We use a bunch of Kraken (V5) in Chatterino2.

### Get Cheermotes
URL: https://dev.twitch.tv/docs/v5/reference/bits#get-cheermotes

Migration path: **Not checked**

 * We implement this API in `providers/twitch/TwitchChannel.cpp` to resolve a chats available cheer emotes. This helps us parse incoming messages like `pajaCheer1000`

### Get User Block List
URL: https://dev.twitch.tv/docs/v5/reference/users#get-user-block-list

Migration path: **Unknown**

 * We use this in `providers/twitch/TwitchAccount.cpp loadIgnores`

### Block User
URL: https://dev.twitch.tv/docs/v5/reference/users#block-user  
Requires `user_blocks_edit` scope

Migration path: **Unknown**

 * We use this in `providers/twitch/TwitchAccount.cpp ignoreByID`

### Unblock User
URL: https://dev.twitch.tv/docs/v5/reference/users#unblock-user  
Requires `user_blocks_edit` scope

Migration path: **Unknown**

 * We use this in `providers/twitch/TwitchAccount.cpp unignoreByID`

### Get User Emotes
URL: https://dev.twitch.tv/docs/v5/reference/users#get-user-emotes  
Requires `user_subscriptions` scope

Migration path: **Unknown**

 * We use this in `providers/twitch/TwitchAccount.cpp loadEmotes` to figure out which emotes a user is allowed to use!

### AUTOMOD APPROVE
**Unofficial** documentation: https://discuss.dev.twitch.tv/t/allowing-others-aka-bots-to-use-twitchbot-reject/8508/2

 * We use this in `providers/twitch/TwitchAccount.cpp autoModAllow` to approve an automod deny/allow question

### AUTOMOD DENY
**Unofficial** documentation: https://discuss.dev.twitch.tv/t/allowing-others-aka-bots-to-use-twitchbot-reject/8508/2

 * We use this in `providers/twitch/TwitchAccount.cpp autoModDeny` to deny an automod deny/allow question

## Helix
Full Helix API reference: https://dev.twitch.tv/docs/api/reference

### Get Users
URL: https://dev.twitch.tv/docs/api/reference#get-users

 * We implement this in `providers/twitch/api/Helix.cpp fetchUsers`.  
   Used in:
     * `UserInfoPopup` to get ID, viewCount, displayName, createdAt of username we clicked
     * `CommandController` to power any commands that need to get a user ID
     * `Toasts` to get the profile picture of a streamer who just went live
     * `TwitchAccount` ignore and unignore features to translate user name to user ID

### Get Users Follows
URL: https://dev.twitch.tv/docs/api/reference#get-users-follows

 * We implement this in `providers/twitch/api/Helix.cpp fetchUsersFollows`  
   Used in:
     * `UserInfoPopup` to get number of followers a user has

### Get Streams
URL: https://dev.twitch.tv/docs/api/reference#get-streams

 * We implement this in `providers/twitch/api/Helix.cpp fetchStreams`  
   Used in:
     * `TwitchChannel` to get live status, game, title, and viewer count of a channel
     * `NotificationController` to provide notifications for channels you might not have open in Chatterino, but are still interested in getting notifications for

### Follow User
URL: https://dev.twitch.tv/docs/api/reference#create-user-follows  
Requires `user:edit:follows` scope

 * We implement this in `providers/twitch/api/Helix.cpp followUser`  
   Used in:
     * `widgets/dialogs/UserInfoPopup.cpp` to follow a user by ticking follow checkbox in usercard
     * `controllers/commands/CommandController.cpp` in /follow command

### Unfollow User
URL: https://dev.twitch.tv/docs/api/reference#delete-user-follows  
Requires `user:edit:follows` scope

 * We implement this in `providers/twitch/api/Helix.cpp unfollowUser`  
   Used in:
     * `widgets/dialogs/UserInfoPopup.cpp` to unfollow a user by unticking follow checkbox in usercard
     * `controllers/commands/CommandController.cpp` in /unfollow command

### Create Clip
URL: https://dev.twitch.tv/docs/api/reference#create-clip  
Requires `clips:edit` scope

 * We implement this in `providers/twitch/api/Helix.cpp createClip`  
   Used in:
     * `TwitchChannel` to create a clip of a live broadcast

### Get Channel
URL: https://dev.twitch.tv/docs/api/reference#get-channel-information

 * We implement this in `providers/twitch/api/Helix.cpp getChannel`
   Used in:
     * `TwitchChannel` to refresh stream title

### Create Stream Marker
URL: https://dev.twitch.tv/docs/api/reference/#create-stream-marker  
Requires `user:edit:broadcast` scope

 * We implement this in `providers/twitch/api/Helix.cpp createStreamMarker`  
   Used in:
     * `controllers/commands/CommandController.cpp` in /marker command

## TMI
The TMI api is undocumented.

### Get Chatters
**Undocumented**

 * We use this in `widgets/splits/Split.cpp showViewerList`
 * We use this in `providers/twitch/TwitchChannel.cpp refreshChatters`