Skip to main content

Streams

FunctionReturns
getStreamsPromise<PaginatedResult<Stream>>
getStreamsByUserNamesPromise<Array<Stream>>
getStreamByUserNamePromise<Stream | null>
getStreamByUserNameBatchedPromise<Stream | null>
getStreamsByUserIdsPromise<Array<Stream>>
getStreamByUserIdPromise<Stream | null>
getStreamByUserIdBatchedPromise<Stream | null>
getStreamMarkersForUserPromise<PaginatedResult<StreamMarker>>
getStreamMarkersForVideoPromise<PaginatedResult<StreamMarker>>
createStreamMarkerPromise<StreamMarker>
getStreamKeyPromise<string>
getFollowedStreamsPromise<PaginatedResult<Stream>>

Functions​

getStreams​

twitch.stream.getStreams(filter?: PaginatedStreamFilter): Promise<PaginatedResult<Stream>>

getStreamsByUserNames​

twitch.stream.getStreamsByUserNames(userNames: Array<UserNameResolvable>): Promise<Array<Stream>>

getStreamByUserName​

twitch.stream.getStreamByUserName(userName: UserNameResolvable): Promise<Stream | null>

getStreamByUserNameBatched​

twitch.stream.getStreamByUserNameBatched(userName: UserNameResolvable): Promise<Stream | null>

getStreamsByUserIds​

twitch.stream.getStreamsByUserIds(userIds: Array<UserIdResolvable>): Promise<Array<Stream>>

getStreamByUserId​

twitch.stream.getStreamByUserId(userId: UserIdResolvable): Promise<Stream | null>

getStreamByUserIdBatched​

twitch.stream.getStreamByUserIdBatched(userId: UserIdResolvable): Promise<Stream | null>

getStreamMarkersForUser​

twitch.stream.getStreamMarkersForUser(userId: UserIdResolvable, pagination?: Pagination): Promise<PaginatedResult<StreamMarker>>

getStreamMarkersForVideo​

twitch.stream.getStreamMarkersForVideo(userId: UserIdResolvable, videoId: string, pagination?: Pagination): Promise<PaginatedResult<StreamMarker>>

createStreamMarker​

twitch.stream.createStreamMarker(description?: string): Promise<StreamMarker>

getStreamKey​

twitch.stream.getStreamKey(): Promise<string>

getFollowedStreams​

twitch.stream.getFollowedStreams(userId: UserIdResolvable, pagination?: ForwardPagination): Promise<PaginatedResult<Stream>>

Types​

ForwardPagination​

type ForwardPagination = {
	limit?: number
	after?: string
}

PaginatedResult​

type PaginatedResult<T> = {
	data: Array<T>
	cursor?: string
}

PaginatedStreamFilter​

type PaginatedStreamFilter = {
	game?: string | Array<string>
	language?: string | Array<string>
	type?: StreamType
	userId?: string | Array<string>
	userName?: string | Array<string>
	before?: string
	limit?: number
	after?: string
}

Pagination​

interface Pagination {
	limit?: number
	after?: string
	before?: string
}

Stream​

type Stream = {
	id: string
	userId: string
	userLogin: string
	userName: string
	gameId: string
	gameName: string
	communityIds: Array<string>
	type: StreamType
	title: string
	tags: Array<string>
	viewerCount: number
	startedAt: string
	language: string
	thumbnailUrl: string
	isMature: boolean
}

StreamMarker​

type StreamMarker = {
	id: string
	createdAt: string
	description: string
	positionSeconds: number
	url?: string
}

StreamType​

type StreamType = "" | "live" | "vodcast"

UserIdResolvable​

type UserIdResolvable = string | UserIdResolvableType

UserIdResolvableType​

type UserIdResolvableType = {
	id: string
}

UserNameResolvable​

type UserNameResolvable = string | UserNameResolveableType

UserNameResolveableType​

type UserNameResolveableType = {
	name: string
}