io.github.sornerol.chess.pubapi.client.StreamersClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chesscom-pubapi-wrapper Show documentation

A wrapper for Chess.com's PubAPI.

There is a newer version: 1.7.0

Show newest version

package io.github.sornerol.chess.pubapi.client;

import io.github.sornerol.chess.pubapi.domain.streamers.StreamersList;
import io.github.sornerol.chess.pubapi.exception.ChessComPubApiException;

import java.io.IOException;

/**
 * Client for fetching data about streamers.
 *
 * @see Chess.com PubAPI documentation
 */
public class StreamersClient extends PubApiClientBase {
    private static final String ENDPOINT_BASE = "https://api.chess.com/pub/streamers";

    /**
     * Fetch information about Twitch streamers on Chess.com.
     *
     * @return {@link StreamersList} with information about streamers.
     * @throws IOException             if there is a problem connecting to Chess.com.
     * @throws ChessComPubApiException if Chess.com returns a non-success response code.
     * @see Chess.com PubAPI documentation
     */
    public StreamersList getStreamers() throws IOException, ChessComPubApiException {
        return getRequest(ENDPOINT_BASE, StreamersList.class);
    }
}