sleeper-go

Go library for the Sleeper fantasy sports free read-only API. According to their documentation, stay under 1000 API calls per minute, otherwise, you risk being IP-blocked.

Usage

Example code that gets the users for the specified league and outputs their display name and team name.

package main

import (
	"fmt"
	"log"

	"github.com/lum8rjack/sleeper-go"
)

func main() {
    leagueID := "123456789012345678" // Fake league Id
	botClient := sleeper.NewClient()

	leagueUsers, err := botClient.GetLeagueUsers(leagueID)
	if err != nil {
		log.Fatal(err)
	}
	for _, user := range leagueUsers {
		fmt.Printf("%s (Team name: %s)\n", user.DisplayName, user.Metadata.TeamName)
	}
}

Sample output:

2KSports (Team name: Game of End Zones)
TOBOT (Team name: Saving Matt Ryan)
...

Custom Methods

I created a few custom methods that require correlating results from multiple API calls in order to receive the data.

GetMatchups

This method gets the matchups for the specified week and returns each team and their wins and losses.

type TeamMatchup struct {
	Teamname1   string
	Teamname2   string
	Team1Losses int
	Team2Losses int
	Team1Wins   int
	Team2Wins   int
}

func (c *Client) GetTeamMatchups(league_id string, week int) ([]TeamMatchup, error)

GetScoreboards

This method gets the scoreboard for each matchup for the specified week and returns each team and points.

type Scoreboard struct {
	Teamname1 string  `json:"teamname_1"`
	Teamname2 string  `json:"teamname_2"`
	Points1   float32 `json:"points_1"`
	Points2   float32 `json:"points_2"`
}

func (c *Client) GetScoreboards(league_id string, week int) ([]Scoreboard, error)

Players

The players API is not intended to be called every time you need to look up players due to the large file size. It should not be called more than once per day.

With this in mind, I have created additional methods to save the players information to disk and read the saved file from disk.

// Get all players - use this sparingly
func (c *Client) GetAllPlayers(sport string) (Players, error)

// Get all players and save the details to a file
func (c *Client) SaveAllPlayers(sport string, file string) (bool, error)

// Get all players from a saved file
func GetAllPlayers(file string) (Players, error)

Sleeper API Implementation Status

The following table shows the implementation status of all known Sleeper API endpoints in this library. The table includes both officially documented endpoints from Sleeper's API documentation as well as several undocumented endpoints that were discovered during development. All endpoints, both documented and undocumented, have been fully implemented.

Category	Function	Description	Implemented
User	GetUserByUsername(username string)	Get user details by username	✅
User	GetUserByID(userID string)	Get user details by user ID	✅
Avatars	GetAvatar(avatarID string)	Get full-size avatar image	✅
Avatars	GetAvatarThumbnail(avatarID string)	Get thumbnail avatar image	✅
Leagues	GetAllLeagesForUser(userID string, sport string, season int)	Get all leagues a user is in for a specific sport and season	✅
Leagues	GetLeague(leagueID string)	Get details of a specific league	✅
Leagues	GetRosters(leagueID string)	Get all rosters in a league	✅
Leagues	GetLeagueUsers(leagueID string)	Get all users in a league	✅
Leagues	GetMatchups(leagueID string, week int)	Get all matchups for a specific week in a league	✅
Leagues	GetPlayoffsWinnersBracket(leagueID string)	Get the winners bracket for league playoffs	✅
Leagues	GetPlayoffsLosersBracket(leagueID string)	Get the losers bracket for league playoffs	✅
Leagues	GetTransactions(leagueID string, round int)	Get all transactions for a specific round in a league	✅
Leagues	GetTradedPicks(leagueID string)	Get all traded draft picks in a league	✅
Leagues	GetSportState(sport string)	Get current state of a sport (season, week, etc.)	✅
Drafts	GetDraftsForUser(userID string, sport string, season int)	Get all drafts a user is in for a specific sport and season	✅
Drafts	GetDraftsForLeague(leagueID string)	Get all drafts in a league	✅
Drafts	GetDraft(draftID string)	Get details of a specific draft	✅
Drafts	GetAllDraftPicks(draftID string)	Get all picks in a draft	✅
Drafts	GetDraftTradedPicks(draftID string)	Get all traded picks in a draft	✅
Players	GetAllPlayers(sport string)	Get all players for a sport (large response, use sparingly)	✅
Players	GetTrendingPlayers(sport string, type string, hours int, limit int)	Get trending players with optional lookback hours and limit	✅
Undocumented	GetNflProjections(year int, week int)	Get player projections for a specific NFL season and week	✅
Undocumented	GetNflPlayerSeasonStats(playerID int, year int, postseason bool)	Get season stats for a specific NFL player	✅
Undocumented	GetNflPlayer(playerID int)	Get detailed information for a specific NFL player	✅
Undocumented	GetNflPlayerResearch(year int, week int, postseason bool)	Get player research data (ownership, start rates) for a specific week	✅
Undocumented	GetNflTeamDepthChart(team string)	Get depth chart for a specific NFL team	✅
Undocumented	GetNflSchedule(year int, postseason bool)	Get NFL schedule for a specific season (regular or postseason)	✅

License

MIT