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

SearchApi

The API methods that deal with searching.

Overview

Can be accessed using client.kraken.search on an ApiClient instance.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const channel = await api.kraken.search.searchStreams('Hearthstone');

Methods

searchChannels(term, page, limit)

async

Retrieves a list of channels that match the given search term.

ParameterTypeDescription
termstring

The term you want to search for.

pagenumber

The result page you want to retrieve.

limitnumber

The number of results you want to retrieve.

Return type: Array<Channel>

searchStreams(term, page, limit, hls)

async

Retrieves a list of streams that match the given search term.

ParameterTypeDescription
termstring

The term you want to search for.

pagenumber

The result page you want to retrieve.

limitnumber

The number of results you want to retrieve.

hlsboolean

Whether you want only HLS or only non-HLS (RTMP) streams. If not set, finds both types of streams.

Return type: Array<Stream>