helix

package module
v1.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 31, 2021 License: MIT Imports: 18 Imported by: 115

README

helix

A Twitch Helix API client written in Go (Golang).

Tests and Coverage Coverage Status

Package Status

Twitch is always expanding and improving the available endpoints and features for the Helix API. The maintainers of this package will make a best effort approach to implementing new changes as they are released by the Twitch team.

Documentation & Examples

All documentation and usage examples for this package can be found in the docs directory. If you are looking for the Twitch API docs, see the Twitch Developer website.

Supported Endpoints & Features

Authentication:

  • Generate Authorization URL ("code" or "token" authorization)
  • Get App Access Tokens (OAuth Client Credentials Flow)
  • Get User Access Tokens (OAuth Authorization Code Flow)
  • Refresh User Access Tokens
  • Revoke User Access Tokens
  • Validate Access Token

API Endpoint:

  • Start Commercial
  • Get Extension Analytics
  • Get Game Analytics
  • Get Bits Leaderboard
  • Get Cheermotes
  • Get Extension Transactions
  • Get Channel Information
  • Modify Channel Information
  • Get Channel Editors
  • Create Custom Rewards
  • Delete Custom Reward
  • Get Custom Reward
  • Get Custom Reward Redemption
  • Update Custom Reward
  • Update Redemption Status
  • Get Channel Emotes
  • Get Global Emotes
  • Get Emote Sets
  • Get Channel Chat Badges
  • Get Global Chat Badges
  • Create Clip
  • Get Clip
  • Get Clips
  • Create Entitlement Grants Upload URL
  • Get Code Status
  • Get Drops Entitlements
  • Update Drops Entitlements
  • Redeem Code
  • Create / Remove / List EventSub Subscriptions
  • Get Top Games
  • Get Games
  • Get Hype Train Events
  • Check AutoMod Status
  • Manage Held AutoMod Messages
  • Get Banned Events
  • Get Banned Users
  • Get Moderators
  • Get Moderator Events
  • Get Polls
  • Create Poll
  • End Poll
  • Get Predictions
  • Create Prediction
  • End Prediction
  • Get Channel Stream Schedule
  • Get Channel iCalendar
  • Update Channel Stream Schedule
  • Create Channel Stream Schedule Segment
  • Update Channel Stream Schedule Segment
  • Delete Channel Stream Schedule Segment
  • Search Categories
  • Search Channels
  • Get Stream Key
  • Get Streams
  • Get Followed Streams
  • Create Stream Marker
  • Get Stream Markers
  • Get Broadcaster Subscriptions
  • Check User Subscription
  • Get All Stream Tags
  • Get Stream Tags
  • Replace Stream Tags
  • Get Channel Teams
  • Get Teams
  • Get Users
  • Update User
  • Get Users Follows
  • Get User Block List
  • Block User
  • UnBlock User
  • Get User Extensions
  • Get User Active Extensions
  • Update User Extensions
  • Get Videos
  • Delete Videos
  • Get Webhook Subscriptions
  • Create Extension Secret
  • Get Extension Secret
  • Revoke Extension Secrets
  • Get Live Channels with Extension Activated
  • Set Extension Required Configuration
  • Set Extension Configuration Segment
  • Get Extension Channel Configuration
  • Get Extension Configuration Segment
  • Send Extension PubSub Message
  • Send Extension Chat Message

Quick Usage Example

This is a quick example of how to get users. Note that you don't need to provide both a list of ids and logins, one or the other will suffice.

client, err := helix.NewClient(&helix.Options{
    ClientID: "your-client-id",
})
if err != nil {
    // handle error
}

resp, err := client.GetUsers(&helix.UsersParams{
    IDs:    []string{"26301881", "18074328"},
    Logins: []string{"summit1g", "lirik"},
})
if err != nil {
    // handle error
}

fmt.Printf("Status code: %d\n", resp.StatusCode)
fmt.Printf("Rate limit: %d\n", resp.GetRateLimit())
fmt.Printf("Rate limit remaining: %d\n", resp.GetRateLimitRemaining())
fmt.Printf("Rate limit reset: %d\n\n", resp.GetRateLimitReset())

for _, user := range resp.Data.Users {
    fmt.Printf("ID: %s Name: %s\n", user.ID, user.DisplayName)
}

Output:

Status code: 200
Rate limit: 30
Rate limit remaining: 29
Rate limit reset: 1517695315

ID: 26301881 Name: sodapoppin
ID: 18074328 Name: destiny
ID: 26490481 Name: summit1g
ID: 23161357 Name: lirik

Contributions

PRs are very much welcome. Where possible, please include tests for any code that is introduced by your PRs.

License

This package is distributed under the terms of the MIT License.

Documentation

Index

Constants

View Source 
const (
	SUCCESSFULLY_REDEEMED EntitlementCodeStatus = "SUCCESSFULLY_REDEEMED"
	ALREADY_CLAIMED                             = "ALREADY_CLAIMED"
	EXPIRED                                     = "EXPIRED"
	USER_NOT_ELIGIBLE                           = "USER_NOT_ELIGIBLE"
	NOT_FOUND                                   = "NOT_FOUND"
	INACTIVE                                    = "INACTIVE"
	UNUSED                                      = "UNUSED"
	INCORRECT_FORMAT                            = "INCORRECT_FORMAT"
	INTERNAL_ERROR                              = "INTERNAL_ERROR"
)
View Source 
const (
	EventSubStatusEnabled                      = "enabled"
	EventSubStatusPending                      = "webhook_callback_verification_pending"
	EventSubStatusFailed                       = "webhook_callback_verification_failed"
	EventSubStatusNotificationFailuresExceeded = "notification_failures_exceeded"
	EventSubStatusAuthorizationRevoked         = "authorization_revoked"
	EventSubStatusUserRemoved                  = "user_removed"

	EventSubTypeChannelUpdate                             = "channel.update"
	EventSubTypeChannelFollow                             = "channel.follow"
	EventSubTypeChannelSubscription                       = "channel.subscribe"
	EventSubTypeChannelSubscriptionEnd                    = "channel.subscription.end"
	EventSubTypeChannelSubscriptionGift                   = "channel.subscription.gift"
	EventSubTypeChannelSubscriptionMessage                = "channel.subscription.message"
	EventSubTypeChannelCheer                              = "channel.cheer"
	EventSubTypeChannelRaid                               = "channel.raid"
	EventSubTypeChannelBan                                = "channel.ban"
	EventSubTypeChannelUnban                              = "channel.unban"
	EventSubTypeModeratorAdd                              = "channel.moderator.add"
	EventSubTypeModeratorRemove                           = "channel.moderator.remove"
	EventSubTypeChannelPointsCustomRewardAdd              = "channel.channel_points_custom_reward.add"
	EventSubTypeChannelPointsCustomRewardUpdate           = "channel.channel_points_custom_reward.update"
	EventSubTypeChannelPointsCustomRewardRemove           = "channel.channel_points_custom_reward.remove"
	EventSubTypeChannelPointsCustomRewardRedemptionAdd    = "channel.channel_points_custom_reward_redemption.add"
	EventSubTypeChannelPointsCustomRewardRedemptionUpdate = "channel.channel_points_custom_reward_redemption.update"
	EventSubTypeChannelPollBegin                          = "channel.poll.begin"
	EventSubTypeChannelPollProgress                       = "channel.poll.progress"
	EventSubTypeChannelPollEnd                            = "channel.poll.end"
	EventSubTypeChannelPredictionBegin                    = "channel.prediction.begin"
	EventSubTypeChannelPredictionProgress                 = "channel.prediction.progress"
	EventSubTypeChannelPredictionLock                     = "channel.prediction.lock"
	EventSubTypeChannelPredictionEnd                      = "channel.prediction.end"
	EventSubExtensionBitsTransactionCreate                = "extension.bits_transaction.create"
	EventSubTypeHypeTrainBegin                            = "channel.hype_train.begin"
	EventSubTypeHypeTrainProgress                         = "channel.hype_train.progress"
	EventSubTypeHypeTrainEnd                              = "channel.hype_train.end"
	EventSubTypeStreamOnline                              = "stream.online"
	EventSubTypeStreamOffline                             = "stream.offline"
	EventSubTypeUserAuthorizationRevoke                   = "user.authorization.revoke"
	EventSubTypeUserUpdate                                = "user.update"
)

EventSub helper Variables for Types and Status

View Source 
const (
	// DefaultAPIBaseURL is the base URL for composing API requests.
	DefaultAPIBaseURL = "https://api.twitch.tv/helix"

	// AuthBaseURL is the base URL for composing authentication requests.
	AuthBaseURL = "https://id.twitch.tv/oauth2"
)

Variables

View Source 
var (
	UserFollowsRegexp        = regexp.MustCompile("helix/users/follows\\?first=1(&from_id=(?P<from_id>\\d+))?(&to_id=(?P<to_id>\\d+))?>")
	StreamChangedRegexp      = regexp.MustCompile("helix/streams\\?user_id=(?P<user_id>\\d+)>")
	UserChangedRegexp        = regexp.MustCompile("helix/users\\?id=(?P<id>\\d+)>")
	GameAnalyticsRegexp      = regexp.MustCompile("helix/analytics\\?game_id=(?P<game_id>\\w+)>")
	ExtensionAnalyticsRegexp = regexp.MustCompile("helix/analytics\\?extension_id=(?P<extension_id>\\w+)>")
)

Regular expressions used for parsing webhook link headers

Functions

func GetWebhookTopicValuesFromRequest added in v0.4.2 

func GetWebhookTopicValuesFromRequest(req *http.Request, topic WebhookTopic) map[string]string

GetWebhookTopicValuesFromRequest inspects the "Link" request header to determine if it matches against any recognised webhooks topics and returns the unique values specified in the header.

For example, say we receive a "User Follows" webhook event from Twitch. Its "Link" header value look likes the following: 

<https://api.twitch.tv/helix/webhooks/hub>; rel="hub", <https://api.twitch.tv/helix/users/follows?first=1&from_id=111116&to_id=22222>; rel="self"

From which GetWebhookTopicValuesFromRequest will return a map with the values of from_id and to_id: 

map[from_id:111116 to_id:22222]

This is particularly useful for webhooks events that do not have a distinguishable JSON payload, such as the "Stream Changed" down event.

Additionally, if topic is not known you can pass -1 as its value and

func VerifyEventSubNotification added in v1.7.0 

func VerifyEventSubNotification(secret string, header http.Header, message string) bool

Verifys that a notification came from twitch using the a signature and the secret used when creating the subscription

Types

type AccessCredentials added in v0.7.0 

type AccessCredentials struct {
	AccessToken  string   `json:"access_token"`
	RefreshToken string   `json:"refresh_token"`
	ExpiresIn    int      `json:"expires_in"`
	Scopes       []string `json:"scope"`
}

type AdDetails added in v1.4.0 

type AdDetails struct {
	Length     AdLengthEnum `json:"length"`
	Message    string       `json:"message"`
	RetryAfter int          `json:"retry_after"`
}

type AdLengthEnum added in v1.4.0 

type AdLengthEnum int
const (
	AdLen30 AdLengthEnum
	AdLen60
	AdLen90
	AdLen120
	AdLen150
	AdLen180
)

type AppAccessTokenResponse 

type AppAccessTokenResponse struct {
	ResponseCommon
	Data AccessCredentials
}

type AuthorizationURLParams added in v0.7.0 

type AuthorizationURLParams struct {
	ResponseType string   // (Required) Options: "code" or "token"
	Scopes       []string // (Required)
	State        string   // (Optional)
	ForceVerify  bool     // (Optional)
}

type BadgeVersion added in v1.18.0 

type BadgeVersion struct {
	ID         string `json:"id"`
	ImageUrl1x string `json:"image_url_1x"`
	ImageUrl2x string `json:"image_url_2x"`
	ImageUrl4x string `json:"image_url_4x"`
}

type Ban added in v0.5.5 

type Ban struct {
	UserID    string `json:"user_id"`
	UserLogin string `json:"user_login"`
	UserName  string `json:"user_name"`
	ExpiresAt Time   `json:"expires_at"`
}

ExpiresAt must be parsed manually since an empty string means perma ban

type BannedUsersParams added in v0.5.5 

type BannedUsersParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	UserID        string `query:"user_id"`
	After         string `query:"after"`
	Before        string `query:"before"`
}

BroadcasterID must match the auth tokens user_id

type BannedUsersResponse added in v0.5.5 

type BannedUsersResponse struct {
	ResponseCommon
	Data ManyBans
}

type BitsLeaderboardParams 

type BitsLeaderboardParams struct {
	Count     int       `query:"count,10"`   // Maximum 100
	Period    string    `query:"period,all"` // "all" (default), "day", "week", "month" and "year"
	StartedAt time.Time `query:"started_at"`
	UserID    string    `query:"user_id"`
}

type BitsLeaderboardResponse 

type BitsLeaderboardResponse struct {
	ResponseCommon
	Data ManyUserBitTotals
}

type BlockUserParams added in v1.12.0 

type BlockUserParams struct {
	TargetUserID  string `query:"target_user_id"`
	SourceContext string `query:"source_context"` // Valid values: "chat", "whisper"
	Reason        string `query:"reason"`         // Valid values: "spam", "harassment", "other"
}

type BlockUserResponse added in v1.12.0 

type BlockUserResponse struct {
	ResponseCommon
}

type Channel added in v0.6.0 

type Channel struct {
	ID               string   `json:"id"`
	GameID           string   `json:"game_id"`
	GameName         string   `json:"game_name"`
	BroadcasterLogin string   `json:"broadcaster_login"`
	DisplayName      string   `json:"display_name"`
	Language         string   `json:"broadcaster_language"`
	Title            string   `json:"title"`
	ThumbnailURL     string   `json:"thumbnail_url"`
	IsLive           bool     `json:"is_live"`
	StartedAt        Time     `json:"started_at"`
	TagIDs           []string `json:"tag_ids"`
}

Channel describes a channel from SearchChannel

type ChannelCustomReward added in v1.17.0 

type ChannelCustomReward struct {
	BroadcasterID                     string                      `json:"broadcaster_id"`
	BroadcasterLogin                  string                      `json:"broadcaster_login"`
	BroadcasterName                   string                      `json:"broadcaster_name"`
	ID                                string                      `json:"id"`
	Title                             string                      `json:"title"`
	Prompt                            string                      `json:"prompt"`
	Cost                              int                         `json:"cost"`
	Image                             RewardImage                 `json:"image"`
	DefaultImage                      RewardImage                 `json:"default_image"`
	IsEnabled                         bool                        `json:"is_enabled"`
	IsUserInputRequired               bool                        `json:"is_user_input_required"`
	MaxPerStreamSetting               MaxPerStreamSettings        `json:"max_per_stream_setting"`
	MaxPerUserPerStreamSetting        MaxPerUserPerStreamSettings `json:"max_per_user_per_stream_setting"`
	GlobalCooldownSetting             GlobalCooldownSettings      `json:"global_cooldown_setting"`
	IsPaused                          bool                        `json:"is_paused"`
	IsInStock                         bool                        `json:"is_in_stock"`
	ShouldRedemptionsSkipRequestQueue bool                        `json:"should_redemptions_skip_request_queue"`
	RedemptionsRedeemedCurrentStream  int                         `json:"redemptions_redeemed_current_stream"`
	CooldownExpiresAt                 string                      `json:"cooldown_expires_at"`
}

type ChannelCustomRewardResponse added in v1.17.0 

type ChannelCustomRewardResponse struct {
	ResponseCommon
	Data ManyChannelCustomRewards
}

type ChannelCustomRewardsParams added in v1.17.0 

type ChannelCustomRewardsParams struct {
	BroadcasterID                     string `query:"broadcaster_id"`
	Title                             string `json:"title"`
	Cost                              int    `json:"cost"`
	Prompt                            string `json:"prompt"`
	IsEnabled                         bool   `json:"is_enabled"`
	BackgroundColor                   string `json:"background_color"`
	IsUserInputRequired               bool   `json:"is_user_input_required"`
	IsMaxPerStreamEnabled             bool   `json:"is_max_per_stream_enabled"`
	MaxPerStream                      int    `json:"max_per_stream"`
	IsMaxPerUserPerStreamEnabled      bool   `json:"is_max_per_user_per_stream_enabled"`
	MaxPerUserPerStream               int    `json:"max_per_user_per_stream"`
	IsGlobalCooldownEnabled           bool   `json:"is_global_cooldown_enabled"`
	GlobalCooldownSeconds             int    `json:"global_cooldown_seconds"`
	ShouldRedemptionsSkipRequestQueue bool   `json:"should_redemptions_skip_request_queue"`
}

type ChannelEditor added in v1.11.0 

type ChannelEditor struct {
	UserID    string `json:"user_id"`
	UserName  string `json:"user_name"`
	CreatedAt Time   `json:"created_at"`
}

ChannelEditor

type ChannelEditorsParams added in v1.11.0 

type ChannelEditorsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
}

type ChannelEditorsResponse added in v1.11.0 

type ChannelEditorsResponse struct {
	ResponseCommon
	Data ManyChannelEditors
}

type ChannelInformation added in v1.6.0 

type ChannelInformation struct {
	BroadcasterID       string `json:"broadcaster_id"`
	BroadcasterName     string `json:"broadcaster_name"`
	BroadcasterLanguage string `json:"broadcaster_language"`
	GameID              string `json:"game_id"`
	GameName            string `json:"game_name"`
	Title               string `json:"title"`
	Delay               int    `json:"delay"`
}

type ChatBadge added in v1.18.0 

type ChatBadge struct {
	SetID    string         `json:"set_id"`
	Versions []BadgeVersion `json:"versions"`
}

type CheermoteTierImages added in v1.4.0 

type CheermoteTierImages struct {
	Dark  TierImageTypes `json:"dark"`
	Light TierImageTypes `json:"light"`
}

type CheermoteTiers added in v1.4.0 

type CheermoteTiers struct {
	MinBits        uint                `json:"min_bits"`
	ID             string              `json:"id"`
	Color          string              `json:"color"`
	Images         CheermoteTierImages `json:"images"`
	CanCheer       bool                `json:"can_cheer"`
	ShowInBitsCard bool                `json:"show_in_bits_card"`
}

type Cheermotes added in v1.4.0 

type Cheermotes struct {
	Prefix       string           `json:"prefix"`
	Tiers        []CheermoteTiers `json:"tiers"`
	Type         string           `json:"type"` // global_first_party, global_third_party, channel_custom, display_only, sponsored
	Order        uint             `json:"order"`
	LastUpdated  Time             `json:"last_updated"`
	IsCharitable bool             `json:"is_charitable"`
}

type CheermotesParams added in v1.4.0 

type CheermotesParams struct {
	BroadcasterID string `query:"broadcaster_id"` // optional
}

type CheermotesResponse added in v1.4.0 

type CheermotesResponse struct {
	ResponseCommon
	Data ManyCheermotes
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(options *Options) (*Client, error)

NewClient returns a new Twitch Helix API client. It returns an if clientID is an empty string. It is concurrency safe.

func (*Client) BlockUser added in v1.12.0 

func (c *Client) BlockUser(params *BlockUserParams) (*BlockUserResponse, error)

BlockUser : Blocks the specified user on behalf of the authenticated user.

Required scope: user:manage:blocked_users

func (*Client) CheckUserSubsription added in v1.10.0 

func (c *Client) CheckUserSubsription(params *UserSubscriptionsParams) (*UserSubscriptionResponse, error)

CheckUserSubsription Check if a specific user is subscribed to a specific channel

Required scope: user:read:subscriptions

func (*Client) CreateClip 

func (c *Client) CreateClip(params *CreateClipParams) (*CreateClipResponse, error)

CreateClip creates a clip programmatically. This returns both an ID and an edit URL for the new clip. Clip creation takes time. We recommend that you query Get Clip, with the clip ID that is returned here. If Get Clip returns a valid clip, your clip creation was successful. If, after 15 seconds, you still have not gotten back a valid clip from Get Clip, assume that the clip was not created and retry Create Clip.

Required scope: clips:edit

func (*Client) CreateCustomReward added in v1.17.0 

func (c *Client) CreateCustomReward(params *ChannelCustomRewardsParams) (*ChannelCustomRewardResponse, error)

CreateCustomReward : Creates a Custom Reward on a channel. Required scope: channel:manage:redemptions

func (*Client) CreateEntitlementsUploadURL 

func (c *Client) CreateEntitlementsUploadURL(manifestID, entitlementType string) (*EntitlementsUploadResponse, error)

CreateEntitlementsUploadURL return a URL where you can upload a manifest file and notify users that they have an entitlement. Entitlements are digital items that users are entitled to use. Twitch entitlements are granted to users gratis or as part of a purchase on Twitch.

func (*Client) CreateEventSubSubscription added in v1.7.0 

func (c *Client) CreateEventSubSubscription(payload *EventSubSubscription) (*EventSubSubscriptionsResponse, error)

Creates an EventSub subscription

func (*Client) CreateExtensionSecret added in v1.25.0 

func (c *Client) CreateExtensionSecret(params *ExtensionSecretCreationParams) (*ExtensionSecretCreationResponse, error)

func (*Client) CreatePoll added in v1.14.0 

func (c *Client) CreatePoll(params *CreatePollParams) (*PollsResponse, error)

Required scope: channel:manage:polls

func (*Client) CreatePrediction added in v1.15.0 

func (c *Client) CreatePrediction(params *CreatePredictionParams) (*PredictionsResponse, error)

Required scope: channel:manage:predictions

func (*Client) CreateStreamMarker added in v0.4.2 

func (c *Client) CreateStreamMarker(params *CreateStreamMarkerParams) (*CreateStreamMarkerResponse, error)

CreateStreamMarker creates a stream marker for a live stream at the current time. The user has to be the stream owner or an editor. Stream markers cannot be created in some cases, see: https://dev.twitch.tv/docs/api/reference/#create-stream-marker

Required Scope: user:edit:broadcast

func (*Client) DeleteCustomRewards added in v1.22.0 

func (c *Client) DeleteCustomRewards(params *DeleteCustomRewardsParams) (*DeleteCustomRewardsResponse, error)

DeleteCustomRewards : Deletes a Custom Rewards on a channel Required scope: channel:manage:redemptions

func (*Client) DeleteVideos added in v1.11.0 

func (c *Client) DeleteVideos(params *DeleteVideosParams) (*DeleteVideosResponse, error)

DeleteVideos delete one or more videos (max 5) Required scope: channel:manage:videos

func (*Client) EditChannelInformation added in v1.9.0 

func (c *Client) EditChannelInformation(params *EditChannelInformationParams) (*EditChannelInformationResponse, error)

func (*Client) EndPoll added in v1.14.0 

func (c *Client) EndPoll(params *EndPollParams) (*PollsResponse, error)

Required scope: channel:manage:polls

func (*Client) EndPrediction added in v1.15.0 

func (c *Client) EndPrediction(params *EndPredictionParams) (*PredictionsResponse, error)

Required scope: channel:manage:predictions

func (*Client) ExtensionCreateClaims added in v1.25.0 

func (c *Client) ExtensionCreateClaims(
	params *ExtensionCreateClaimsParams,
) (
	*TwitchJWTClaims,
	error,
)

CreateClaims will construct a claims suitable for generating a JWT token, containing necessary information required by the Twitch Helix Extension API endpoints.

func (*Client) ExtensionJWTSign added in v1.25.0 

func (c *Client) ExtensionJWTSign(claims *TwitchJWTClaims) (tokenString string, err error)

ExtensionJWTSign Sign the a JWT Claim to produce a base64 token.

func (*Client) ExtensionJWTVerify added in v1.25.0 

func (c *Client) ExtensionJWTVerify(token string) (claims *TwitchJWTClaims, err error)

ExtensionJWTVerify validates a extension client side twitch base64 token and converts it into a twitch claim type, containing relevant information.

func (*Client) FormBroadcastSendPubSubPermissions added in v1.25.0 

func (c *Client) FormBroadcastSendPubSubPermissions() *PubSubPermissions

FormBroadcastSendPubSubPermissions create the pubsub permissions for publishing a broadcast message type

func (*Client) FormGenericPubSubPermissions added in v1.25.0 

func (c *Client) FormGenericPubSubPermissions() *PubSubPermissions

FormGenericPubSubPermissions create the pubsub permissions for publishing to message for any target type

func (*Client) FormGlobalSendPubSubPermissions added in v1.25.0 

func (c *Client) FormGlobalSendPubSubPermissions() *PubSubPermissions

FormGlobalSendPubSubPermissions create the pubsub permissions for publishing a global targeted message

func (*Client) FormWhisperSendPubSubPermissions added in v1.25.0 

func (c *Client) FormWhisperSendPubSubPermissions(opaqueId string) *PubSubPermissions

FormWhisperSendPubSubPermissions create the pubsub permissions for publishing a whisper message type

func (*Client) GetAppAccessToken 

func (c *Client) GetAppAccessToken() string

GetAppAccessToken returns the current app access token.

func (*Client) GetAuthorizationURL 

func (c *Client) GetAuthorizationURL(params *AuthorizationURLParams) string

func (*Client) GetBannedUsers added in v0.5.5 

func (c *Client) GetBannedUsers(params *BannedUsersParams) (*BannedUsersResponse, error)

GetBannedUsers returns all banned and timed-out users in a channel.

Required scope: moderation:read

func (*Client) GetBitsLeaderboard 

func (c *Client) GetBitsLeaderboard(params *BitsLeaderboardParams) (*BitsLeaderboardResponse, error)

GetBitsLeaderboard gets a ranked list of Bits leaderboard information for an authorized broadcaster.

Required Scope: bits:read

func (*Client) GetChannelChatBadges added in v1.18.0 

func (c *Client) GetChannelChatBadges(params *GetChatBadgeParams) (*GetChatBadgeResponse, error)

func (*Client) GetChannelEditors added in v1.11.0 

func (c *Client) GetChannelEditors(params *ChannelEditorsParams) (*ChannelEditorsResponse, error)

GetChannelEditors Get a list of users who have editor permissions for a specific channel Required scope: channel:read:editors

func (*Client) GetChannelEmotes added in v1.20.0 

func (c *Client) GetChannelEmotes(params *GetChannelEmotesParams) (*GetChannelEmotesResponse, error)

func (*Client) GetChannelInformation added in v1.6.0 

func (c *Client) GetChannelInformation(params *GetChannelInformationParams) (*GetChannelInformationResponse, error)

func (*Client) GetCheermotes added in v1.4.0 

func (c *Client) GetCheermotes(params *CheermotesParams) (*CheermotesResponse, error)

func (*Client) GetClips 

func (c *Client) GetClips(params *ClipsParams) (*ClipsResponse, error)

GetClips returns information about a specified clip.

func (*Client) GetCustomRewards added in v1.22.0 

func (c *Client) GetCustomRewards(params *GetCustomRewardsParams) (*ChannelCustomRewardResponse, error)

GetCustomRewards : Get Custom Rewards on a channel Required scope: channel:read:redemptions

func (*Client) GetDropsEntitlements added in v1.0.1 

func (c *Client) GetDropsEntitlements(params *GetDropEntitlementsParams) (*GetDropsEntitlementsResponse, error)

GetDropsEntitlements returns a list of entitlements, which have been awarded to users by your organization. Filtering by UserID returns all of the entitlements related to that specific user. Filtering by GameID returns all of the entitlements related to that game. Filtering by GameID and UserID returns all of the entitlements related to that game and that user. Entitlements are digital items that users are entitled to use. Twitch entitlements are granted based on viewership engagement with a content creator, based on the game developers' campaign.

func (*Client) GetEmoteSets added in v1.20.0 

func (c *Client) GetEmoteSets(params *GetEmoteSetsParams) (*GetEmoteSetsResponse, error)

GetEmoteSets

func (*Client) GetEntitlementCodeStatus added in v1.2.0 

func (c *Client) GetEntitlementCodeStatus(params *CodesParams) (*CodeResponse, error)

GetEntitlementCodeStatus Per https://dev.twitch.tv/docs/api/reference#get-code-status Access is controlled via an app access token on the calling service. The client ID associated with the app access token must be approved by Twitch as part of a contracted arrangement. Callers with an app access token are authorized to redeem codes on behalf of any Twitch user account.

func (*Client) GetEventSubSubscriptions added in v1.7.0 

func (c *Client) GetEventSubSubscriptions(params *EventSubSubscriptionsParams) (*EventSubSubscriptionsResponse, error)

Get all EventSub Subscriptions

func (*Client) GetExtensionAnalytics added in v0.4.0 

func (c *Client) GetExtensionAnalytics(params *ExtensionAnalyticsParams) (*ExtensionAnalyticsResponse, error)

GetExtensionAnalytics returns a URL to the downloadable CSV file containing analytics data. Valid for 5 minutes.

func (*Client) GetExtensionConfigurationSegment added in v1.25.0 

func (c *Client) GetExtensionConfigurationSegment(params *ExtensionGetConfigurationParams) (*ExtensionGetConfigurationSegmentResponse, error)

func (*Client) GetExtensionSecrets added in v1.25.0 

func (c *Client) GetExtensionSecrets(params *GetExtensionSecretParams) (*GetExtensionSecretResponse, error)

func (*Client) GetExtensionSignedJWTToken added in v1.25.0 

func (c *Client) GetExtensionSignedJWTToken() string

GetAppAccessToken returns the current app access token.

func (*Client) GetExtensionTransactions added in v1.19.0 

func (c *Client) GetExtensionTransactions(params *ExtensionTransactionsParams) (*ExtensionTransactionsResponse, error)

GetExtensionTransactions allows extension back end servers to fetch a list of transactions that have occurred for their extension across all of Twitch. A transaction is a record of a user exchanging Bits for an in-Extension digital good.

See https://dev.twitch.tv/docs/api/reference/#get-extension-transactions

func (*Client) GetFollowedStream added in v1.13.0 

func (c *Client) GetFollowedStream(params *FollowedStreamsParams) (*StreamsResponse, error)

GetFollowedStream : Gets information about active streams belonging to channels that the authenticated user follows. Streams are returned sorted by number of current viewers, in descending order. Across multiple pages of results, there may be duplicate or missing streams, as viewers join and leave streams.

Required scope: user:read:follows

func (*Client) GetGameAnalytics 

func (c *Client) GetGameAnalytics(params *GameAnalyticsParams) (*GameAnalyticsResponse, error)

GetGameAnalytics returns a URL to the downloadable CSV file containing analytics data for the specified game. Valid for 5 minutes.

func (*Client) GetGames 

func (c *Client) GetGames(params *GamesParams) (*GamesResponse, error)

func (*Client) GetGlobalChatBadges added in v1.18.0 

func (c *Client) GetGlobalChatBadges() (*GetChatBadgeResponse, error)

func (*Client) GetGlobalEmotes added in v1.20.0 

func (c *Client) GetGlobalEmotes() (*GetChannelEmotesResponse, error)

func (*Client) GetHypeTrainEvents added in v1.24.3 

func (c *Client) GetHypeTrainEvents(params *HypeTrainEventsParams) (*HypeTrainEventsResponse, error)

Required scope: channel:read:hype_train

func (*Client) GetPolls added in v1.14.0 

func (c *Client) GetPolls(params *PollsParams) (*PollsResponse, error)

Required scope: channel:read:polls

func (*Client) GetPredictions added in v1.15.0 

func (c *Client) GetPredictions(params *PredictionsParams) (*PredictionsResponse, error)

Required scope: channel:read:predictions

func (*Client) GetStreamMarkers added in v0.4.1 

func (c *Client) GetStreamMarkers(params *StreamMarkersParams) (*StreamMarkersResponse, error)

GetStreamMarkers gets stream markers of a VOD or of the current live stream of an user being recorded as VOD.

Required Scope: user:read:broadcast

func (*Client) GetStreams 

func (c *Client) GetStreams(params *StreamsParams) (*StreamsResponse, error)

GetStreams returns a list of live channels based on the search parameters. To query offline channels, use SearchChannels.

func (*Client) GetSubscriptions added in v0.5.3 

func (c *Client) GetSubscriptions(params *SubscriptionsParams) (*SubscriptionsResponse, error)

GetSubscriptions gets subscriptions about one Twitch broadcaster. Broadcasters can only request their own subscriptions.

Required scope: channel:read:subscriptions

func (*Client) GetTopGames 

func (c *Client) GetTopGames(params *TopGamesParams) (*TopGamesResponse, error)

func (*Client) GetUserAccessToken 

func (c *Client) GetUserAccessToken() string

GetUserAccessToken returns the current user access token.

func (*Client) GetUserActiveExtensions added in v0.5.6 

func (c *Client) GetUserActiveExtensions(params *UserActiveExtensionsParams) (*UserActiveExtensionsResponse, error)

GetUserActiveExtensions Gets information about active extensions installed by a specified user, identified by a user ID or Bearer token.

Optional scope: user:read:broadcast or user:edit:broadcast

func (*Client) GetUserExtensions added in v0.5.6 

func (c *Client) GetUserExtensions() (*UserExtensionsResponse, error)

GetUserExtensions gets a list of all extensions (both active and inactive) for a specified user, identified by a Bearer token

Required scope: user:read:broadcast

func (*Client) GetUsers 

func (c *Client) GetUsers(params *UsersParams) (*UsersResponse, error)

GetUsers gets information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name. If neither a user ID nor a login name is specified, the user is looked up by Bearer token.

Optional scope: user:read:email

func (*Client) GetUsersBlocked added in v1.12.0 

func (c *Client) GetUsersBlocked(params *UsersBlockedParams) (*UsersBlockedResponse, error)

GetUsersBlocked : Gets a specified user’s block list.

Required scope: user:read:blocked_users

func (*Client) GetUsersFollows 

func (c *Client) GetUsersFollows(params *UsersFollowsParams) (*UsersFollowsResponse, error)

GetUsersFollows gets information on follow relationships between two Twitch users. Information returned is sorted in order, most recent follow first. This can return information like “who is lirik following,” “who is following lirik,” or “is user X following user Y.”

func (*Client) GetVideos 

func (c *Client) GetVideos(params *VideosParams) (*VideosResponse, error)

GetVideos gets video information by video ID (one or more), user ID (one only), or game ID (one only).

func (*Client) GetWebhookSubscriptions added in v0.3.1 

func (c *Client) GetWebhookSubscriptions(params *WebhookSubscriptionsParams) (*WebhookSubscriptionsResponse, error)

GetWebhookSubscriptions gets webhook subscriptions, in order of expiration. Requires an app access token.

func (*Client) ModerateHeldMessage added in v1.16.0 

func (c *Client) ModerateHeldMessage(params *HeldMessageModerationParams) (*HeldMessageModerationResponse, error)

Required scope: moderator:manage:automod

func (*Client) PostWebhookSubscription added in v0.4.2 

func (c *Client) PostWebhookSubscription(payload *WebhookSubscriptionPayload) (*WebhookSubscriptionResponse, error)

func (*Client) RedeemEntitlementCode added in v1.3.0 

func (c *Client) RedeemEntitlementCode(params *CodesParams) (*CodeResponse, error)

RedeemEntitlementCode Per https://dev.twitch.tv/docs/api/reference/#redeem-code Access is controlled via an app access token on the calling service. The client ID associated with the app access token must be approved by Twitch. Callers with an app access token are authorized to redeem codes on behalf of any Twitch user account.

func (*Client) RefreshUserAccessToken 

func (c *Client) RefreshUserAccessToken(refreshToken string) (*RefreshTokenResponse, error)

RefreshUserAccessToken submits a request to have the longevity of an access token extended. Twitch OAuth2 access tokens have expirations. Token-expiration periods vary in length. You should build your applications in such a way that they are resilient to token authentication failures.

func (*Client) RemoveEventSubSubscription added in v1.7.0 

func (c *Client) RemoveEventSubSubscription(id string) (*RemoveEventSubSubscriptionParamsResponse, error)

Remove an EventSub Subscription

func (*Client) RequestAppAccessToken added in v1.0.0 

func (c *Client) RequestAppAccessToken(scopes []string) (*AppAccessTokenResponse, error)

func (*Client) RequestUserAccessToken added in v1.0.0 

func (c *Client) RequestUserAccessToken(code string) (*UserAccessTokenResponse, error)

func (*Client) RevokeUserAccessToken 

func (c *Client) RevokeUserAccessToken(accessToken string) (*RevokeAccessTokenResponse, error)

RevokeUserAccessToken submits a request to Twitch to have an access token revoked.

Both successful requests and requests with bad tokens return 200 OK with no body. Requests with bad tokens return the same response, as there is no meaningful action a client can take after sending a bad token.

func (*Client) SearchChannels added in v0.6.0 

func (c *Client) SearchChannels(params *SearchChannelsParams) (*SearchChannelsResponse, error)

SearchChannels searches for Twitch channels based on the given search parameters. Unlike GetStreams, this can also return offline channels.

func (*Client) SendExtensionChatMessage added in v1.25.0 

func (c *Client) SendExtensionChatMessage(params *ExtensionSendChatMessageParams) (*ExtensionSendChatMessageResponse, error)

SendExtensionChatMessage Sends a specified chat message to a specified channel. The message will appear in the channel’s chat as a normal message, The author of the message is the Extension name.

see https://dev.twitch.tv/docs/api/reference#send-extension-chat-message

func (*Client) SendExtensionPubSubMessage added in v1.25.0 

func (c *Client) SendExtensionPubSubMessage(params *ExtensionSendPubSubMessageParams) (*ExtensionSendPubSubMessageResponse, error)

func (*Client) SetAppAccessToken 

func (c *Client) SetAppAccessToken(accessToken string)

func (*Client) SetExtensionRequiredConfiguration added in v1.25.0 

func (c *Client) SetExtensionRequiredConfiguration(params *ExtensionSetRequiredConfigurationParams) (*ExtensionSetRequiredConfigurationResponse, error)

func (*Client) SetExtensionSegmentConfig added in v1.25.0 

func (c *Client) SetExtensionSegmentConfig(params *ExtensionSetConfigurationParams) (*ExtensionSetConfigurationResponse, error)

https://dev.twitch.tv/docs/extensions/reference/#set-extension-configuration-segment

func (*Client) SetExtensionSignedJWTToken added in v1.25.0 

func (c *Client) SetExtensionSignedJWTToken(jwt string)

func (*Client) SetRedirectURI 

func (c *Client) SetRedirectURI(uri string)

func (*Client) SetUserAccessToken 

func (c *Client) SetUserAccessToken(accessToken string)

func (*Client) SetUserAgent 

func (c *Client) SetUserAgent(userAgent string)

func (*Client) StartCommercial added in v1.4.0 

func (c *Client) StartCommercial(params *StartCommercialParams) (*StartCommercialResponse, error)

StartCommercial starts a commercial on a specified channel OAuth Token required Requires channel:edit:commercial scope

func (*Client) UnblockUser added in v1.12.0 

func (c *Client) UnblockUser(params *UnblockUserParams) (*BlockUserResponse, error)

UnblockUser : Unblocks the specified user on behalf of the authenticated user.

Required scope: user:manage:blocked_users

func (*Client) UpdateUser 

func (c *Client) UpdateUser(params *UpdateUserParams) (*UsersResponse, error)

UpdateUser updates the description of a user specified by a Bearer token.

Required scope: user:edit

func (*Client) UpdateUserExtensions added in v0.5.7 

func (c *Client) UpdateUserExtensions(payload *UpdateUserExtensionsPayload) (*UserActiveExtensionsResponse, error)

UpdateUserExtensions Updates the activation state, extension ID, and/or version number of installed extensions for a specified user, identified by a Bearer token. If you try to activate a given extension under multiple extension types, the last write wins (and there is no guarantee of write order).

Required scope: user:edit:broadcast

func (*Client) ValidateToken added in v0.5.9 

func (c *Client) ValidateToken(accessToken string) (bool, *ValidateTokenResponse, error)

ValidateToken - Validate access token

type Clip 

type Clip struct {
	ID              string  `json:"id"`
	URL             string  `json:"url"`
	EmbedURL        string  `json:"embed_url"`
	BroadcasterID   string  `json:"broadcaster_id"`
	BroadcasterName string  `json:"broadcaster_name"`
	CreatorID       string  `json:"creator_id"`
	CreatorName     string  `json:"creator_name"`
	Duration        float64 `json:"duration"`
	VideoID         string  `json:"video_id"`
	GameID          string  `json:"game_id"`
	Language        string  `json:"language"`
	Title           string  `json:"title"`
	ViewCount       int     `json:"view_count"`
	CreatedAt       string  `json:"created_at"`
	ThumbnailURL    string  `json:"thumbnail_url"`
}

type ClipEditURL 

type ClipEditURL struct {
	ID      string `json:"id"`
	EditURL string `json:"edit_url"`
}

type ClipsParams 

type ClipsParams struct {
	// One of the below
	BroadcasterID string   `query:"broadcaster_id"`
	GameID        string   `query:"game_id"`
	IDs           []string `query:"id"` // Limit 100

	// Optional
	First     int    `query:"first,20"` // Maximum 100
	After     string `query:"after"`
	Before    string `query:"before"`
	StartedAt Time   `query:"started_at"`
	EndedAt   Time   `query:"ended_at"`
}

type ClipsResponse 

type ClipsResponse struct {
	ResponseCommon
	Data ManyClips
}

type CodeResponse added in v1.2.0 

type CodeResponse struct {
	ResponseCommon
	Data ManyCodes
}

type CodeStatus added in v1.2.0 

type CodeStatus struct {
	Code   string                `json:"code"`
	Status EntitlementCodeStatus `json:"status"`
}

type CodesParams added in v1.2.0 

type CodesParams struct {
	// One of the below
	UserID string   `query:"user_id"`
	Codes  []string `query:"code"` // Limit 20
}

type CreateClipParams added in v0.5.0 

type CreateClipParams struct {
	BroadcasterID string `query:"broadcaster_id"`

	// Optional
	HasDelay bool `query:"has_delay,false"`
}

type CreateClipResponse 

type CreateClipResponse struct {
	ResponseCommon
	Data ManyClipEditURLs
}

func (*CreateClipResponse) GetClipsCreationRateLimit 

func (ccr *CreateClipResponse) GetClipsCreationRateLimit() int

GetClipsCreationRateLimit returns the "Ratelimit-Helixclipscreation-Limit" header as an int.

func (*CreateClipResponse) GetClipsCreationRateLimitRemaining 

func (ccr *CreateClipResponse) GetClipsCreationRateLimitRemaining() int

GetClipsCreationRateLimitRemaining returns the "Ratelimit-Helixclipscreation-Remaining" header as an int.

type CreatePollParams added in v1.14.0 

type CreatePollParams struct {
	BroadcasterID              string            `json:"broadcaster_id"`
	Title                      string            `json:"title"`                         // Maximum: 60 characters.
	Choices                    []PollChoiceParam `json:"choices"`                       // Minimum: 2 choices. Maximum: 5 choices.
	Duration                   int               `json:"duration"`                      // Minimum: 15. Maximum: 1800.
	BitsVotingEnabled          bool              `json:"bits_voting_enabled"`           // Default: false
	BitsPerVote                int               `json:"bits_per_vote"`                 // Minimum: 0. Maximum: 10000.
	ChannelPointsVotingEnabled bool              `json:"channel_points_voting_enabled"` // Default: false
	ChannelPointsPerVote       int               `json:"channel_points_per_vote"`       // Minimum: 0. Maximum: 1000000.
}

type CreatePredictionParams added in v1.15.0 

type CreatePredictionParams struct {
	BroadcasterID    string                  `json:"broadcaster_id"`
	Title            string                  `json:"title"`             // Maximum: 45 characters.
	Outcomes         []PredictionChoiceParam `json:"outcomes"`          // 2 choices mandatory
	PredictionWindow int                     `json:"prediction_window"` // Minimum: 1. Maximum: 1800.
}

type CreateStreamMarker added in v0.4.2 

type CreateStreamMarker struct {
	ID              string `json:"id"`
	CreatedAt       Time   `json:"created_at"`
	Description     string `json:"description"`
	PositionSeconds int    `json:"position_seconds"`
}

type CreateStreamMarkerParams added in v0.4.2 

type CreateStreamMarkerParams struct {
	UserID string `query:"user_id"`

	// Optional
	Description string `query:"description"`
}

type CreateStreamMarkerResponse added in v0.4.2 

type CreateStreamMarkerResponse struct {
	ResponseCommon
	Data ManyCreateStreamMarkers
}

type DateRange added in v0.4.0 

type DateRange struct {
	StartedAt Time `json:"started_at"`
	EndedAt   Time `json:"ended_at"`
}

DateRange is a generic struct used by various responses.

type DeleteCustomRewardsParams added in v1.22.0 

type DeleteCustomRewardsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	ID            string `query:"id"`
}

type DeleteCustomRewardsResponse added in v1.22.0 

type DeleteCustomRewardsResponse struct {
	ResponseCommon
}

Response for removing a custom reward

type DeleteVideosParams added in v1.11.0 

type DeleteVideosParams struct {
	IDs []string `query:"id"` // Limit 5
}

type DeleteVideosResponse added in v1.11.0 

type DeleteVideosResponse struct {
	ResponseCommon
}

type EditChannelInformationParams added in v1.9.0 

type EditChannelInformationParams struct {
	BroadcasterID       string `query:"broadcaster_id" json:"-"`
	GameID              string `json:"game_id"`
	BroadcasterLanguage string `json:"broadcaster_language"`
	Title               string `json:"title"`
	Delay               int    `json:"delay,omitempty"`
}

type EditChannelInformationResponse added in v1.9.0 

type EditChannelInformationResponse struct {
	ResponseCommon
}

type Emote added in v1.20.0 

type Emote struct {
	ID         string     `json:"id"`
	Name       string     `json:"name"`
	Images     EmoteImage `json:"images"`
	Tier       string     `json:"tier"`
	EmoteType  string     `json:"emote_type"`
	EmoteSetId string     `json:"emote_set_id"`
}

type EmoteImage added in v1.20.0 

type EmoteImage struct {
	Url1x string `json:"url_1x"`
	Url2x string `json:"url_2x"`
	Url4x string `json:"url_4x"`
}

type EmoteWithOwner added in v1.21.0 

type EmoteWithOwner struct {
	Emote
	OwnerID string `json:"owner_id"`
}

type EndPollParams added in v1.14.0 

type EndPollParams struct {
	BroadcasterID string `json:"broadcaster_id"`
	ID            string `json:"id"`
	Status        string `json:"status"`
}

type EndPredictionParams added in v1.15.0 

type EndPredictionParams struct {
	BroadcasterID    string `json:"broadcaster_id"`
	ID               string `json:"id"`
	Status           string `json:"status"`
	WinningOutcomeID string `json:"winning_outcome_id"`
}

type Entitlement added in v1.0.1 

type Entitlement struct {
	ID        string `json:"id"`
	BenefitID string `json:"benefit_id"`
	Timestamp Time   `json:"timestamp"`
	UserID    string `json:"user_id"`
	GameID    string `json:"game_id"`
}

type EntitlementCodeStatus added in v1.2.0 

type EntitlementCodeStatus string

type EntitlementsUploadResponse 

type EntitlementsUploadResponse struct {
	ResponseCommon
	Data ManyEntitlementsUploadURLs
}

type EntitlementsUploadURL 

type EntitlementsUploadURL struct {
	URL string `json:"url"`
}

type EventSubBitVoting added in v1.14.0 

type EventSubBitVoting struct {
	IsEnabled     bool `json:"is_enabled"`
	AmountPerVote int  `json:"amount_per_vote"`
}

type EventSubChannelBanEvent added in v1.7.0 

type EventSubChannelBanEvent struct {
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	ModeratorUserID      string `json:"moderator_user_id"`
	ModeratorUserLogin   string `json:"moderator_user_login"`
	ModeratorUserName    string `json:"moderator_user_name"`
	Reason               string `json:"reason"`
	EndsAt               Time   `json:"ends_at"`
	IsPermanent          bool   `json:"is_permanent"`
}

Data for a channel ban notification

type EventSubChannelCheerEvent added in v1.7.0 

type EventSubChannelCheerEvent struct {
	IsAnonymous          bool   `json:"is_anonymous"`
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	Message              string `json:"message"`
	Bits                 int    `json:"bits"`
}

Data for a channel cheer notification

type EventSubChannelFollowEvent added in v1.7.0 

type EventSubChannelFollowEvent struct {
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
}

Data for a channel follow notification

type EventSubChannelPointsCustomRewardEvent added in v1.7.0 

type EventSubChannelPointsCustomRewardEvent struct {
	ID                                string                 `json:"id"`
	BroadcasterUserID                 string                 `json:"broadcaster_user_id"`
	BroadcasterUserLogin              string                 `json:"broadcaster_user_login"`
	BroadcasterUserName               string                 `json:"broadcaster_user_name"`
	IsEnabled                         bool                   `json:"is_enabled"`
	IsPaused                          bool                   `json:"is_paused"`
	IsInStock                         bool                   `json:"is_in_stock"`
	Title                             string                 `json:"title"`
	Cost                              int                    `json:"cost"`
	Prompt                            string                 `json:"prompt"`
	IsUserInputRequired               bool                   `json:"is_user_input_required"`
	ShouldRedemptionsSkipRequestQueue bool                   `json:"should_redemptions_skip_request_queue"`
	MaxPerStream                      EventSubMaxPerStream   `json:"max_per_stream"`
	MaxPerUserPerStream               EventSubMaxPerStream   `json:"max_per_user_per_stream"`
	BackgroundColor                   string                 `json:"background_color"`
	Image                             EventSubImage          `json:"image"`
	DefaultImage                      EventSubImage          `json:"default_image"`
	GlobalCooldown                    EventSubGlobalCooldown `json:"global_cooldown"`
	CooldownExpiresAt                 Time                   `json:"cooldown_expires_at"`
	RedemptionsRedeemedCurrentStream  int                    `json:"redemptions_redeemed_current_stream"`
}

Data for a channel points custom reward notification

type EventSubChannelPointsCustomRewardRedemptionEvent added in v1.7.0 

type EventSubChannelPointsCustomRewardRedemptionEvent struct {
	ID                   string         `json:"id"`
	BroadcasterUserID    string         `json:"broadcaster_user_id"`
	BroadcasterUserLogin string         `json:"broadcaster_user_login"`
	BroadcasterUserName  string         `json:"broadcaster_user_name"`
	UserID               string         `json:"user_id"`
	UserLogin            string         `json:"user_login"`
	UserName             string         `json:"user_name"`
	UserInput            string         `json:"user_input"`
	Status               string         `json:"status"`
	Reward               EventSubReward `json:"reward"`
	RedeemedAt           Time           `json:"redeemed_at"`
}

Data for a channel points custom reward redemption notification

type EventSubChannelPointsVoting added in v1.14.0 

type EventSubChannelPointsVoting = EventSubBitVoting

type EventSubChannelPollBeginEvent added in v1.14.0 

type EventSubChannelPollBeginEvent struct {
	ID                   string                      `json:"id"`
	BroadcasterUserID    string                      `json:"broadcaster_user_id"`
	BroadcasterUserLogin string                      `json:"broadcaster_user_login"`
	BroadcasterUserName  string                      `json:"broadcaster_user_name"`
	Title                string                      `json:"title"`
	Choices              []PollChoice                `json:"choices"`
	BitsVoting           EventSubBitVoting           `json:"bits_voting"`
	ChannelPointsVoting  EventSubChannelPointsVoting `json:"channel_points_voting"`
	StartedAt            Time                        `json:"started_at"`
	EndsAt               Time                        `json:"ends_at"`
}

Data for a channel poll begin event

type EventSubChannelPollEndEvent added in v1.14.0 

type EventSubChannelPollEndEvent struct {
	ID                   string                      `json:"id"`
	BroadcasterUserID    string                      `json:"broadcaster_user_id"`
	BroadcasterUserLogin string                      `json:"broadcaster_user_login"`
	BroadcasterUserName  string                      `json:"broadcaster_user_name"`
	Title                string                      `json:"title"`
	Choices              []PollChoice                `json:"choices"`
	BitsVoting           EventSubBitVoting           `json:"bits_voting"`
	ChannelPointsVoting  EventSubChannelPointsVoting `json:"channel_points_voting"`
	Status               string                      `json:"status"`
	StartedAt            Time                        `json:"started_at"`
	EndedAt              Time                        `json:"ended_at"`
}

Data for a channel poll end event

type EventSubChannelPollProgressEvent added in v1.14.0 

type EventSubChannelPollProgressEvent = EventSubChannelPollBeginEvent

Data for a channel poll progress event, it's the same as the channel poll begin event

type EventSubChannelPredictionBeginEvent added in v1.14.0 

type EventSubChannelPredictionBeginEvent struct {
	ID                   string            `json:"id"`
	BroadcasterUserID    string            `json:"broadcaster_user_id"`
	BroadcasterUserLogin string            `json:"broadcaster_user_login"`
	BroadcasterUserName  string            `json:"broadcaster_user_name"`
	Title                string            `json:"title"`
	Outcomes             []EventSubOutcome `json:"outcomes"`
	StartedAt            Time              `json:"started_at"`
	LockedAt             Time              `json:"locked_at"`
}

Data for a channel prediction begin event

type EventSubChannelPredictionEndEvent added in v1.14.0 

type EventSubChannelPredictionEndEvent struct {
	ID                   string            `json:"id"`
	BroadcasterUserID    string            `json:"broadcaster_user_id"`
	BroadcasterUserLogin string            `json:"broadcaster_user_login"`
	BroadcasterUserName  string            `json:"broadcaster_user_name"`
	Title                string            `json:"title"`
	WinningOutcomeID     string            `json:"winning_outcome_id"`
	Outcomes             []EventSubOutcome `json:"outcomes"`
	Status               string            `json:"status"`
	StartedAt            Time              `json:"started_at"`
	EndedAt              Time              `json:"eneded_at"`
}

Data for a channel prediction end event

type EventSubChannelPredictionLockEvent added in v1.14.0 

type EventSubChannelPredictionLockEvent struct {
	ID                   string            `json:"id"`
	BroadcasterUserID    string            `json:"broadcaster_user_id"`
	BroadcasterUserLogin string            `json:"broadcaster_user_login"`
	BroadcasterUserName  string            `json:"broadcaster_user_name"`
	Title                string            `json:"title"`
	WinningOutcomeID     string            `json:"winning_outcome_id"`
	Outcomes             []EventSubOutcome `json:"outcomes"`
	Status               string            `json:"status"`
	StartedAt            Time              `json:"started_at"`
	LockedAt             Time              `json:"locked_at"`
}

Data for a channel prediction lock event

type EventSubChannelPredictionProgressEvent added in v1.14.0 

type EventSubChannelPredictionProgressEvent = EventSubChannelPredictionBeginEvent

Data for a channel prediction progress event

type EventSubChannelRaidEvent added in v1.7.0 

type EventSubChannelRaidEvent struct {
	FromBroadcasterUserID    string `json:"from_broadcaster_user_id"`
	FromBroadcasterUserLogin string `json:"from_broadcaster_user_login"`
	FromBroadcasterUserName  string `json:"from_broadcaster_user_name"`
	ToBroadcasterUserID      string `json:"to_broadcaster_user_id"`
	ToBroadcasterUserLogin   string `json:"to_broadcaster_user_login"`
	ToBroadcasterUserName    string `json:"to_broadcaster_user_name"`
	Viewers                  int    `json:"viewers"`
}

Data for a channel raid notification

type EventSubChannelSubscribeEvent added in v1.7.0 

type EventSubChannelSubscribeEvent struct {
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	Tier                 string `json:"tier"`
	IsGift               bool   `json:"is_gift"`
}

Data for a channel subscribe notification

type EventSubChannelSubscriptionGiftEvent added in v1.18.0 

type EventSubChannelSubscriptionGiftEvent struct {
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	Total                int    `json:"total"`
	Tier                 string `json:"tier"`
	CumulativeTotal      int    `json:"cumulative_total"`
	IsAnonymous          bool   `json:"is_anonymous"`
}

EventSubChannelSubscriptionGiftEvent

type EventSubChannelSubscriptionMessageEvent added in v1.20.0 

type EventSubChannelSubscriptionMessageEvent struct {
	UserID               string          `json:"user_id"`
	UserLogin            string          `json:"user_login"`
	UserName             string          `json:"user_name"`
	BroadcasterUserID    string          `json:"broadcaster_user_id"`
	BroadcasterUserLogin string          `json:"broadcaster_user_login"`
	BroadcasterUserName  string          `json:"broadcaster_user_name"`
	Tier                 string          `json:"tier"`
	Message              EventSubMessage `json:"message"`
	CumulativeTotal      int             `json:"cumulative_total"`
	StreakMonths         int             `json:"streak_months"`
	DurationMonths       int             `json:"duration_months"`
}

EventSubChannelSubscriptionMessageEvent

type EventSubChannelUnbanEvent added in v1.7.0 

type EventSubChannelUnbanEvent struct {
	UserID               string `json:"user_id"`
	UserLogin            string `json:"user_login"`
	UserName             string `json:"user_name"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	ModeratorUserID      string `json:"moderator_user_id"`
	ModeratorUserLogin   string `json:"moderator_user_login"`
	ModeratorUserName    string `json:"moderator_user_name"`
}

Data for a channel unban notification

type EventSubChannelUpdateEvent added in v1.7.0 

type EventSubChannelUpdateEvent struct {
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	Title                string `json:"title"`
	Language             string `json:"language"`
	CategoryID           string `json:"category_id"`
	CategoryName         string `json:"category_name"`
	IsMature             bool   `json:"is_mature"`
}

Data for a channel update notification

type EventSubCondition added in v1.7.0 

type EventSubCondition struct {
	BroadcasterUserID     string `json:"broadcaster_user_id"`
	FromBroadcasterUserID string `json:"from_broadcaster_user_id"`
	ToBroadcasterUserID   string `json:"to_broadcaster_user_id"`
	RewardID              string `json:"reward_id"`
	ClientID              string `json:"client_id"`
	ExtensionClientID     string `json:"extension_client_id"`
	UserID                string `json:"user_id"`
}

Conditions for a subscription, not all are necessary and some only apply to some subscription types, see https://dev.twitch.tv/docs/eventsub/eventsub-reference

type EventSubContribution added in v1.7.0 

type EventSubContribution struct {
	UserID    string `json:"user_id"`
	UserLogin string `json:"user_login"`
	UserName  string `json:"user_name"`
	Type      string `json:"type"`
	Total     int64  `json:"total"`
}

This belongs to a hype train and defines a user contribution

type EventSubEmote added in v1.20.0 

type EventSubEmote struct {
	Begin int    `json:"begin"`
	End   int    `json:"end"`
	ID    string `json:"id"`
}

EventSubEmote

type EventSubExtensionBitsTransactionCreateEvent added in v1.17.0 

type EventSubExtensionBitsTransactionCreateEvent struct {
	ExtensionClientID    string          `json:"extension_client_id"`
	ID                   string          `json:"id"`
	BroadcasterUserID    string          `json:"broadcaster_user_id"`
	BroadcasterUserLogin string          `json:"broadcaster_user_login"`
	BroadcasterUserName  string          `json:"broadcaster_user_name"`
	UserID               string          `json:"user_id"`
	UserLogin            string          `json:"user_login"`
	UserName             string          `json:"user_name"`
	Product              EventSubProduct `json:"product"`
}

Data for an extension bits transaction creation

type EventSubGlobalCooldown added in v1.7.0 

type EventSubGlobalCooldown struct {
	IsEnabled bool `json:"is_enabled"`
	Seconds   int  `json:"seconds"`
}

This belongs to a custom reward and defines it's cooldown

type EventSubHypeTrainBeginEvent added in v1.7.0 

type EventSubHypeTrainBeginEvent struct {
	BroadcasterUserID    string                 `json:"broadcaster_user_id"`
	BroadcasterUserLogin string                 `json:"broadcaster_user_login"`
	BroadcasterUserName  string                 `json:"broadcaster_user_name"`
	Total                int                    `json:"total"`
	Progress             int                    `json:"progress"`
	Goal                 int                    `json:"goal"`
	TopContributions     []EventSubContribution `json:"top_contributions"`
	LastContribution     EventSubContribution   `json:"last_contribution"`
	StartedAt            Time                   `json:"started_at"`
	ExpiresAt            Time                   `json:"expires_at"`
}

Data for a hype train begin notification

type EventSubHypeTrainEndEvent added in v1.7.0 

type EventSubHypeTrainEndEvent struct {
	BroadcasterUserID    string                 `json:"broadcaster_user_id"`
	BroadcasterUserLogin string                 `json:"broadcaster_user_login"`
	BroadcasterUserName  string                 `json:"broadcaster_user_name"`
	Level                int                    `json:"level"`
	Total                int                    `json:"total"`
	TopContributions     []EventSubContribution `json:"top_contributions"`
	StartedAt            Time                   `json:"started_at"`
	ExpiresAt            Time                   `json:"expires_at"`
	CooldownEndsAt       Time                   `json:"cooldown_ends_at"`
}

Data for a hype train end notification

type EventSubHypeTrainProgressEvent added in v1.7.0 

type EventSubHypeTrainProgressEvent struct {
	BroadcasterUserID    string                 `json:"broadcaster_user_id"`
	BroadcasterUserLogin string                 `json:"broadcaster_user_login"`
	BroadcasterUserName  string                 `json:"broadcaster_user_name"`
	Level                int                    `json:"level"`
	Total                int                    `json:"total"`
	Progress             int                    `json:"progress"`
	Goal                 int                    `json:"goal"`
	TopContributions     []EventSubContribution `json:"top_contributions"`
	LastContribution     EventSubContribution   `json:"last_contribution"`
	StartedAt            Time                   `json:"started_at"`
	ExpiresAt            Time                   `json:"expires_at"`
}

Data for a hype train progress notification

type EventSubImage added in v1.7.0 

type EventSubImage struct {
	Url1x string `json:"url_1x"`
	Url2x string `json:"url_2x"`
	Url4x string `json:"url_4x"`
}

This also belongs to a custom reward and defines the image urls

type EventSubMaxPerStream added in v1.7.0 

type EventSubMaxPerStream struct {
	IsEnabled bool `json:"is_enabled"`
	Value     int  `json:"value"`
}

This belongs to a custom reward and defines if it is limited per stream

type EventSubMessage added in v1.20.0 

type EventSubMessage struct {
	Text   string          `json:"text"`
	Emotes []EventSubEmote `json:"emotes"`
}

EventSubMessage

type EventSubModeratorAddEvent added in v1.7.0 

type EventSubModeratorAddEvent = EventSubChannelFollowEvent

Data for a channel moderator add notification, it's the same as the channel follow notification

type EventSubModeratorRemoveEvent added in v1.7.0 

type EventSubModeratorRemoveEvent = EventSubChannelFollowEvent

Data for a channel moderator remove notification, it's the same as the channel follow notification

type EventSubOutcome added in v1.14.0 

type EventSubOutcome struct {
	ID            string                 `json:"id"`
	Title         string                 `json:"title"`
	Color         string                 `json:"color"`
	Users         int                    `json:"users"`
	ChannelPoints int                    `json:"channel_points"`
	TopPredictors []EventSubTopPredictor `json:"top_predictors"`
}

This belong to a channel prediction and defines the outcomes

type EventSubProduct added in v1.17.0 

type EventSubProduct struct {
	Name          string `json:"name"`
	Bits          int    `json:"bots"`
	Sku           string `json:"sku"`
	InDevelopment bool   `json:"in_development"`
}

type EventSubReward added in v1.7.0 

type EventSubReward struct {
	ID     string `json:"id"`
	Title  string `json:"title"`
	Cost   int    `json:"cost"`
	Prompt string `json:"prompt"`
}

This belongs to a reward redemption and defines the reward redeemed

type EventSubStreamOfflineEvent added in v1.7.0 

type EventSubStreamOfflineEvent struct {
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
}

Data for a stream offline notification

type EventSubStreamOnlineEvent added in v1.7.0 

type EventSubStreamOnlineEvent struct {
	ID                   string `json:"id"`
	BroadcasterUserID    string `json:"broadcaster_user_id"`
	BroadcasterUserLogin string `json:"broadcaster_user_login"`
	BroadcasterUserName  string `json:"broadcaster_user_name"`
	Type                 string `json:"type"`
	StartedAt            Time   `json:"started_at"`
}

Data for a stream online notification

type EventSubSubscription added in v1.7.0 

type EventSubSubscription struct {
	ID        string            `json:"id"`
	Type      string            `json:"type"`
	Version   string            `json:"version"`
	Status    string            `json:"status"`
	Condition EventSubCondition `json:"condition"`
	Transport EventSubTransport `json:"transport"`
	CreatedAt Time              `json:"created_at"`
	Cost      int               `json:"cost"`
}

Represents a subscription

type EventSubSubscriptionsParams added in v1.7.0 

type EventSubSubscriptionsParams struct {
	Status string `query:"status"`
	Type   string `query:"type"`
	After  string `query:"after"`
}

Parameter for filtering subscriptions, currently only the status is filterable

type EventSubSubscriptionsResponse added in v1.7.0 

type EventSubSubscriptionsResponse struct {
	ResponseCommon
	Data ManyEventSubSubscriptions
}

Response for getting all current subscriptions

type EventSubTopPredictor added in v1.14.0 

type EventSubTopPredictor struct {
	UserID            string `json:"user_id"`
	UserLogin         string `json:"user_login"`
	UserName          string `json:"user_name"`
	ChannelPointWon   string `json:"channel_points_won"`
	ChannelPointsUsed int    `json:"channel_points_used"`
}

This belong to an outcome and defines user reward

type EventSubTransport added in v1.7.0 

type EventSubTransport struct {
	Method   string `json:"method"`
	Callback string `json:"callback"`
	Secret   string `json:"secret"`
}

Transport for the subscription, currently the only supported Method is "webhook". Secret must be between 10 and 100 characters

type EventSubUserAuthenticationRevokeEvent added in v1.7.0 

type EventSubUserAuthenticationRevokeEvent struct {
	ClientID  string `json:"client_id"`
	UserID    string `json:"user_id"`
	UserLogin string `json:"user_login"`
	UserName  string `json:"user_name"`
}

Data for an user authentication revoke notification, this means the user has revoked the access token and if you need to comply with gdpr you need to delete your user data belonging to the user.

type EventSubUserUpdateEvent added in v1.7.0 

type EventSubUserUpdateEvent struct {
	UserID      string `json:"user_id"`
	UserLogin   string `json:"user_login"`
	UserName    string `json:"user_name"`
	Email       string `json:"email"`
	Description string `json:"description"`
}

Data for an user update notification

type ExtensionAnalytic added in v0.4.0 

type ExtensionAnalytic struct {
	ExtensionID string    `json:"extension_id"`
	URL         string    `json:"URL"`
	Type        string    `json:"type"`
	DateRange   DateRange `json:"date_range"`
}

type ExtensionAnalyticsParams added in v0.4.0 

type ExtensionAnalyticsParams struct {
	ExtensionID string `query:"extension_id"`
	First       int    `query:"first,20"`
	After       string `query:"after"`
	StartedAt   Time   `query:"started_at"`
	EndedAt     Time   `query:"ended_at"`
	Type        string `query:"type"`
}

type ExtensionAnalyticsResponse added in v0.4.0 

type ExtensionAnalyticsResponse struct {
	ResponseCommon
	Data ManyExtensionAnalytics
}

type ExtensionConfigurationSegment added in v1.25.0 

type ExtensionConfigurationSegment struct {
	Segment ExtensionSegmentType `json:"segment"`
	Version string               `json:"version"`
	Content string               `json:"content"`
}

type ExtensionCreateClaimsParams added in v1.25.0 

type ExtensionCreateClaimsParams struct {
	// ChannelID if this value is empty it will default to 'all'
	ChannelID string
	// PubSub is the pubsub permission to attach to the claim
	PubSub *PubSubPermissions
	// Expiration is the epoch of jwt expiration, default 3 minutes from time.Now
	Expiration int64
}

type ExtensionGetConfigurationParams added in v1.25.0 

type ExtensionGetConfigurationParams struct {
	ExtensionID   string                 `query:"extension_id"`
	BroadcasterID string                 `query:"broadcaster_id"`
	Segments      []ExtensionSegmentType `query:"segment"`
}

type ExtensionGetConfigurationSegmentResponse added in v1.25.0 

type ExtensionGetConfigurationSegmentResponse struct {
	ResponseCommon
	Data ManyExtensionConfigurationSegments
}

type ExtensionOptions added in v1.25.0 

type ExtensionOptions struct {
	OwnerUserID    string
	Secret         string
	SignedJWTToken string
}

type ExtensionPubSubPublishType added in v1.25.0 

type ExtensionPubSubPublishType string

PublishType The Pub/Sub broadcast type 

const (
	ExtensionPubSubGenericPublish   ExtensionPubSubPublishType = "*"
	ExtensionPubSubBroadcastPublish ExtensionPubSubPublishType = "broadcast"
	ExtensionPubSubGlobalPublish    ExtensionPubSubPublishType = "global"
)

Types of Pub/Sub Permissions or targets

func (ExtensionPubSubPublishType) String added in v1.25.0 

func (p ExtensionPubSubPublishType) String() string

type ExtensionSecretCreationParams added in v1.25.0 

type ExtensionSecretCreationParams struct {
	ActivationDelay int    `query:"delay,300"` // min 300
	ExtensionID     string `query:"extension_id"`
}

type ExtensionSecretCreationResponse added in v1.25.0 

type ExtensionSecretCreationResponse struct {
	Data ManyExtensionSecrets
	ResponseCommon
}

GetExtensionSecretResponse response structure received when generating or querying for generated secrets

type ExtensionSegmentType added in v1.25.0 

type ExtensionSegmentType string

SegmentType A segment configuration type 

const (
	ExtensionConfigrationBroadcasterSegment ExtensionSegmentType = "broadcaster"
	ExtensionConfigurationDeveloperSegment  ExtensionSegmentType = "developer"
	ExtensionConfigurationGlobalSegment     ExtensionSegmentType = "global"
)

Types of segments datastores for the configuration service

func (ExtensionSegmentType) String added in v1.25.0 

func (s ExtensionSegmentType) String() string

type ExtensionSendChatMessageParams added in v1.25.0 

type ExtensionSendChatMessageParams struct {
	BroadcasterID    string `query:"broadcaster_id" json:"-"`
	Text             string `json:"text"` // Limit 280
	ExtensionVersion string `json:"extension_version"`
	ExtensionID      string `json:"extension_id"`
}

type ExtensionSendChatMessageResponse added in v1.25.0 

type ExtensionSendChatMessageResponse struct {
	ResponseCommon
}

type ExtensionSendPubSubMessageParams added in v1.25.0 

type ExtensionSendPubSubMessageParams struct {
	BroadcasterID     string                       `json:"broadcaster_id"`
	Message           string                       `json:"message"`
	Target            []ExtensionPubSubPublishType `json:"target"`
	IsGlobalBroadcast bool                         `json:"is_global_broadcast"`
}

type ExtensionSendPubSubMessageResponse added in v1.25.0 

type ExtensionSendPubSubMessageResponse struct {
	ResponseCommon
}

type ExtensionSetConfigurationParams added in v1.25.0 

type ExtensionSetConfigurationParams struct {
	Segment     ExtensionSegmentType `json:"segment"`
	ExtensionID string               `json:"extension-id"`
	// BroadcasterID is only populated if segment is of type 'developer' || 'broadcaster'
	BroadcasterID string `json:"broadcaster_id,omitempty"`
	Version       string `json:"version"`
	Content       string `json:"content"`
}

type ExtensionSetConfigurationResponse added in v1.25.0 

type ExtensionSetConfigurationResponse struct {
	ResponseCommon
}

type ExtensionSetRequiredConfigurationParams added in v1.25.0 

type ExtensionSetRequiredConfigurationParams struct {
	BroadcasterID         string `query:"broadcaster_id" json:"-"`
	ExtensionID           string `json:"extension_id"`
	RequiredConfiguration string `json:"required_version"`
	ExtensionVersion      string `json:"extension_version"`
	ConfigurationVersion  string `json:"configuration_version"`
}

type ExtensionSetRequiredConfigurationResponse added in v1.25.0 

type ExtensionSetRequiredConfigurationResponse struct {
	ResponseCommon
}

type ExtensionTransaction added in v1.19.0 

type ExtensionTransaction struct {
	ID               string `json:"id"`
	Timestamp        Time   `json:"timestamp"`
	BroadcasterID    string `json:"broadcaster_id"`
	BroadcasterLogin string `json:"broadcaster_login"`
	BroadcasterName  string `json:"broadcaster_name"`
	UserID           string `json:"user_id"`
	UserLogin        string `json:"user_login"`
	UserName         string `json:"user_name"`
	ProductType      string `json:"product_type"`
	ProductData      struct {
		Domain     string `json:"domain"`
		Broadcast  bool   `json:"broadcast"`
		Expiration string `json:"expiration"`
		SKU        string `json:"sku"`
		Cost       struct {
			Amount int    `json:"amount"`
			Type   string `json:"type"`
		} `json:"cost"`
		DisplayName   string `json:"displayName"`
		InDevelopment bool   `json:"inDevelopment"`
	} `json:"product_data"`
}

type ExtensionTransactionsParams added in v1.19.0 

type ExtensionTransactionsParams struct {
	ExtensionID string   `query:"extension_id"` // Required
	ID          []string `query:"id"`           // Optional, Limit 100
	After       string   `query:"after"`        // Optional
	First       int      `query:"first,20"`     // Optional, Limit 100
}

type ExtensionTransactionsResponse added in v1.19.0 

type ExtensionTransactionsResponse struct {
	ResponseCommon
	Data ManyExtensionTransactions
}

type FollowedStreamsParams added in v1.13.0 

type FollowedStreamsParams struct {
	After  string `query:"after"`
	Before string `query:"before"`
	First  int    `query:"first,20"` // Limit 100
	UserID string `query:"user_id"`
}

type Game 

type Game struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	BoxArtURL string `json:"box_art_url"`
}

type GameAnalytic 

type GameAnalytic struct {
	GameID    string    `json:"game_id"`
	URL       string    `json:"URL"`
	Type      string    `json:"type"`
	DateRange DateRange `json:"date_range"`
}

type GameAnalyticsParams added in v0.4.0 

type GameAnalyticsParams struct {
	GameID    string `query:"game_id"`
	First     int    `query:"first,20"`
	After     string `query:"after"`
	StartedAt Time   `query:"started_at"`
	EndedAt   Time   `query:"ended_at"`
	Type      string `query:"type"`
}

type GameAnalyticsResponse 

type GameAnalyticsResponse struct {
	ResponseCommon
	Data ManyGameAnalytics
}

type GamesParams 

type GamesParams struct {
	IDs   []string `query:"id"`   // Limit 100
	Names []string `query:"name"` // Limit 100
}

type GamesResponse 

type GamesResponse struct {
	ResponseCommon
	Data ManyGames
}

type GetChannelEmotesParams added in v1.20.0 

type GetChannelEmotesParams struct {
	BroadcasterID string `query:"broadcaster_id"`
}

type GetChannelEmotesResponse added in v1.20.0 

type GetChannelEmotesResponse struct {
	ResponseCommon
	Data ManyEmotes
}

type GetChannelInformationParams added in v1.6.0 

type GetChannelInformationParams struct {
	// Deprecated: BroadcasterID will be removed in a future version. Use BroadcasterIDs instead.
	BroadcasterID  string   `query:"broadcaster_id"`
	BroadcasterIDs []string `query:"broadcaster_id"` // Limit 100
}

type GetChannelInformationResponse added in v1.6.0 

type GetChannelInformationResponse struct {
	ResponseCommon
	Data ManyChannelInformation
}

type GetChatBadgeParams added in v1.18.0 

type GetChatBadgeParams struct {
	BroadcasterID string `query:"broadcaster_id"`
}

type GetChatBadgeResponse added in v1.18.0 

type GetChatBadgeResponse struct {
	ResponseCommon
	Data ManyChatBadge
}

type GetCustomRewardsParams added in v1.22.0 

type GetCustomRewardsParams struct {
	BroadcasterID         string `query:"broadcaster_id"`
	ID                    string `query:"id"`
	OnlyManageableRewards bool   `query:"only_manageable_rewards"`
}

type GetDropEntitlementsParams added in v1.0.1 

type GetDropEntitlementsParams struct {
	ID     string `query:"id"`
	UserID string `query:"user_id"`
	GameID string `query:"game_id"`
	After  string `query:"after"`
	First  int    `query:"first,20"` // Limit 1000
}

type GetDropsEntitlementsResponse added in v1.0.1 

type GetDropsEntitlementsResponse struct {
	ResponseCommon
	Data ManyEntitlementsWithPagination
}

type GetEmoteSetsParams added in v1.20.0 

type GetEmoteSetsParams struct {
	EmoteSetIDs []string `query:"emote_set_id"` // Minimum: 1. Maximum: 25.
}

type GetEmoteSetsResponse added in v1.21.0 

type GetEmoteSetsResponse struct {
	ResponseCommon
	Data ManyEmotesWithOwner
}

type GetExtensionSecretParams added in v1.25.0 

type GetExtensionSecretParams struct {
	ExtensionID string `query:"extension_id"`
}

type GetExtensionSecretResponse added in v1.25.0 

type GetExtensionSecretResponse struct {
	Data ManyExtensionSecrets
	ResponseCommon
}

GetExtensionSecretResponse response structure received when fetching secrets for an extension

type GetPollsResponse added in v1.14.0 

type GetPollsResponse struct {
	ResponseCommon
	Data ManyPolls
}

type GetPredictionsResponse added in v1.15.0 

type GetPredictionsResponse struct {
	ResponseCommon
	Data ManyPredictions
}

type GlobalCooldownSettings added in v1.17.0 

type GlobalCooldownSettings struct {
	IsEnabled             bool `json:"is_enabled"`
	GlobalCooldownSeconds int  `json:"global_cooldown_seconds"`
}

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type HeldMessageModerationParams added in v1.16.0 

type HeldMessageModerationParams struct {
	UserID string `query:"user_id"`
	MsgID  string `query:"msg_id"`
	Action string `query:"action"` // Must be "ALLOW" or "DENY".
}

type HeldMessageModerationResponse added in v1.16.0 

type HeldMessageModerationResponse struct {
	ResponseCommon
}

type HypeTrainContribuition added in v1.24.3 

type HypeTrainContribuition struct {
	Total int64  `json:"total"`
	Type  string `json:"type"`
	User  string `json:"user"`
}

type HypeTrainEvent added in v1.24.3 

type HypeTrainEvent struct {
	ID             string             `json:"id"`
	EventType      string             `json:"event_type"`
	EventTimestamp Time               `json:"event_timestamp"`
	Version        string             `json:"version"`
	Event          HypeTrainEventData `json:"event_data"`
}

type HypeTrainEventData added in v1.24.3 

type HypeTrainEventData struct {
	ID               string                   `json:"id"`
	BroadcasterID    string                   `json:"broadcaster_id"`
	CooldownEndTime  Time                     `json:"cooldown_end_time"`
	ExpiresAt        Time                     `json:"expires_at"`
	Goal             int64                    `json:"goal"`
	LastContribution HypeTrainContribuition   `json:"last_contribution"`
	Level            int64                    `json:"level"`
	StartedAt        Time                     `json:"started_at"`
	TopContributions []HypeTrainContribuition `json:"top_contributions"`
	Total            int64                    `json:"total"`
}

type HypeTrainEventsParams added in v1.24.3 

type HypeTrainEventsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	After         string `query:"after"`
	First         int    `query:"first,20"` // Limit 100
	ID            string `query:"id"`
}

type HypeTrainEventsResponse added in v1.24.3 

type HypeTrainEventsResponse struct {
	ResponseCommon
	Data ManyHypeTrainEvents
}

type ManyAdDetails added in v1.4.0 

type ManyAdDetails struct {
	AdDetails []AdDetails `json:"data"`
}

type ManyBans added in v0.5.5 

type ManyBans struct {
	Bans       []Ban      `json:"data"`
	Pagination Pagination `json:"pagination"`
}

type ManyChannelCustomRewards added in v1.17.0 

type ManyChannelCustomRewards struct {
	ChannelCustomRewards []ChannelCustomReward `json:"data"`
}

type ManyChannelEditors added in v1.11.0 

type ManyChannelEditors struct {
	ChannelEditors []ChannelEditor `json:"data"`
}

type ManyChannelInformation added in v1.6.0 

type ManyChannelInformation struct {
	Channels []ChannelInformation `json:"data"`
}

type ManyChatBadge added in v1.18.0 

type ManyChatBadge struct {
	Badges []ChatBadge `json:"data"`
}

type ManyCheermotes added in v1.4.0 

type ManyCheermotes struct {
	Cheermotes []Cheermotes `json:"data"`
}

type ManyClipEditURLs 

type ManyClipEditURLs struct {
	ClipEditURLs []ClipEditURL `json:"data"`
}

type ManyClips 

type ManyClips struct {
	Clips      []Clip     `json:"data"`
	Pagination Pagination `json:"pagination"`
}

type ManyCodes added in v1.2.0 

type ManyCodes struct {
	Codes []CodeStatus `json:"data"`
}

type ManyCreateStreamMarkers added in v0.4.2 

type ManyCreateStreamMarkers struct {
	CreateStreamMarkers []CreateStreamMarker `json:"data"`
}

type ManyEmotes added in v1.20.0 

type ManyEmotes struct {
	Emotes []Emote `json:"data"`
}

type ManyEmotesWithOwner added in v1.21.0 

type ManyEmotesWithOwner struct {
	Emotes []EmoteWithOwner `json:"data"`
}

type ManyEntitlements added in v1.0.1 

type ManyEntitlements struct {
	Entitlements []Entitlement `json:"data"`
}

type ManyEntitlementsUploadURLs 

type ManyEntitlementsUploadURLs struct {
	URLs []EntitlementsUploadURL `json:"data"`
}

type ManyEntitlementsWithPagination added in v1.0.1 

type ManyEntitlementsWithPagination struct {
	ManyEntitlements
	Pagination `json:"pagination"`
}

type ManyEventSubSubscriptions added in v1.7.0 

type ManyEventSubSubscriptions struct {
	TotalCost             int                    `json:"total_cost"`
	MaxTotalCost          int                    `json:"max_total_cost"`
	EventSubSubscriptions []EventSubSubscription `json:"data"`
	Pagination            Pagination             `json:"pagination"`
}

Twitch Response for getting all current subscriptions

type ManyExtensionAnalytics added in v0.4.0 

type ManyExtensionAnalytics struct {
	ExtensionAnalytics []ExtensionAnalytic `json:"data"`
	Pagination         Pagination          `json:"pagination"`
}

type ManyExtensionConfigurationSegments added in v1.25.0 

type ManyExtensionConfigurationSegments struct {
	Segments []ExtensionConfigurationSegment `json:"data"`
}

type ManyExtensionSecrets added in v1.25.0 

type ManyExtensionSecrets struct {
	SecretInfo []SecretsInformation `json:"data"`
}

type ManyExtensionTransactions added in v1.19.0 

type ManyExtensionTransactions struct {
	ExtensionTransactions []ExtensionTransaction `json:"data"`
	Pagination            Pagination             `json:"pagination"`
}

type ManyFollows 

type ManyFollows struct {
	Total      int          `json:"total"`
	Follows    []UserFollow `json:"data"`
	Pagination Pagination   `json:"pagination"`
}

type ManyGameAnalytics 

type ManyGameAnalytics struct {
	GameAnalytics []GameAnalytic `json:"data"`
	Pagination    Pagination     `json:"pagination"`
}

type ManyGames 

type ManyGames struct {
	Games []Game `json:"data"`
}

type ManyGamesWithPagination 

type ManyGamesWithPagination struct {
	ManyGames
	Pagination Pagination `json:"pagination"`
}

type ManyHypeTrainEvents added in v1.24.3 

type ManyHypeTrainEvents struct {
	Events     []HypeTrainEvent `json:"data"`
	Pagination Pagination       `json:"pagination"`
}

type ManyPolls added in v1.14.0 

type ManyPolls struct {
	Polls      []Poll     `json:"data"`
	Pagination Pagination `json:"pagination"`
}

type ManyPredictions added in v1.15.0 

type ManyPredictions struct {
	Predictions []Prediction `json:"data"`
	Pagination  Pagination   `json:"pagination"`
}

type ManySearchChannels added in v0.6.0 

type ManySearchChannels struct {
	Channels   []Channel  `json:"data"`
	Pagination Pagination `json:"pagination"`
}

ManySearchChannels is the response data from SearchChannels

type ManyStreamMarkers added in v0.4.1 

type ManyStreamMarkers struct {
	StreamMarkers []StreamMarker `json:"data"`
	Pagination    Pagination     `json:"pagination"`
}

type ManyStreams 

type ManyStreams struct {
	Streams    []Stream   `json:"data"`
	Pagination Pagination `json:"pagination"`
}

type ManySubscriptions added in v0.5.3 

type ManySubscriptions struct {
	Subscriptions []Subscription `json:"data"`
	Pagination    Pagination     `json:"pagination"`
	Total         int            `json:"total"`
}

type ManyUserBitTotals 

type ManyUserBitTotals struct {
	Total         int            `json:"total"`
	DateRange     DateRange      `json:"date_range"`
	UserBitTotals []UserBitTotal `json:"data"`
}

type ManyUserExtensions added in v0.5.6 

type ManyUserExtensions struct {
	UserExtensions []UserExtension `json:"data"`
}

type ManyUserSubscriptions added in v1.10.0 

type ManyUserSubscriptions struct {
	UserSubscriptions []UserSubscription `json:"data"`
}

type ManyUsers 

type ManyUsers struct {
	Users []User `json:"data"`
}

type ManyUsersBlocked added in v1.12.0 

type ManyUsersBlocked struct {
	Users      []UserBlocked `json:"data"`
	Pagination Pagination    `json:"pagination"`
}

type ManyVideos 

type ManyVideos struct {
	Videos     []Video    `json:"data"`
	Pagination Pagination `json:"pagination"`
}

type ManyWebhookSubscriptions added in v0.3.1 

type ManyWebhookSubscriptions struct {
	Total                int                   `json:"total"`
	WebhookSubscriptions []WebhookSubscription `json:"data"`
	Pagination           Pagination            `json:"pagination"`
}

type Marker added in v0.4.1 

type Marker struct {
	ID              string `json:"id"`
	CreatedAt       Time   `json:"created_at"`
	Description     string `json:"description"`
	PositionSeconds int    `json:"position_seconds"`
	URL             string `json:"URL"`
}

type MaxPerStreamSettings added in v1.17.0 

type MaxPerStreamSettings struct {
	IsEnabled    bool `json:"is_enabled"`
	MaxPerStream int  `json:"max_per_stream"`
}

type MaxPerUserPerStreamSettings added in v1.17.0 

type MaxPerUserPerStreamSettings struct {
	IsEnabled           bool `json:"is_enabled"`
	MaxPerUserPerStream int  `json:"max_per_user_per_stream"`
}

type Options 

type Options struct {
	ClientID        string
	ClientSecret    string
	AppAccessToken  string
	UserAccessToken string
	UserAgent       string
	RedirectURI     string
	HTTPClient      HTTPClient
	RateLimitFunc   RateLimitFunc
	APIBaseURL      string
	ExtensionOpts   ExtensionOptions
}

type Outcomes added in v1.15.0 

type Outcomes struct {
	ID            string         `json:"id"`
	Title         string         `json:"title"`
	Users         int            `json:"users"`
	ChannelPoints int            `json:"channel_points"`
	TopPredictors []TopPredictor `json:"top_predictors"`
	Color         string         `json:"color"`
}

type Pagination 

type Pagination struct {
	Cursor string `json:"cursor"`
}

type Poll added in v1.14.0 

type Poll struct {
	ID                         string       `json:"id"`
	BroadcasterID              string       `json:"broadcaster_id"`
	BroadcasterLogin           string       `json:"broadcaster_login"`
	BroadcasterName            string       `json:"broadcaster_name"`
	Title                      string       `json:"title"`
	Choices                    []PollChoice `json:"choices"`
	BitsVotingEnabled          bool         `json:"bits_voting_enabled"`
	BitsPerVote                int          `json:"bits_per_vote"`
	ChannelPointsVotingEnabled bool         `json:"channel_points_voting_enabled"`
	ChannelPointsPerVote       int          `json:"channel_points_per_vote"`
	Status                     string       `json:"status"`
	Duration                   int          `json:"duration"`
	StartedAt                  Time         `json:"started_at"`
	EndedAt                    Time         `json:"ended_at"`
}

type PollChoice added in v1.15.0 

type PollChoice struct {
	ID                 string `json:"id"`
	Title              string `json:"title"`
	BitsVotes          int    `json:"bits_votes"`
	ChannelPointsVotes int    `json:"channel_points_votes"`
	Votes              int    `json:"votes"`
}

type PollChoiceParam added in v1.15.0 

type PollChoiceParam struct {
	Title string `json:"title"` // Maximum: 25 characters.
}

type PollsParams added in v1.14.0 

type PollsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	ID            string `query:"id"`
	After         string `query:"after"`
	First         string `query:"first"`
}

type PollsResponse added in v1.14.0 

type PollsResponse struct {
	ResponseCommon
	Data ManyPolls
}

type Prediction added in v1.15.0 

type Prediction struct {
	ID                   string     `json:"id"`
	BroadcasterUserID    string     `json:"broadcaster_id"`
	BroadcasterUserLogin string     `json:"broadcaster_login"`
	BroadcasterUserName  string     `json:"broadcaster_name"`
	Title                string     `json:"title"`
	WinningOutcomeID     string     `json:"winning_outcome_id"`
	Outcomes             []Outcomes `json:"outcomes"`
	PredictionWindow     int        `json:"prediction_window"`
	Status               string     `json:"status"`
	CreatedAt            Time       `json:"created_at"`
	EndedAt              Time       `json:"ended_at"`
	LockedAt             Time       `json:"locked_at"`
}

Prediction ... same struct as Poll

type PredictionChoiceParam added in v1.15.0 

type PredictionChoiceParam struct {
	Title string `json:"title"` // Maximum: 25 characters.
}

type PredictionsParams added in v1.15.0 

type PredictionsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	ID            string `query:"id"`
	After         string `query:"after"`
	First         string `query:"first"`
}

type PredictionsResponse added in v1.15.0 

type PredictionsResponse struct {
	ResponseCommon
	Data ManyPredictions
}

type PubSubPermissions added in v1.25.0 

type PubSubPermissions struct {
	Send   []ExtensionPubSubPublishType `json:"send,omitempty"`
	Listen []ExtensionPubSubPublishType `json:"listen,omitempty"`
}

PubSubPermissions publish permissions used within JWT claims

type RateLimitFunc 

type RateLimitFunc func(*Response) error

type RefreshTokenResponse 

type RefreshTokenResponse struct {
	ResponseCommon
	Data AccessCredentials
}

type RemoveEventSubSubscriptionParams added in v1.7.0 

type RemoveEventSubSubscriptionParams struct {
	ID string `query:"id"`
}

Parameter for removing a subscription.

type RemoveEventSubSubscriptionParamsResponse added in v1.7.0 

type RemoveEventSubSubscriptionParamsResponse struct {
	ResponseCommon
}

Response for removing a subscription

type Response 

type Response struct {
	ResponseCommon
	Data interface{}
}

func (*Response) HydrateResponseCommon added in v0.5.7 

func (r *Response) HydrateResponseCommon(rc *ResponseCommon)

HydrateResponseCommon copies the content of the source response's ResponseCommon to the supplied ResponseCommon argument

type ResponseCommon 

type ResponseCommon struct {
	StatusCode   int
	Header       http.Header
	Error        string `json:"error"`
	ErrorStatus  int    `json:"status"`
	ErrorMessage string `json:"message"`
}

func (*ResponseCommon) GetRateLimit 

func (rc *ResponseCommon) GetRateLimit() int

GetRateLimit returns the "RateLimit-Limit" header as an int.

func (*ResponseCommon) GetRateLimitRemaining 

func (rc *ResponseCommon) GetRateLimitRemaining() int

GetRateLimitRemaining returns the "RateLimit-Remaining" header as an int.

func (*ResponseCommon) GetRateLimitReset 

func (rc *ResponseCommon) GetRateLimitReset() int

GetRateLimitReset returns the "RateLimit-Reset" header as an int.

type RevokeAccessTokenResponse 

type RevokeAccessTokenResponse struct {
	ResponseCommon
}

type RewardImage added in v1.17.0 

type RewardImage struct {
	Url1x string `json:"url_1x"`
	Url2x string `json:"url_2x"`
	Url4x string `json:"url_4x"`
}

type RoleType added in v1.25.0 

type RoleType string

RoleType The user role type 

const (
	BroadcasterRole RoleType = "broadcaster"
	ExternalRole    RoleType = "external"
	ModeratorRole   RoleType = "moderator"
	ViewerRole      RoleType = "viewer"
)

Types of user roles used within the JWT Claims

type SearchChannelsParams added in v0.6.0 

type SearchChannelsParams struct {
	Channel  string `query:"query"`
	After    string `query:"after"`
	First    int    `query:"first,20"` // Limit 100
	LiveOnly bool   `query:"live_only"`
}

SearchChannelsParams is parameters for SearchChannels

type SearchChannelsResponse added in v0.6.0 

type SearchChannelsResponse struct {
	ResponseCommon
	Data ManySearchChannels
}

SearchChannelsResponse is the response from SearchChannels

type Secret added in v1.25.0 

type Secret struct {
	ActiveAt Time   `json:"active_at"`
	Content  string `json:"content"`
	Expires  Time   `json:"expires_at"`
}

Secret information about a generated secret

type SecretsInformation added in v1.25.0 

type SecretsInformation struct {
	Version int      `json:"format_version"`
	Secrets []Secret `json:"secrets"`
}

type StartCommercialParams added in v1.4.0 

type StartCommercialParams struct {
	BroadcasterID string       `query:"broadcaster_id"`
	Length        AdLengthEnum `query:"length"`
}

type StartCommercialResponse added in v1.4.0 

type StartCommercialResponse struct {
	ResponseCommon
	Data ManyAdDetails
}

type Stream 

type Stream struct {
	ID           string    `json:"id"`
	UserID       string    `json:"user_id"`
	UserLogin    string    `json:"user_login"`
	UserName     string    `json:"user_name"`
	GameID       string    `json:"game_id"`
	GameName     string    `json:"game_name"`
	TagIDs       []string  `json:"tag_ids"`
	IsMature     bool      `json:"is_mature"`
	Type         string    `json:"type"`
	Title        string    `json:"title"`
	ViewerCount  int       `json:"viewer_count"`
	StartedAt    time.Time `json:"started_at"`
	Language     string    `json:"language"`
	ThumbnailURL string    `json:"thumbnail_url"`
}

type StreamMarker added in v0.4.1 

type StreamMarker struct {
	UserID    string        `json:"user_id"`
	UserName  string        `json:"user_name"`
	UserLogin string        `json:"user_login"`
	Videos    []VideoMarker `json:"videos"`
}

type StreamMarkersParams added in v0.4.1 

type StreamMarkersParams struct {
	UserID  string `query:"user_id"`
	VideoID string `query:"video_id"`

	// Optional
	After  string `query:"after"`
	Before string `query:"before"`
	First  int    `query:"first,20"` // Limit 100
}

StreamMarkersParams requires _either_ UserID or VideoID set

UserID: fetches stream markers of the current livestream of the given user (VOD recording must be enabled). VideoID: fetches streams markers of the VOD.

type StreamMarkersResponse added in v0.4.1 

type StreamMarkersResponse struct {
	ResponseCommon
	Data ManyStreamMarkers
}

type StreamsParams 

type StreamsParams struct {
	After      string   `query:"after"`
	Before     string   `query:"before"`
	First      int      `query:"first,20"`   // Limit 100
	GameIDs    []string `query:"game_id"`    // Limit 100
	Language   []string `query:"language"`   // Limit 100
	Type       string   `query:"type,all"`   // "all" (default), "live" and "vodcast"
	UserIDs    []string `query:"user_id"`    // limit 100
	UserLogins []string `query:"user_login"` // limit 100
}

type StreamsResponse 

type StreamsResponse struct {
	ResponseCommon
	Data ManyStreams
}

type Subscription added in v0.5.3 

type Subscription struct {
	BroadcasterID    string `json:"broadcaster_id"`
	BroadcasterLogin string `json:"broadcaster_login"`
	BroadcasterName  string `json:"broadcaster_name"`
	IsGift           bool   `json:"is_gift"`
	GifterID         string `json:"gifter_id"`
	GifterLogin      string `json:"gifter_login"`
	GifterName       string `json:"gifter_name"`
	Tier             string `json:"tier"`
	PlanName         string `json:"plan_name"`
	UserID           string `json:"user_id"`
	UserName         string `json:"user_name"`
	UserLogin        string `json:"user_login"`
}

type SubscriptionsParams added in v0.5.3 

type SubscriptionsParams struct {
	BroadcasterID string   `query:"broadcaster_id"` // Limit 1
	UserID        []string `query:"user_id"`        // Limit 100
	After         string   `query:"after"`
	Before        string   `query:"before"`
	First         int      `query:"first,20"` // Limit 100
}

type SubscriptionsResponse added in v0.5.3 

type SubscriptionsResponse struct {
	ResponseCommon
	Data ManySubscriptions
}

type TierImageTypes added in v1.4.0 

type TierImageTypes struct {
	Animated TierImages `json:"animated"`
	Static   TierImages `json:"static"`
}

type TierImages added in v1.4.0 

type TierImages struct {
	Image1   string `json:"1"`
	Image1_5 string `json:"1.5"`
	Image2   string `json:"2"`
	Image3   string `json:"3"`
	Image4   string `json:"4"`
}

type Time 

type Time struct {
	time.Time
}

Time is our custom time struct.

func (*Time) UnmarshalJSON 

func (t *Time) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON is our custom datetime unmarshaller. Twitch sometimes returns datetimes as empty strings, which casuses issues with the native time UnmarshalJSON method when decoding the JSON string. Here we handle that scenario, by returning a zero time value for any JSON time field that is either an empty string or "null".

type TopGamesParams 

type TopGamesParams struct {
	After  string `query:"after"`
	Before string `query:"before"`
	First  int    `query:"first,20"` // Limit 100
}

type TopGamesResponse 

type TopGamesResponse struct {
	ResponseCommon
	Data ManyGamesWithPagination
}

type TopPredictor added in v1.15.0 

type TopPredictor struct {
	UserID            string `json:"user_id"`
	UserName          string `json:"user_name"`
	UserLogin         string `json:"user_login"`
	ChannelPointsUsed int    `json:"channel_points_used"`
	ChannelPointsWon  int    `json:"channel_points_won"`
}

type TwitchJWTClaims added in v1.25.0 

type TwitchJWTClaims struct {
	OpaqueUserID string             `json:"opaque_user_id,omitempty"`
	UserID       string             `json:"user_id"`
	ChannelID    string             `json:"channel_id,omitempty"`
	Role         RoleType           `json:"role"`
	Unlinked     bool               `json:"is_unlinked,omitempty"`
	Permissions  *PubSubPermissions `json:"pubsub_perms"`
	jwt.StandardClaims
}

TwitchJWTClaims contains information containing twitch specific JWT information.

type UnblockUserParams added in v1.12.0 

type UnblockUserParams struct {
	TargetUserID string `query:"target_user_id"`
}

type UpdateUserExtensionsPayload added in v0.5.7 

type UpdateUserExtensionsPayload struct {
	Component map[string]UserActiveExtensionInfo `json:"component,omitempty"`
	Overlay   map[string]UserActiveExtensionInfo `json:"overlay,omitempty"`
	Panel     map[string]UserActiveExtensionInfo `json:"panel,omitempty"`
}

type UpdateUserParams added in v0.5.0 

type UpdateUserParams struct {
	Description string `query:"description"`
}

type User 

type User struct {
	ID              string `json:"id"`
	Login           string `json:"login"`
	DisplayName     string `json:"display_name"`
	Type            string `json:"type"`
	BroadcasterType string `json:"broadcaster_type"`
	Description     string `json:"description"`
	ProfileImageURL string `json:"profile_image_url"`
	OfflineImageURL string `json:"offline_image_url"`
	ViewCount       int    `json:"view_count"`
	Email           string `json:"email"`
	CreatedAt       Time   `json:"created_at"`
}

type UserAccessTokenResponse 

type UserAccessTokenResponse struct {
	ResponseCommon
	Data AccessCredentials
}

type UserActiveExtension added in v0.5.6 

type UserActiveExtension struct {
	Component map[string]UserActiveExtensionInfo `json:"component"`
	Overlay   map[string]UserActiveExtensionInfo `json:"overlay"`
	Panel     map[string]UserActiveExtensionInfo `json:"panel"`
}

type UserActiveExtensionInfo added in v0.5.6 

type UserActiveExtensionInfo struct {
	Active  bool   `json:"active"`
	ID      string `json:"id"`
	Name    string `json:"name"`
	Version string `json:"version"`
	X       int    `json:"x"`
	Y       int    `json:"y"`
}

type UserActiveExtensionSet added in v0.5.6 

type UserActiveExtensionSet struct {
	UserActiveExtensions UserActiveExtension `json:"data"`
}

type UserActiveExtensionsParams added in v0.5.6 

type UserActiveExtensionsParams struct {
	UserID string `query:"user_id"` // Optional, limit 1
}

type UserActiveExtensionsResponse added in v0.5.6 

type UserActiveExtensionsResponse struct {
	ResponseCommon
	Data UserActiveExtensionSet
}

type UserBitTotal 

type UserBitTotal struct {
	UserID    string `json:"user_id"`
	UserLogin string `json:"user_login"`
	UserName  string `json:"user_name"`
	Rank      int    `json:"rank"`
	Score     int    `json:"score"`
}

type UserBlocked added in v1.12.0 

type UserBlocked struct {
	UserID      string `json:"user_id"`
	UserLogin   string `json:"user_login"`
	DisplayName string `json:"display_name"`
}

type UserExtension added in v0.5.6 

type UserExtension struct {
	CanActivate bool     `json:"can_activate"`
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	Type        []string `json:"type"`
	Version     string   `json:"version"`
}

type UserExtensionsResponse added in v0.5.6 

type UserExtensionsResponse struct {
	ResponseCommon
	Data ManyUserExtensions
}

type UserFollow 

type UserFollow struct {
	FromID     string    `json:"from_id"`
	FromLogin  string    `json:"from_login"`
	FromName   string    `json:"from_name"`
	ToID       string    `json:"to_id"`
	ToName     string    `json:"to_name"`
	FollowedAt time.Time `json:"followed_at"`
}

type UserSubscription added in v1.10.0 

type UserSubscription struct {
	BroadcasterID    string `json:"broadcaster_id"`
	BroadcasterLogin string `json:"broadcaster_login"`
	BroadcasterName  string `json:"broadcaster_name"`
	IsGift           bool   `json:"is_gift"`
	GifterLogin      string `json:"gifter_login"`
	GifterName       string `json:"gifter_name"`
	Tier             string `json:"tier"`
}

type UserSubscriptionResponse added in v1.10.0 

type UserSubscriptionResponse struct {
	ResponseCommon
	Data ManyUserSubscriptions
}

type UserSubscriptionsParams added in v1.10.0 

type UserSubscriptionsParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	UserID        string `query:"user_id"`
}

type UsersBlockedParams added in v1.12.0 

type UsersBlockedParams struct {
	BroadcasterID string `query:"broadcaster_id"`
	After         string `query:"after"`
	First         int    `query:"first,20"` // Limit 100
}

type UsersBlockedResponse added in v1.12.0 

type UsersBlockedResponse struct {
	ResponseCommon
	Data ManyUsersBlocked
}

type UsersFollowsParams 

type UsersFollowsParams struct {
	After  string `query:"after"`
	First  int    `query:"first,20"` // Limit 100
	FromID string `query:"from_id"`
	ToID   string `query:"to_id"`
}

type UsersFollowsResponse 

type UsersFollowsResponse struct {
	ResponseCommon
	Data ManyFollows
}

type UsersParams 

type UsersParams struct {
	IDs    []string `query:"id"`    // Limit 100
	Logins []string `query:"login"` // Limit 100
}

type UsersResponse 

type UsersResponse struct {
	ResponseCommon
	Data ManyUsers
}

type ValidateTokenResponse added in v0.5.9 

type ValidateTokenResponse struct {
	ResponseCommon
	Data validateTokenDetails
}

type Video 

type Video struct {
	ID            string              `json:"id"`
	UserID        string              `json:"user_id"`
	UserLogin     string              `json:"user_login"`
	UserName      string              `json:"user_name"`
	StreamID      string              `json:"stream_id"`
	Title         string              `json:"title"`
	Description   string              `json:"description"`
	CreatedAt     string              `json:"created_at"`
	PublishedAt   string              `json:"published_at"`
	URL           string              `json:"url"`
	ThumbnailURL  string              `json:"thumbnail_url"`
	Viewable      string              `json:"viewable"`
	ViewCount     int                 `json:"view_count"`
	Language      string              `json:"language"`
	Type          string              `json:"type"`
	Duration      string              `json:"duration"`
	MutedSegments []VideoMutedSegment `json:"muted_segments"`
}

type VideoMarker added in v0.4.1 

type VideoMarker struct {
	VideoID string   `json:"video_id"`
	Markers []Marker `json:"markers"`
}

type VideoMutedSegment added in v1.8.0 

type VideoMutedSegment struct {
	Duration int `json:"duration"`
	Offest   int `json:"offset"`
}

type VideosParams 

type VideosParams struct {
	IDs    []string `query:"id"`      // Limit 100
	UserID string   `query:"user_id"` // Limit 1
	GameID string   `query:"game_id"` // Limit 1

	// Optional
	After    string `query:"after"`
	Before   string `query:"before"`
	First    int    `query:"first,20"`   // Limit 100
	Language string `query:"language"`   // Limit 1
	Period   string `query:"period,all"` // "all" (default), "day", "month", and "week"
	Sort     string `query:"sort,time"`  // "time" (default), "trending", and "views"
	Type     string `query:"type,all"`   // "all" (default), "upload", "archive", and "highlight"
}

type VideosResponse 

type VideosResponse struct {
	ResponseCommon
	Data ManyVideos
}

type WebhookSubscription added in v0.3.1 

type WebhookSubscription struct {
	Topic     string `json:"topic"`
	Callback  string `json:"callback"`
	ExpiresAt Time   `json:"expires_at"`
}

type WebhookSubscriptionPayload added in v0.4.2 

type WebhookSubscriptionPayload struct {
	Mode         string `json:"hub.mode"`
	Topic        string `json:"hub.topic"`
	Callback     string `json:"hub.callback"`
	LeaseSeconds int    `json:"hub.lease_seconds,omitempty"`
	Secret       string `json:"hub.secret,omitempty"`
}

type WebhookSubscriptionResponse added in v0.4.2 

type WebhookSubscriptionResponse struct {
	ResponseCommon
}

type WebhookSubscriptionsParams added in v0.3.1 

type WebhookSubscriptionsParams struct {
	After string `query:"after"`
	First int    `query:"first,20"` // Limit 100
}

type WebhookSubscriptionsResponse added in v0.3.1 

type WebhookSubscriptionsResponse struct {
	ResponseCommon
	Data ManyWebhookSubscriptions
}

type WebhookTopic added in v0.4.2 

type WebhookTopic int

WebhookTopic is a topic that relates to a specific webhook event. 

const (
	UserFollowsTopic WebhookTopic = iota
	StreamChangedTopic
	UserChangedTopic
	GameAnalyticsTopic
	ExtensionAnalyticsTopic
)

Enumerated webhook topics

func GetWebhookTopicFromRequest added in v0.4.2 

func GetWebhookTopicFromRequest(req *http.Request) WebhookTopic

GetWebhookTopicFromRequest inspects the "Link" request header to determine if it matches against any recognised webhooks topics. The matched topic is returned. Otherwise -1 is returned.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.