twitchAPI.types¶
Type Definitions
- enum twitchAPI.types.AnalyticsReportType(value)¶
Enum of all Analytics report types
Valid values are as follows:
- V1¶
- V2¶
- enum twitchAPI.types.AuthScope(value)¶
Enum of Authentication scopes
Valid values are as follows:
- ANALYTICS_READ_EXTENSION¶
- ANALYTICS_READ_GAMES¶
- BITS_READ¶
- CHANNEL_READ_SUBSCRIPTIONS¶
- CHANNEL_READ_STREAM_KEY¶
- CHANNEL_EDIT_COMMERCIAL¶
- CHANNEL_READ_HYPE_TRAIN¶
- CHANNEL_MANAGE_BROADCAST¶
- CHANNEL_READ_REDEMPTIONS¶
- CHANNEL_MANAGE_REDEMPTIONS¶
- CLIPS_EDIT¶
- USER_EDIT¶
- USER_EDIT_BROADCAST¶
- USER_READ_BROADCAST¶
- USER_READ_EMAIL¶
- USER_EDIT_FOLLOWS¶
- CHANNEL_MODERATE¶
- CHAT_EDIT¶
- CHAT_READ¶
- WHISPERS_READ¶
- WHISPERS_EDIT¶
- MODERATION_READ¶
- CHANNEL_SUBSCRIPTIONS¶
- CHANNEL_READ_EDITORS¶
- CHANNEL_MANAGE_VIDEOS¶
- USER_READ_BLOCKED_USERS¶
- USER_MANAGE_BLOCKED_USERS¶
- USER_READ_SUBSCRIPTIONS¶
- USER_READ_FOLLOWS¶
- CHANNEL_READ_POLLS¶
- CHANNEL_MANAGE_POLLS¶
- CHANNEL_READ_PREDICTIONS¶
- CHANNEL_MANAGE_PREDICTIONS¶
- MODERATOR_MANAGE_AUTOMOD¶
- CHANNEL_MANAGE_SCHEDULE¶
- enum twitchAPI.types.ModerationEventType(value)¶
Enum of moderation event types
Valid values are as follows:
- BAN¶
- UNBAN¶
- UNKNOWN¶
- enum twitchAPI.types.TimePeriod(value)¶
Enum of valid Time periods
Valid values are as follows:
- ALL¶
- DAY¶
- WEEK¶
- MONTH¶
- YEAR¶
- enum twitchAPI.types.SortMethod(value)¶
Enum of valid sort methods
Valid values are as follows:
- TIME¶
- TRENDING¶
- VIEWS¶
- enum twitchAPI.types.HypeTrainContributionMethod(value)¶
Enum of valid Hype Train contribution types
Valid values are as follows:
- BITS¶
- SUBS¶
- UNKNOWN¶
- enum twitchAPI.types.VideoType(value)¶
Enum of valid video types
Valid values are as follows:
- ALL¶
- UPLOAD¶
- ARCHIVE¶
- HIGHLIGHT¶
- UNKNOWN¶
- enum twitchAPI.types.AuthType(value)¶
Type of authentication required. Only internal use
Valid values are as follows:
- NONE¶
- USER¶
- APP¶
- EITHER¶
- enum twitchAPI.types.CodeStatus(value)¶
Enum Code Status, see https://dev.twitch.tv/docs/api/reference#get-code-status for more documentation
Valid values are as follows:
- SUCCESSFULLY_REDEEMED¶
- ALREADY_CLAIMED¶
- EXPIRED¶
- USER_NOT_ELIGIBLE¶
- NOT_FOUND¶
- INACTIVE¶
- UNUSED¶
- INCORRECT_FORMAT¶
- INTERNAL_ERROR¶
- UNKNOWN_VALUE¶
- enum twitchAPI.types.PubSubResponseError(value)¶
Valid values are as follows:
- BAD_MESSAGE¶
- BAD_AUTH¶
- SERVER¶
- BAD_TOPIC¶
- NONE¶
- UNKNOWN¶
- enum twitchAPI.types.CustomRewardRedemptionStatus(value)¶
Valid values are as follows:
- UNFULFILLED¶
- FULFILLED¶
- CANCELED¶
- enum twitchAPI.types.EntitlementFulfillmentStatus(value)¶
Valid values are as follows:
- CLAIMED¶
- FULFILLED¶
- enum twitchAPI.types.PollStatus(value)¶
Valid values are as follows:
- ACTIVE¶
- COMPLETED¶
- MODERATED¶
- INVALID¶
- TERMINATED¶
- ARCHIVED¶
- enum twitchAPI.types.PredictionStatus(value)¶
Valid values are as follows:
- ACTIVE¶
- RESOLVED¶
- CANCELED¶
- LOCKED¶
- class twitchAPI.types.AutoModCheckEntry(**kwargs)¶
- exception twitchAPI.types.TwitchAPIException¶
Base Twitch API Exception
- exception twitchAPI.types.InvalidRefreshTokenException¶
used User Refresh Token is invalid
- exception twitchAPI.types.InvalidTokenException¶
Used if a invalid token is set for the client
- exception twitchAPI.types.NotFoundException¶
Resource was not found with the given parameter
- exception twitchAPI.types.TwitchAuthorizationException¶
Exception in the Twitch Authorization
- exception twitchAPI.types.UnauthorizedException¶
Not authorized to use this
- exception twitchAPI.types.MissingScopeException¶
authorization is missing scope
- exception twitchAPI.types.TwitchBackendException¶
when the Twitch API itself is down
- exception twitchAPI.types.PubSubListenTimeoutException¶
when a a PubSub listen command times out
- exception twitchAPI.types.MissingAppSecretException¶
When the app secret is not set but app authorization is attempted
- exception twitchAPI.types.EventSubSubscriptionTimeout¶
When the waiting for a confirmed EventSub subscription timed out
- exception twitchAPI.types.EventSubSubscriptionConflict¶
When you try to subscribe to a EventSub subscription that already exists
- exception twitchAPI.types.EventSubSubscriptionError¶
if the subscription request was invalid
- exception twitchAPI.types.DeprecatedError¶
If something has been marked as deprecated by the Twitch API