• Home

  • How it works
  • Api
  • Chat
  • Msg object
  • Extensions
  • Logger

• Examples

  • Talk
  • Emotesets
  • Followers
  • Subscribes
  • Mod and unmod
  • Ban and timeout
  • Host and unhost
  • Hosted
  • User info

Api

Intended to make interaction with Twitch http endpoints as easy as possible, making available both Helix and Kraken api's.

Options

const api = {
    helixUrl: 'https://api.twitch.tv/helix',
    krakenUrl: 'https://api.twitch.tv/kraken'
};

const twitch = new Twitch('your-oauth-token', { api });

Helix and kraken

The helix and kraken methods are explicit convenience methods which alias the request method.

const response = await twitch.api.helix('/users/follows', {
    data: { toId }
});

const response = await twitch.api.kraken('/chat/emoticon_images', {
    data: { emotesets }
});

Request

The request method takes path as a first parameter, an options object, and returns a promise.

Keys are returned in camelCase, for example if you are trying to access a value named from_id it can be found at response.fromId. Similarly attributes are defined in camelCase, if you are trying to set a data attribute named { to_id } you might use { toId }.

const response = await twitch.api.request('/users/follows', {
    data: { toId }
});

const response = await twitch.api.request('/chat/emoticon_images', {
    data: { emotesets },
    kraken: true
});

Special values

There are special values which can be used to make use of information returned on the kequtwitch instance during validation. Setting any data value to one of these strings will use your corresponding information.

const response = await twitch.api.request('/users', {
    data: { id: '$userId' }
});