twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

HelixTagApi

The Helix API methods that deal with tags.

Overview

Can be accessed using client.helix.tags on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const tags = await api.helix.tags.getAllStreamTags();

Methods

getAllStreamTags(pagination)

async

Retrieves all stream tags.

Parameter Type Required Default Description
pagination HelixForwardPagination {}
pagination.after string none

A cursor to get the following page of.

pagination.limit string none

The number of results per page.

getAllStreamTagsPaginated()

Creates a paginator for all stream tags.

Return type: HelixPaginatedRequest<HelixTagData, HelixTag>

getStreamTagById(id)

async

Retrieves a single stream tag by ID.

Parameter Type Required Default Description
id string none

The ID of the stream tag.

Return type: HelixTag | null

getStreamTagsByIds(ids)

async

Retrieves a set of stream tags by IDs.

Parameter Type Required Default Description
ids Array<string> none

The IDs of the stream tags.

Return type: Array<HelixTag>