Aller au contenu
twitch.apiv2.0

Référence / Groupes de l'API

twitch.search

Recherche de catégories et de chaînes.

Toutes les méthodes de twitch.search, avec leurs paramètres, ce qu’elles renvoient et le jeton nécessaire.

twitch.search.categories(params, options?): Paginator<CategorySearchResult>

Trouve les catégories dont le nom contient tous les mots de la recherche, dans n’importe quel ordre et sans tenir compte de la casse.

Jeton : application ou utilisateur.

NomTypeDescription
query requisstringTexte à rechercher. Passez-le tel quel, il est encodé pour l’URL à votre place.
firstnumberÉléments par page, de 1 à 100. Twitch en renvoie 20 par défaut.
afterstringCurseur de la page suivante.

options : Options de requête pour cet appel : as, token, signal, timeout, retries.

Paginator<CategorySearchResult>

Champs de CategorySearchResult
NomTypeDescription
idstringIdentifiant de la catégorie.
namestringNom de la catégorie.
box_art_urlstringURL de la jaquette.
const categories = await twitch.search.categories({ query: "fort" }).take(5);

Référence Twitch

twitch.search.channels(params, options?): Paginator<ChannelSearchResult>

Trouve les chaînes qui ont streamé au cours des six derniers mois. La recherche porte sur le début du nom de connexion ou, avec live_only, sur le début du nom du diffuseur et du nom de la catégorie.

Jeton : application ou utilisateur.

NomTypeDescription
query requisstringTexte à rechercher. Passez-le tel quel, il est encodé pour l’URL à votre place.
live_onlybooleantrue pour ne garder que les chaînes en direct. Twitch prend false par défaut.
firstnumberÉléments par page, de 1 à 100. Twitch en renvoie 20 par défaut.
afterstringCurseur de la page suivante.

options : Options de requête pour cet appel : as, token, signal, timeout, retries.

Paginator<ChannelSearchResult>

Champs de ChannelSearchResult
NomTypeDescription
broadcaster_languagestringLangue du diffuseur : un code ISO 639-1, ou "other".
broadcaster_loginstringNom de connexion du diffuseur.
display_namestringNom d’affichage du diffuseur.
game_idstringIdentifiant de la catégorie en cours de diffusion, ou de la dernière diffusée.
game_namestringNom de la catégorie en cours de diffusion, ou de la dernière diffusée.
idstringIdentifiant du diffuseur.
is_livebooleanIndique si la chaîne est en direct en ce moment.
tag_idsstring[]Obsolète. Toujours vide. Utilisez tags.
tagsstring[]Tags appliqués à la chaîne.
thumbnail_urlstringURL de la photo de profil du diffuseur.
titlestringTitre du stream. Une chaîne vide quand aucun n’est défini.
started_atstringDébut du stream, sous forme d’horodatage RFC 3339. Une chaîne vide quand la chaîne est hors ligne.
for await (const channel of twitch.search.channels({ query: "speedrun", live_only: true })) {
console.log(channel.display_name, channel.title);
}

Référence Twitch