twitch-gql

Install it from npm:

Usage no npm install needed!

<script type="module">
  import twitchGql from 'https://cdn.skypack.dev/twitch-gql';
</script>

README

TwitchGQL

Allows interaction with Twitch via the Twitch's inner GraphQL protocol

Installation

Install it from npm:

$ npm install twitch-gql

Contents

How to use

Head over to the examples/ directory for examples.

const TwitchGQL = require("twitch-gql").Init();

(async () => {
    let CurrentTopStreams = await TwitchGQL.GetTopStreams();
    CurrentTopStreams = CurrentTopStreams.data.streams.edges;

    console.log(CurrentTopStreams);
})();

Methods

Init(clientID)

  • clientID - An optional parameter to set the client ID

Initializes TwitchGQL en returns a client-object

GetUser(login)

  • login - Login of the broadcaster

Gets broadcaster information.

GetTopStreams(amount)

  • amount - An optional parameter to set the amount of rows you want to get

Get the current top broadcasters currently live

GetVideos(login)

  • login - Login of the broadcaster

Get a list of last broadcasts or videos from a broadcaster

GetPlaybackAccessToken(videoID)

  • videoID - The video ID you want to request the access token for

Get an access token and signature to use for an m3u8 playlist

GetVideoMoments(videoID)

  • videoID - The video ID you want to request the access token for

Get highlights/game changes of a vod

_SendQuery(QueryName, variables, preset)

  • QueryName - The name of a preset query in the queries directory
    In the case the preset parameter is true, this is the name of a pre-set queryname from Twitch

  • variables - An optional object of variables you want to pass onto the query

  • preset - (default false) if true this will use

Send a raw query through GraphQL

About

Made by poespas ( me@poespas.me )