Aller au contenu
twitch.apiv2.0

Référence / Groupes de l'API

twitch.videos

Vidéos : rediffusions, temps forts et mises en ligne.

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

twitch.videos.get(params, options?): Paginator<Video>

Renvoie des vidéos d’après leur identifiant, ou liste les vidéos d’un utilisateur ou d’une catégorie. Les filtres ne s’appliquent qu’aux listes par utilisateur ou par catégorie.

Jeton : application ou utilisateur.

NomTypeDescription
idstring | readonly string[]Ces vidéos. Jusqu’à 100 identifiants.
user_idstringVidéos de cet utilisateur.
game_idstringVidéos de cette catégorie. Twitch en renvoie 500 au plus.
languagestringUniquement les vidéos dans cette langue : un code ISO 639-1, ou "other". Uniquement avec game_id.
period"day" | "week" | "month" | "all"Uniquement les vidéos publiées pendant cette période. Twitch prend "all" par défaut. Uniquement avec game_id ou user_id.
sort"time" | "trending" | "views"Ordre des résultats : les plus récentes d’abord, celles qui progressent le plus vite d’abord ou les plus vues d’abord. Twitch prend "time" par défaut. Uniquement avec game_id ou user_id.
type"archive" | "highlight" | "upload" | "all"Uniquement les vidéos de ce type. Twitch prend "all" par défaut. Uniquement avec game_id ou user_id.
firstnumberÉléments par page, de 1 à 100. Twitch en renvoie 20 par défaut. Uniquement avec game_id ou user_id.
afterstringCurseur de la page suivante. Uniquement avec user_id.
beforestringCurseur de la page précédente. Uniquement avec user_id.

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

Paginator<Video>

Champs de Video
NomTypeDescription
idstringIdentifiant de la vidéo.
stream_idstring | nullIdentifiant du stream dont la vidéo est l’enregistrement. null sauf si type vaut "archive".
user_idstringIdentifiant du diffuseur à qui appartient la vidéo.
user_loginstringNom de connexion du diffuseur.
user_namestringNom d’affichage du diffuseur.
titlestringTitre de la vidéo.
descriptionstringDescription de la vidéo.
created_atstringDate de création de la vidéo, sous forme d’horodatage RFC 3339.
published_atstringDate de publication de la vidéo, sous forme d’horodatage RFC 3339.
urlstringURL de la page de la vidéo.
thumbnail_urlstringURL d’une image d’aperçu. Remplacez %&#123;width} et %&#123;height} par la taille voulue, en pixels. Twitch ne sert pour l’instant que du 320 par 180.
viewable"public"Qui peut regarder la vidéo. Toujours "public".
view_countnumberNombre de vues.
languagestringLangue de la vidéo : un code ISO 639-1, ou "other".
type"archive" | "highlight" | "upload"Type de vidéo : une rediffusion, un temps fort ou une mise en ligne.
durationstringDurée de la vidéo, écrite sous la forme "3m21s".
muted_segmentsVideoMutedSegment[] | nullPassages rendus muets par Twitch, ou null quand il n’y en a pas.
const [video] = (await twitch.videos.get({ id: "1234567890" })).data;
for await (const vod of twitch.videos.get({ user_id: "141981764", type: "archive" })) {
console.log(vod.title, vod.duration);
}

Référence Twitch

twitch.videos.delete(params, options?): Promise<string[]>

Supprime des vidéos et se résout avec les identifiants supprimés. Twitch accepte 5 identifiants par requête : les listes plus longues partent donc en plusieurs requêtes, l’une après l’autre. Dans une même requête, une seule vidéo que l’utilisateur n’a pas le droit de supprimer empêche la suppression des 5.

Jeton : utilisateur, scope channel:manage:videos.

NomTypeDescription
id requisstring | readonly string[]Identifiants des vidéos à supprimer. Autant que vous voulez : les longues listes sont découpées pour vous.

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

Promise<string[]>

const deleted = await twitch.videos.delete({ id: ["1234567890", "1234567891"] });

Référence Twitch