League endpoints

Returns information on fantasy leagues.

Get league

Description

Returns one league identified by its Sleeper ID

URL

https://api.sleeper.app/v1/league/<league_id>

Parameters

league_id:

The sleeper league ID to identify the league

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperLeague HansPeterOrding\SleeperApiClient\Dto\SleeperLeagueSettings HansPeterOrding\SleeperApiClient\Dto\SleeperLeagueScoringSettings

Example

1<?php
2
3/*
4 * Returns the league with id 1234567890
5 */
6$draft = $client->league()->get('1234567890');

List users

Description

Returns list of users in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/users

Parameters

league_id:

The sleeper league ID to identify the league

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperUser HansPeterOrding\SleeperApiClient\Dto\SleeperUserMetadata

Example

1<?php
2
3/*
4 * Returns users in league 1234567890
5 */
6$draft = $client->league()->listUsers('1234567890');

List drafts

Description

Returns list of drafts in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/drafts

Parameters

league_id:

The sleeper league ID to identify the league

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperDraft HansPeterOrding\SleeperApiClient\Dto\SleeperDraftSettings HansPeterOrding\SleeperApiClient\Dto\SleeperDraftMetadata

Example

1<?php
2
3/*
4 * Returns drafts in league 1234567890
5 */
6$draft = $client->league()->listDrafts('1234567890');

List rosters

Description

Returns list of rosters in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/rosters

Parameters

league_id:

The sleeper league ID to identify the league

Data transfer objects

HansPeterOrding\SleeperApiClient\Dto\SleeperRoster HansPeterOrding\SleeperApiClient\Dto\SleeperRosterSettings

Example

1<?php
2
3/*
4 * Returns rosters in league 1234567890
5 */
6$draft = $client->league()->listRosters('1234567890');

List playoff matchups

Description

Returns list of playoff matchups in given league for the requested branch.

URL

https://api.sleeper.app/v1/league/<league_id>/<branch>

Parameters

league_id:

The sleeper league ID to identify the league

branch:

The branch of the playoff tree (winners_bracket or losers_bracket)

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperPlayoffMatchup HansPeterOrding\SleeperApiClient\Dto\SleeperPlayoffMatchupSource

Example

1<?php
2
3use HansPeterOrding\SleeperApiClient\ApiClient\Endpoints\AbstractEndpoint;
4
5/*
6 * Returns playoff matchups from the winners bracket in league 1234567890
7 */
8$draft = $client->league()->listPlayoffMatchups('1234567890', AbstractEndpoint::BRANCH_WINNERS);

List traded picks

Description

Returns list of traded picks in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/traded_picks

Parameters

league_id:

The sleeper league ID to identify the league

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperTradedPick

Example

1<?php
2
3/*
4 * Returns traded picks in league 1234567890
5 */
6$draft = $client->league()->listTradedPicks('1234567890');

List transactions

Description

Returns list of transactions (waiver bids, trades, drops, etc.) in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/transactions/<round>

Parameters

league_id:

The sleeper league ID to identify the league

round:

The week to pull transactions from (Sleeper is not very consistent in naming, so here it’s really called round.)

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperTransaction HansPeterOrding\SleeperApiClient\Dto\SleeperTransactionWaiverBudget HansPeterOrding\SleeperApiClient\Dto\SleeperTransactionWaiverSettings HansPeterOrding\SleeperApiClient\Dto\SleeperTransactionMetadata HansPeterOrding\SleeperApiClient\Dto\SleeperTradedPick

Example

1<?php
2
3/*
4 * Returns transactions in league 1234567890 for week 1
5 */
6$draft = $client->league()->listTransactions('1234567890', 1);

List matchups

Description

Returns list of matchup in given league.

URL

https://api.sleeper.app/v1/league/<league_id>/matchups/<week>

Parameters

league_id:

The sleeper league ID to identify the league

week:

The week to pull transactions from

Data transfer object

HansPeterOrding\SleeperApiClient\Dto\SleeperMatchup

Example

1<?php
2
3/*
4 * Returns matchups in league 1234567890 for week 1
5 */
6$draft = $client->league()->listMatchups('1234567890', 1);