Java API for Twitch

Support:

Documentation:

A quick note:

This API aims to retrieve all twitch relation information from the Twitch REST API V5, Twitch PubSub and the Twitch IRC Server. Futhermore twitch related services like Streamlabs are integrated.

This project is still in development, check out Features and Changelog to follow progress.

Quick Start

Gradle

Add it to your build.gradle with:

repositories {
	jcenter()
}

and: (latest, you should use the actual version here)

dependencies {
    compile 'com.github.twitch4j:twitch4j:v0.11.0'
}

Maven

Add it to your pom.xml with:

<repositories>
    <repository>
      <id>jcenter</id>
      <url>https://jcenter.bintray.com/</url>
    </repository>
</repositories>

and: (latest, you should use the actual version here)

<dependency>
    <groupId>com.github.twitch4j</groupId>
    <artifactId>twitch4j</artifactId>
    <version>v0.11.0</version>
</dependency>

Features

OAuth Authentication

Twitch
StreamLabs

Twitch REST Endpoints

Twitch PubSub

Twitch IRC (WebSocket)

3rd Party

Streamlabs

Users (Read)
Donations (Read, Create)
Custom Alerts (Create)

StreamTip

Planned

GameWisp

Planned

StreamPro

No API

Muxy.IO

No API

Getting Started

Just some simple examples, visit the WIKI for more details.

Sample Projects using Twitch4J

CLI: Chatbot - Twitch4J by @twitch4j
GUI: Twitch Queue Bot by @SirSkaro

Client Builder (Twitch Standalone)

TwitchClient twitchClient = TwitchClientBuilder.init()
	.withClientId("Twitch App Id")
	.withClientSecret("Twitch App Secret")
	.withAutoSaveConfiguration(true)
	.withConfigurationDirectory(new File("config"))
	.withCredential("ixsxu9123xzmlx798xooa3f91q1e9c") // Get your token at: https://twitchapps.com/tmi/
	.connect();

Get User Id from UserName

The Twitch V5 Endpoints prefer to use id's over names. You can get the user/channel id by using the getUserIdByUserName Method of the UserEndpoint.

// Channel Name to Channel ID (V5 API)
Optional<Long> userId = twitchClient.getUserEndpoint().getUserIdByUserName("whynabit");

Because there is the possibility that the user may not exists, you will get an optional return. So you need to handle the result like this:

if (userId.isPresent()) {
	// User exists
	System.out.println("UserID = " + userId.get());
} else {
	// User does not exist -> handle error
}

Get Channel Follows

To extend the above example, the whole code to get the followers of a channel woud look like this:

try {
	// Get Channel Endpoint for specific channel
	ChannelEndpoint channelEndpoint = twitchClient.getChannelEndpoint("channelName");

	// Get the 500 newest followers
	List<Follow> followList = channelEndpoint.getFollowers(Optional.ofNullable(500), Optional.ofNullable("desc"));
	for(Follow follow : followList) {
		System.out.println("User " + follow.getUser().getDisplayName() + " first followed at " + follow.getCreatedAt().toString());
	}

} catch (ChannelDoesNotExistException ex) {
	System.out.println("Channel does not exist!");
} catch (Exception ex) {
	ex.printStackTrace();
}

WIKI

For more advanced features, check out the WIKI.

Problems

If you have problems using the Twitch Java API, then you are welcome to join the discord server to talk about it.

If you discover any issues/have feature requests, then please open an issue here.

License

Released under the MIT license.

SZOKOZ/twitch4j