Categorygithub.com/AndrewKraevskii/helix/v2
modulepackage
2.5.3
Repository: https://github.com/andrewkraevskii/helix.git
Documentation: pkg.go.dev

# README

helix

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

Tests and Coverage Coverage Status Go Reference

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.

See here for a list of endpoints and features this package supports.

Documentation & Examples

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

Support

Have a question? Need some assistance? Check out our dedicated channel in the Twitch API Discord.

Supported Go Versions

Our support of Go versions is aligned with Go's version release policy. So we will support a major version of Go until there are two newer major releases. We no longer support building this package with unsupported Go versions, as these contain security vulnerabilities which will not be fixed.

Contributions

PRs are very much welcome. Where possible, please include unit tests for any code that is introduced by your PRs. It's also helpful if you can include usage examples in the docs directory.

License

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

# Functions

GetWebhookTopicFromRequest inspects the "Link" request header to determine if it matches against any recognised webhooks topics.
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.
NewClient returns a new Twitch Helix API client.
Verifys that a notification came from twitch using the a signature and the secret used when creating the subscription.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AuthBaseURL is the base URL for composing authentication requests.
Types of user roles used within the JWT Claims.
DefaultAPIBaseURL is the base URL for composing API requests.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
EventSub helper Variables for Types and Status.
No description provided by the author
Enumerated webhook topics.
Types of segments datastores for the configuration service.
Types of segments datastores for the configuration service.
Types of segments datastores for the configuration service.
Types of Pub/Sub Permissions or targets.
Types of Pub/Sub Permissions or targets.
Types of Pub/Sub Permissions or targets.
Types of user roles used within the JWT Claims.
Enumerated webhook topics.
No description provided by the author
No description provided by the author
No description provided by the author
Types of user roles used within the JWT Claims.
No description provided by the author
Enumerated webhook topics.
No description provided by the author
No description provided by the author
No description provided by the author
Enumerated webhook topics.
Enumerated webhook topics.
Types of user roles used within the JWT Claims.

# Variables

Regular expressions used for parsing webhook link headers.
Regular expressions used for parsing webhook link headers.
Regular expressions used for parsing webhook link headers.
Regular expressions used for parsing webhook link headers.
Regular expressions used for parsing webhook link headers.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExpiresAt must be parsed manually since an empty string means perma ban.
BroadcasterID must match the auth tokens user_id.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Channel describes a channel from SearchChannel.
No description provided by the author
No description provided by the author
No description provided by the author
ChannelEditor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DateRange is a generic struct used by various responses.
No description provided by the author
Response for removing a custom reward.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Data for a channel ban notification.
Data for a channel cheer notification.
Data for a channel follow notification.
No description provided by the author
No description provided by the author
No description provided by the author
Data for a channel points custom reward notification.
Data for a channel points custom reward redemption notification.
Data for a channel poll begin event.
Data for a channel poll end event.
Data for a channel prediction begin event.
Data for a channel prediction end event.
Data for a channel prediction lock event.
Data for a channel raid notification.
Data for a channel subscribe notification.
EventSubChannelSubscriptionGiftEvent.
EventSubChannelSubscriptionMessageEvent.
Data for a channel unban notification.
Data for a channel update notification.
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.
This belongs to a hype train and defines a user contribution.
EventSubEmote.
Data for an extension bits transaction creation.
This belongs to a custom reward and defines it's cooldown.
Data for a hype train begin notification.
Data for a hype train end notification.
Data for a hype train progress notification.
This also belongs to a custom reward and defines the image urls.
This belongs to a custom reward and defines if it is limited per stream.
EventSubMessage.
This belong to a channel prediction and defines the outcomes.
No description provided by the author
This belongs to a reward redemption and defines the reward redeemed.
Data for a stream offline notification.
Data for a stream online notification.
Represents a subscription.
Parameter for filtering subscriptions, currently only the status is filterable.
Response for getting all current subscriptions.
This belong to an outcome and defines user reward.
Transport for the subscription, currently the only supported Method is "webhook".
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.
Data for an user update notification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetExtensionSecretResponse response structure received when generating or querying for generated secrets.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetExtensionSecretResponse response structure received when fetching secrets for an extension.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Twitch Response for getting all current subscriptions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ManySearchChannels is the response data from SearchChannels.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Prediction ..
No description provided by the author
No description provided by the author
No description provided by the author
PubSubPermissions publish permissions used within JWT claims.
No description provided by the author
No description provided by the author
Parameter for removing a subscription.
Response for removing a subscription.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SearchChannelsParams is parameters for SearchChannels.
SearchChannelsResponse is the response from SearchChannels.
Secret information about a generated secret.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StreamMarkersParams requires _either_ UserID or VideoID set UserID: fetches stream markers of the current livestream of the given user (VOD recording must be enabled).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Time is our custom time struct.
No description provided by the author
No description provided by the author
No description provided by the author
TwitchJWTClaims contains information containing twitch specific JWT information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
Data for a channel poll progress event, it's the same as the channel poll begin event.
Data for a channel prediction progress event.
Data for a channel moderator add notification, it's the same as the channel follow notification.
Data for a channel moderator remove notification, it's the same as the channel follow notification.
PublishType The Pub/Sub broadcast type.
SegmentType A segment configuration type.
No description provided by the author
RoleType The user role type.
WebhookTopic is a topic that relates to a specific webhook event.