Skip to main content

Search

FunctionReturns
searchCategoriesPromise<PaginatedResult<Game>>
searchChannelsPromise<PaginatedResult<ChannelSearchResult>>

Functions​

searchCategories​

twitch.search.searchCategories(query: string, pagination?: ForwardPagination): Promise<PaginatedResult<Game>>

searchChannels​

twitch.search.searchChannels(query: string, filter?: PaginatedChannelSearchFilter): Promise<PaginatedResult<ChannelSearchResult>>

Types​

ChannelSearchResult​

type ChannelSearchResult = {
	broadcasterLanguage: string
	id: string
	broadcasterLogin: string
	displayName: string
	gameId: string
	gameName: string
	isLive: boolean
	tags: Array<string>
	thumbnailUrl: string
	title: string
	startedAt: string
}

ForwardPagination​

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

Game​

type Game = {
	id: string
	name: string
	boxArtUrl: string
	igdbId: string
}

PaginatedChannelSearchFilter​

type PaginatedChannelSearchFilter = {
	liveOnly?: boolean
	limit?: number
	after?: string
}

PaginatedResult​

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