Toute l'API Twitch, typée.

01

Appelez une méthode, recevez des données typées

Pas de jeton à demander, pas d’en-tête à poser, pas de curseur à transporter. Choisissez un exemple et lancez-le : à gauche le programme, à droite ce que la bibliothèque fait pour lui. Dans l’exemple du chat, écrivez un message et le bot répond.

ConsulterToutes les pagesBot de chatPassage en direct

const twitch = new Twitch({ clientId, clientSecret });

const user = await twitch.users.getByLogin("twitchdev");
if (!user) throw new Error("No such user");

const [channel] = await twitch.channels.get({
  broadcaster_id: user.id,
});
const followers = await twitch.channels
  .followers({ broadcaster_id: user.id })
  .total();

console.log(channel?.title, followers);

Sortie simuléeRelancer

1. Pas encore de jeton : il est demandé, une seule fois.
2. POSTid.twitch.tv/oauth2/token200
3. GET/users?login=twitchdev200
4. GET/channels?broadcaster_id=141981764200
5. GET/channels/followers?broadcaster_id=141981764&first=1200
6. "Building the next thing" 2841907

// 250 streams : trois requêtes, un seul tableau.
const top = await twitch.streams.get({ language: "fr" }).take(250);

for (const stream of top.slice(0, 3)) {
  console.log(stream.user_name, stream.viewer_count);
}

// Ou parcourir toutes les pages sans les garder toutes en mémoire.
for await (const stream of twitch.streams.get({ language: "fr" })) {
  if (stream.viewer_count < 1000) break;
}

Sortie simuléeRelancer

1. GET/streams?language=fr&first=100200
2. GET/streams?language=fr&first=100&after=eyJiIjp7Ik9m...200
3. GET/streams?language=fr&first=100&after=eyJiIjp7IkN1...200
4. 250 collectés, le reste de la troisième page est écarté.
5. nuit_blanche 18204
6. atelier_pixel 9311
7. LeGrandFroid 7754

const events = twitch.eventsub.websocket();

events.on(
  "channel.chat.message",
  { broadcaster_user_id: channel, user_id: bot },
  async (event) => {
    if (event.message.text !== "!ping") return;
    await twitch.chat.send({
      broadcaster_id: channel,
      message: "pong",
      reply_parent_message_id: event.message_id,
    });
  },
);

Sortie simuléeRelancer

1. WebSocket ouvert, session accueillie.
2. POST/eventsub/subscriptions202
3. margueritebonjour tout le monde
4. kowalczyk_devle bot est réveillé ?
5. kowalczyk_dev!ping
6. POST/chat/messages200
7. your_botbotpong

Écrire dans le chatEnvoyer

const hooks = twitch.eventsub.webhook({ callback, secret });

hooks.on(
  "stream.online",
  { broadcaster_user_id: "141981764" },
  (event) => {
    notify(`${event.broadcaster_user_name} is live`);
  },
);

// Les signatures sont vérifiées avant l'appel de votre gestionnaire.
export default {
  fetch: (request: Request) => hooks.handle(request),
};

Sortie simuléeRelancer

1. POST/eventsub/subscriptions202
2. Twitch vérifie le callback : défi relevé.
3. stream.onlineTwitchDev
4. Signature valide, ni rejeu ni doublon.
5. notify: TwitchDev is live

02

Trouvez votre endpoint

Tapez ce que vous voulez faire. Chaque méthode et chaque type d’événement est ici, avec le jeton nécessaire, et renvoie vers ses paramètres, son type de retour et un exemple.

Chercher dans l'API

• twitch.users.getByLogin()Renvoie un utilisateur d'après son nom de connexion, ou null quand il n'existe pas.jeton d'application ou utilisateur
• twitch.streams.get()Liste les streams en direct, en commençant par ceux qui ont le plus de spectateurs.jeton d'application ou utilisateur
• twitch.chat.send()Envoie un message dans le chat d'une chaîne.jeton d'application ou utilisateur
• twitch.moderation.ban()Bannit un utilisateur du chat d'une chaîne.jeton d'application ou utilisateur
• twitch.channels.followers()Liste les followers d'une chaîne, du plus récent au plus ancien.jeton d'application ou utilisateur
• twitch.clips.create()Met en clip les dernières secondes d'un stream en direct.jeton utilisateur
• channel.chat.messageUn utilisateur a envoyé un message dans le chat.événement
• stream.onlineLe diffuseur a lancé un stream.événement

155 méthodes et 83 types d'événementsParcourir les groupes

03

Ce que vous n’écrivez plus

• La tuyauterie des jetons

  Le jeton d’application est demandé quand un appel en a besoin. Les jetons utilisateur sont renouvelés avant d’expirer, validés chaque heure comme Twitch l’exige, et enregistrés où vous voulez.

• Quel jeton pour quel appel

  Chaque endpoint sait s’il lui faut le jeton d’application ou celui d’un utilisateur, et lequel. moderator_id, broadcaster_id et sender_id prennent par défaut l’identité de celui qui agit.

• Curseurs et tailles de page

  await sur une liste donne une page, for await les parcourt toutes. Les listes de plus de 100 identifiants sont découpées, récupérées en parallèle puis fusionnées.

• La gestion des 429

  Les en-têtes de limite de débit sont suivis pour chaque jeton : les requêtes attendent leur tour au lieu d’échouer. Ce qui peut être retenté sans risque l’est.

• La logique de reconnexion

  WebSocket, webhooks et conduits partagent un même on() typé. Reconnexions, réabonnements, vérification des signatures et livraisons en double sont gérés.

• Deviner la forme des données

  Chaque paramètre, chaque réponse et chaque événement est typé. Les événements à plusieurs formes se précisent dès que vous testez leur discriminant.

04

Trois façons de recevoir les événements

Le même on() pour les trois. Choisissez selon l’endroit où tourne votre code.

	WebSocket	Webhooks	Conduits
Il vous faut	Rien à héberger	Une URL HTTPS publique	Un processus par shard
S’abonne avec	Un jeton utilisateur	Le jeton d’application	Le jeton d’application
Survit à un redémarrage	Non, il se réabonne	Oui	Oui
Convient pour	Bots, applications de bureau, quelques chaînes	Serveurs et fonctions serverless	Beaucoup de chaînes, réparties sur plusieurs processus

05

Par où continuer

• 01
  Démarrage rapideInstaller, créer une application sur Twitch, faire un premier appel.
• 02
  Agir au nom d’un utilisateurÉcrire dans le chat, modérer, lancer des sondages : comment le bon jeton est choisi pour vous.
• 03
  ÉvénementsMessages de chat, follows, abonnements, passages en direct, au moment où ils se produisent.
• 04
  RecettesDes programmes complets à copier : bot de chat, alertes de direct, outils de modération.
• 05
  RéférenceChaque méthode, chaque type d’événement, chaque scope, chaque erreur.
• 06
  Depuis la version 1Ce qui a changé, et le nouveau nom de chaque ancienne méthode.

twitch.api est un projet open source indépendant. Il n’est ni affilié à Twitch Interactive, Inc., ni approuvé par cette société.