twitchAPI.types

Type Definitions

class twitchAPI.types.AnalyticsReportType

Enum of all Analytics report types

Variables:
  • V1 –
  • V2 –
class twitchAPI.types.AuthScope

Enum of Authentication scopes

Variables:
  • 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 –
class twitchAPI.types.AuthType

Type of authentication required. Only internal use

Variables:
  • NONE – No auth required
  • USER – User auth required
  • APP – app auth required
class twitchAPI.types.CodeStatus

Enum Code Status, see https://dev.twitch.tv/docs/api/reference#get-code-status for more documentation

Variables:
  • SUCCESSFULLY_REDEEMED –
  • ALREADY_CLAIMED –
  • EXPIRED –
  • USER_NOT_ELIGIBLE –
  • NOT_FOUND –
  • INACTIVE –
  • UNUSED –
  • INCORRECT_FORMAT –
  • INTERNAL_ERROR –
  • UNKNOWN_VALUE –
class twitchAPI.types.CustomRewardRedemptionStatus
Variables:
  • UNFULFILLED –
  • FULFILLED –
  • CANCELED –
class twitchAPI.types.HypeTrainContributionMethod

Enum of valid Hype Train contribution types

Variables:
  • BITS –
  • SUBS –
  • UNKNOWN –
exception twitchAPI.types.InvalidRefreshTokenException

used User Refresh Token is invalid

exception twitchAPI.types.MissingScopeException

authorization is missing scope

class twitchAPI.types.ModerationEventType

Enum of moderation event types

Variables:
  • BAN –
  • UNBAN –
  • UNKNOWN –
exception twitchAPI.types.NotFoundException

Resource was not found with the given parameter

exception twitchAPI.types.PubSubListenTimeoutException

when a a PubSub listen command times out

class twitchAPI.types.PubSubResponseError
Variables:
  • BAD_MESSAGE – message is malformed
  • BAD_AUTH – user auth token is invalid
  • SERVER – server error
  • BAD_TOPIC – topic is invalid
  • NONE – no Error
  • UNKNOWN – a unknown error
class twitchAPI.types.SortMethod

Enum of valid sort methods

Variables:
  • TIME –
  • TRENDING –
  • VIEWS –
class twitchAPI.types.SortOrder
Variables:
  • OLDEST –
  • NEWEST –
class twitchAPI.types.TimePeriod

Enum of valid Time periods

Variables:
  • ALL –
  • DAY –
  • WEEK –
  • MONTH –
  • YEAR –
exception twitchAPI.types.TwitchAPIException

Base Twitch API Exception

exception twitchAPI.types.TwitchAuthorizationException

Exception in the Twitch Authorization

exception twitchAPI.types.TwitchBackendException

when the Twitch API itself is down

exception twitchAPI.types.UnauthorizedException

Not authorized to use this

class twitchAPI.types.VideoType

Enum of valid video types

Variables:
  • ALL –
  • UPLOAD –
  • ARCHIVE –
  • HIGHLIGHT –
  • UNKNOWN –