HelixStreamApi

The Helix API methods that deal with streams.

Overview

Methods

Can be accessed using client.streams on an ApiClient instance.

Example

const api = new ApiClient({ authProvider });
const stream = await api.streams.getStreamByUserId('125328655');

Methods

createStreamMarker(broadcaster, description)

async

Creates a new stream marker.

Only works while the specified user's stream is live.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The broadcaster to create a stream marker for.
description	string		none	The description of the marker.

Return type: HelixStreamMarker

getFollowedStreams(user, pagination)

async

Gets the streams that are currently live and are followed by the given user.

Parameter	Type	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType	none	The user to check followed streams for.
pagination	HelixForwardPagination	none	see below
pagination.after	string	none	A cursor to get the following page of.
pagination.limit	number	none	The number of results per page.

Return type: HelixPaginatedResult<HelixStream>

getFollowedStreamsPaginated(user)

Creates a paginator for the streams that are currently live and are followed by the given user.

Parameter	Type	Required	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The user to check followed streams for.

Return type: HelixPaginatedRequest<HelixStreamData, HelixStream>

getStreamByUserId(user)

async

Gets the current stream for the given user ID.

Parameter	Type	Required	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The user ID to get the stream for.

Return type: HelixStream | null

getStreamByUserIdBatched(user)

async

Gets the current stream for the given user ID, batching multiple calls into fewer requests as the API allows.

Parameter	Type	Required	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The user ID to get the stream for.

Return type: HelixStream | null

getStreamByUserName(user)

async

Gets the current stream for the given username.

Parameter	Type	Required	Default	Description
user	UserNameResolvable A user name or a user or channel object. Aliased type: string \| UserNameResolveableType		none	The username to get the stream for.

Return type: HelixStream | null

getStreamByUserNameBatched(user)

async

Gets the current stream for the given username, batching multiple calls into fewer requests as the API allows.

Parameter	Type	Required	Default	Description
user	UserNameResolvable A user name or a user or channel object. Aliased type: string \| UserNameResolveableType		none	The username to get the stream for.

Return type: HelixStream | null

getStreamKey(broadcaster)

async

Gets the stream key of a stream.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The broadcaster to get the stream key for.

Return type: string

getStreamMarkersForUser(user, pagination)

async

Gets a list of all stream markers for a user.

Parameter	Type	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType	none	The user to list the stream markers for.
pagination	HelixPagination	none	see below
pagination.after	string	none	A cursor to get the following page of.
pagination.before	string	none	A cursor to get the previous page of.
pagination.limit	number	none	The number of results per page.

Return type: HelixPaginatedResult<HelixStreamMarkerWithVideo>

getStreamMarkersForUserPaginated(user)

Creates a paginator for all stream markers for a user.

Parameter	Type	Required	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The user to list the stream markers for.

Return type: HelixPaginatedRequest<HelixStreamGetMarkersResponse, HelixStreamMarkerWithVideo>

getStreamMarkersForVideo(user, videoId, pagination)

async

Gets a list of all stream markers for a video.

Parameter	Type	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType	none	The user the video belongs to.
videoId	string	none	The video to list the stream markers for.
pagination	HelixPagination	none	see below
pagination.after	string	none	A cursor to get the following page of.
pagination.before	string	none	A cursor to get the previous page of.
pagination.limit	number	none	The number of results per page.

Return type: HelixPaginatedResult<HelixStreamMarkerWithVideo>

getStreamMarkersForVideoPaginated(user, videoId)

Creates a paginator for all stream markers for a video.

Parameter	Type	Required	Default	Description
user	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType		none	The user the video belongs to.
videoId	string		none	The video to list the stream markers for.

Return type: HelixPaginatedRequest<HelixStreamGetMarkersResponse, HelixStreamMarkerWithVideo>

getStreams(filter)

async

Gets a list of streams.

Parameter	Type	Default	Description
filter	HelixPaginatedStreamFilter	<complex>	see below
filter.after	string	none	A cursor to get the following page of.
filter.before	string	none	A cursor to get the previous page of.
filter.game	string \| string[]	none	A game ID or a list thereof.
filter.language	string \| string[]	none	A language or a list thereof.
filter.limit	number	none	The number of results per page.
filter.type	HelixStreamType The type of a stream. Aliased type: "live" \| "vodcast" \| ""	none	A type of stream.
filter.userId	string \| string[]	none	A user ID or a list thereof.
filter.userName	string \| string[]	none	A user name or a list thereof.

Return type: HelixPaginatedResult<HelixStream>

getStreamsByUserIds(users)

async

Gets the current streams for the given user IDs.

Parameter	Type	Required	Default	Description
users	UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string \| number \| UserIdResolvableType []		none	The user IDs to get the streams for.

Return type: HelixStream[]

getStreamsByUserNames(users)

async

Gets the current streams for the given usernames.

Parameter	Type	Required	Default	Description
users	UserNameResolvable A user name or a user or channel object. Aliased type: string \| UserNameResolveableType []		none	The username to get the streams for.

Return type: HelixStream[]

getStreamsPaginated(filter)

Creates a paginator for streams.

Parameter	Type	Default	Description
filter	HelixStreamFilter	<complex>	see below
filter.game	string \| string[]	none	A game ID or a list thereof.
filter.language	string \| string[]	none	A language or a list thereof.
filter.type	HelixStreamType The type of a stream. Aliased type: "live" \| "vodcast" \| ""	none	A type of stream.
filter.userId	string \| string[]	none	A user ID or a list thereof.
filter.userName	string \| string[]	none	A user name or a list thereof.

Return type: HelixPaginatedRequest<HelixStreamData, HelixStream>

Main classes

Helix APIs

Classes

Interfaces

Type aliases

HelixStreamApi

Overview

Methods

Example

Methods

createStreamMarker(broadcaster, description)

getFollowedStreams(user, pagination)

getFollowedStreamsPaginated(user)

getStreamByUserId(user)

getStreamByUserIdBatched(user)

getStreamByUserName(user)

getStreamByUserNameBatched(user)

getStreamKey(broadcaster)

getStreamMarkersForUser(user, pagination)

getStreamMarkersForUserPaginated(user)

getStreamMarkersForVideo(user, videoId, pagination)

getStreamMarkersForVideoPaginated(user, videoId)

getStreams(filter)

getStreamsByUserIds(users)

getStreamsByUserNames(users)

getStreamsPaginated(filter)