API - Messaging Interface

The Twitch Chat System has a few unofficial endpoints which get exposed from https://tmi.twitch.tv.

danger

Twitch has decommissioned all of these endpoints. Please migrate to the official Helix API.

As Module: Twitch4J

To use TMI you need to enable the TMI API when building the Twitch4J Instance, as shown below:

Java

TwitchClient twitchClient = TwitchClientBuilder.builder()
    ...
    .withEnableTMI(true)
    ...
    .build();

Kotlin

val twitchClient = TwitchClientBuilder.builder()
    ...
    .withEnableTMI(true)
    ...
    .build()

Groovy

def twitchClient = TwitchClientBuilder.builder()
    ...
    .withEnableTMI(true)
    ...
    .build()

Standalone

Initialize the Helix API as Standalone Module:

Java

TwitchMessagingInterface client = TwitchMessagingInterfaceBuilder.builder()
    .withClientId("clientId")
    .withClientSecret("clientSecret")
    .build();

Kotlin

val client = TwitchMessagingInterfaceBuilder.builder()
    .withClientId("clientId")
    .withClientSecret("clientSecret")
    .build()

Groovy

def client = TwitchMessagingInterfaceBuilder.builder()
    .withClientId("clientId")
    .withClientSecret("clientSecret")
    .build()

API Methods

• TMI -> Get Chatters
• TMI -> Get Hosts
• TMI -> Get Hosts Of