Reference
Scopes
Every OAuth scope, and the methods of the library it unlocks.
Ask for the scopes your application needs when you send a user to Twitch. A method lists several scopes when any one of them is enough. Event subscriptions have their own requirements: see the event types.
| Scope | Unlocks |
|---|---|
analytics:read:extensions | analytics.extensions |
analytics:read:games | analytics.games |
bits:read | bits.leaderboard, bits.customPowerUps |
channel:bot | Used by event subscriptions only. |
channel:edit:commercial | ads.startCommercial |
channel:manage:ads | ads.snooze |
channel:manage:broadcast | channels.update, streams.createMarker, streams.markers |
channel:manage:clips | clips.createFromVod, clips.downloads |
channel:manage:extensions | Used by event subscriptions only. |
channel:manage:guest_star | guestStar.settings, guestStar.updateSettings, guestStar.session, guestStar.createSession, guestStar.endSession, guestStar.invites, guestStar.invite, guestStar.deleteInvite, guestStar.assignSlot, guestStar.updateSlot, guestStar.deleteSlot, guestStar.updateSlotSettings |
channel:manage:moderators | moderation.moderators, moderation.addModerator, moderation.removeModerator |
channel:manage:polls | polls.get, polls.create, polls.end |
channel:manage:predictions | predictions.get, predictions.create, predictions.end |
channel:manage:raids | raids.start, raids.cancel |
channel:manage:redemptions | channelPoints.createReward, channelPoints.deleteReward, channelPoints.rewards, channelPoints.redemptions, channelPoints.updateReward, channelPoints.updateRedemptions |
channel:manage:schedule | schedule.updateSettings, schedule.createSegment, schedule.updateSegment, schedule.deleteSegment |
channel:manage:videos | videos.delete |
channel:manage:vips | moderation.vips, moderation.addVip, moderation.removeVip |
channel:moderate | Used by event subscriptions only. |
channel:read:ads | ads.schedule |
channel:read:charity | charity.campaign, charity.donations |
channel:read:editors | channels.editors |
channel:read:goals | goals.get |
channel:read:guest_star | guestStar.settings, guestStar.session, guestStar.invites |
channel:read:hype_train | hypeTrain.status |
channel:read:polls | polls.get |
channel:read:predictions | predictions.get |
channel:read:redemptions | channelPoints.rewards, channelPoints.redemptions |
channel:read:stream_key | streams.key |
channel:read:subscriptions | subscriptions.get |
channel:read:vips | moderation.vips |
chat:edit | Used by event subscriptions only. |
chat:read | Used by event subscriptions only. |
clips:edit | clips.create |
editor:manage:clips | clips.createFromVod, clips.downloads |
moderation:read | moderation.checkAutoMod, moderation.bans, moderation.moderators |
moderator:manage:announcements | chat.announce |
moderator:manage:automod | moderation.manageAutoModMessage |
moderator:manage:automod_settings | moderation.autoModSettings, moderation.updateAutoModSettings |
moderator:manage:banned_users | moderation.bans, moderation.ban, moderation.unban |
moderator:manage:blocked_terms | moderation.blockedTerms, moderation.addBlockedTerm, moderation.removeBlockedTerm |
moderator:manage:chat_messages | chat.pinnedMessage, chat.pin, chat.updatePin, chat.unpin, moderation.deleteMessages |
moderator:manage:chat_settings | chat.updateSettings |
moderator:manage:guest_star | guestStar.settings, guestStar.session, guestStar.invites, guestStar.invite, guestStar.deleteInvite, guestStar.assignSlot, guestStar.updateSlot, guestStar.deleteSlot, guestStar.updateSlotSettings |
moderator:manage:shield_mode | moderation.updateShieldMode, moderation.shieldMode |
moderator:manage:shoutouts | chat.shoutout |
moderator:manage:suspicious_users | moderation.addSuspiciousStatus, moderation.removeSuspiciousStatus |
moderator:manage:unban_requests | moderation.unbanRequests, moderation.resolveUnbanRequest |
moderator:manage:warnings | moderation.warn |
moderator:read:automod_settings | moderation.autoModSettings |
moderator:read:banned_users | Used by event subscriptions only. |
moderator:read:blocked_terms | moderation.blockedTerms |
moderator:read:chat_messages | chat.pinnedMessage |
moderator:read:chat_settings | Used by event subscriptions only. |
moderator:read:chatters | chat.chatters |
moderator:read:followers | channels.followers |
moderator:read:guest_star | guestStar.settings, guestStar.session, guestStar.invites |
moderator:read:moderators | Used by event subscriptions only. |
moderator:read:shield_mode | moderation.shieldMode |
moderator:read:shoutouts | Used by event subscriptions only. |
moderator:read:suspicious_users | Used by event subscriptions only. |
moderator:read:unban_requests | moderation.unbanRequests |
moderator:read:vips | Used by event subscriptions only. |
moderator:read:warnings | Used by event subscriptions only. |
user:bot | Used by event subscriptions only. |
user:edit | users.update |
user:edit:broadcast | users.extensions, users.updateExtensions |
user:manage:blocked_users | users.block, users.unblock |
user:manage:chat_color | chat.setColor |
user:manage:whispers | whispers.send |
user:read:blocked_users | users.blocks |
user:read:broadcast | streams.markers, users.extensions |
user:read:chat | Used by event subscriptions only. |
user:read:email | Used by event subscriptions only. |
user:read:emotes | chat.userEmotes |
user:read:follows | channels.followed, streams.followed |
user:read:moderated_channels | moderation.moderatedChannels |
user:read:subscriptions | subscriptions.check |
user:read:whispers | Used by event subscriptions only. |
user:write:chat | chat.send |
whispers:read | Used by event subscriptions only. |