Members
-
Maps
proTeamnumerical enum to readable team names. -
Maps
proTeamnumerical enum to readable team name abbreviations. -
scoringItemToId ScoringItems constant
-
-
Maps
slotCategoryId's numerical enum to readable positions.
Type Definitions
-
All possible ways a player may be acquired onto a fantasy football team roster.
-
Properties:
Name Type Description homeScorenumber The total points scored by the home team.
homeProjectedScorenumber The projected total points scored by the home team. NOTE: This field is only populated in the boxscore for the current matchup period!
homeTeamIdnumber The home team's id. Can be used to load a cached Team.
homeRosterArray.<BoxscorePlayer> The home team's roster, containing player info and stats.
awayScorenumber The total points scored by the away team.
awayProjectedScorenumber The projected total points scored by the away team. NOTE: This field is only populated in the boxscore for the current matchup period!
awayTeamIdnumber The away team's id. Can be used to load a cached Team.
awayRosterArray.<BoxscorePlayer> The away team's roster, containing player info and stats.
-
BoxscorePlayerMap PlayerMap
-
Properties:
Name Type Description playerPlayer The player model representing the NFL player.
rosteredPositionstring The position the player is slotted at in the fantasy lineup
totalPointsnumber The total points scored by the player.
pointBreakdownPlayerStats The PlayerStats model with the points scored by the player.
rawStatsPlayerStats The PlayerStats model with the raw statistics registered by the player.
-
All possible draft types for a league.
-
DraftPlayerMap PlayerMap
-
Properties:
Name Type Description idnumber The id of the player in the ESPN universe.
teamIdnumber The teamId of the fantasy team that drafted the player. Use
Client#getTeamAtWeekto access fantasy team data.overallPickNumbernumber The overall pick number
roundNumbernumber The round in which the pick occurred
roundPickNumbernumber The pick number inside the round
isKeeperboolean FOR KEEPER DRAFTS ONLY: Whether or not the "drafted" player is a keeper pick
bidAmountnumber FOR AUCTION DRAFTS ONLY: How much the winning bid was
nominatingTeamIdnumber FOR AUCTION DRAFTS ONLY: The teamId of the fantasy team that nominatied the player. Use
Client#getTeamAtWeekto access fantasy team data. -
Properties:
Name Type Description dateDate The date of the draft.
typeDRAFT_TYPE The type of draft.
timePerPicknumber The amount of time to make a selection.
canTradeDraftPicksboolean Whether or not draft picks can be traded.
currentMatchupPeriodIdnumber The current matchup period id (see README.md for matchupPeriod v. scoringPeriod)
currentScoringPeriodIdnumber The current scoring period id (see README.md for matchupPeriod v. scoringPeriod)
-
FreeAgentPlayerMap PlayerMap
-
Properties:
Name Type Description rawStatsPlayerStats The PlayerStats model with the raw statistics registered by the player over the season.
projectedRawStatsPlayerStats The PlayerStats model with the raw statistics projected by the player over the season.
-
All possible injury statuses for a Player returned by the API
-
The different types in which keeper order can be determined.
-
Properties:
Name Type Description namestring The name of the league.
sizenumber The number of teams in the league.
isPublicboolean Whether or not the league is publically visible and accessible.
draftSettingsDraftSettings The draft settings of the league.
rosterSettingsRosterSettings The roster settings of the league.
scheduleSettingsScheduleSettings The schedule settings of the league.
scoringSettingsobject The scoring settings of the league.
-
All possible times at which a starting lineup may be locked and no further changes may be made.
-
All possible types of player moves.
-
All possible tiebreakers for a matchup.
-
Properties:
Name Type Description startTimeDate The date and time when the game starts in Eastern Time.
quarternumber The quarter the game is in.
clockstring The current game clock formatted as MM:SS.
oddsstring The odds for the game formatted as "TEAM_ABBREV LINE". NOTE: These may only display for the current week.
broadcasterstring Who is broadcasting the game on TV.
gameStatusstring Whether or not the game has not started, is in progress, or has finished.
homeTeamNFLTeam The home team in the game.
awayTeamNFLTeam The away team in the game.
-
Properties:
Name Type Description idnumber The id of the NFL team in the ESPN universe.
teamstring The name of the NFL team.
teamAbbrevstring The name abbreviation of the NFL team.
recordstring The win/loss/tie record of the NFL team.
scorenumber The score of the NFL team in the game.
-
The status of a player for fantasy rostering purposes.
-
All possible types of player moves.
-
Properties:
Name Type Description idnumber The id of the player in the ESPN universe.
firstNamestring The first name of the player.
lastNamestring The last name of the player.
fullNamestring The full name of the player.
jerseyNumbernumber The jersey number the player wears.
proTeamstring The NFL team the player is rostered on.
proTeamAbbreviationstring The NFL team abbreviation the player is rostered on.
defaultPositionstring The default position in a fantasy roster for the player.
eligiblePositionsArray.<string> A list of the eligible positions in a fantasy roster the player may be slotted in.
averageDraftPositionnumber The average position the player was drafted at in ESPN snake drafts.
averageAuctionValuenumber The average auction price the player fetched in ESPN auction drafts.
percentChangenumber The change in player ownership percentage in the last week across all ESPN leagues.
percentStartednumber The percentage of ESPN league in which this player is/was started.
percentOwnednumber The percentage of ESPN leagues in which this player is owned.
acquiredDateDate The datetime the player was acquired by their current fantasy team.
availabilityStatusPLAYER_AVAILABILITY_STATUSES The fantasy roster status of the player.
isDroppableboolean Whether or not the player can be dropped from a team.
isInjuredboolean Whether or not the player is injured.
injuryStatusINJURY_STATUSES The specific injury status/timeline of the player.
-
The rule by which playoff seeds are determined.
-
Properties:
Name Type Description lineupPositionCountobject How many slots of each position are in a starting lineup. Key is position; value is count.
positionLimitsobject The maximum number of players that may be rostered of each position. Key is position; value is count.
locktimeLINEUP_LOCK_TIMES When the starting lineup for a roster locks.
-
Properties:
Name Type Description numberOfRegularSeasonMatchupsnumber The number of regular season matchups a team will have on the schedule.
regularSeasonMatchupLengthnumber How many weeks each regular season matchup lasts.
numberOfPlayoffMatchupsnumber The number of playoff matchups a team will have on the schedule.
playoffMatchupLengthnumber How many weeks each playoff matchup lasts.
numberOfPlayoffTeamsnumber The number of playoff teams there will be.
-
scoringItemToIdandscoringIdToItemmap between numerical ids and human-readable attribute names. While some attributes are straight-forward (yards, attempts, completions, etc.), some attributes are niche items such as ranges.Scoring items that are not configured or enabled in a league's settings may still be populated on API responses.
There are several scoring categories scoring all have "per increment" scoring, i.e. points for every
yards gained. The typically scoring pattern is something like 0.1 point per 1 yard. The point per 1 yard attribute does not include the "Per1Yard" suffix; only attributes like "Per5Yards" have the matching suffix. "Per5Yards" scoring means that 5 total yards gained is given 1 point, 9 total yards gained would be given 1 point, and 10 total yards gained given 2 points. Passing scoring items are typically only present for QBs, but position players (like RBs, WRs, TEs) will occasionally make a passing play as well.
Defensive yards allowed and points allowed are inclusive and only scored when their condition is met. For example, if a DST allowed 360 yards, then
defensive350To399YardsAllowedwill be scored (value is 1 when statistical) and the other defensive yard stats will not be populated.Properties:
Name Type Description passingAttemptsnumber Total passing attempts.
passingYardsnumber Total passing yards.
passingCompletionsnumber Total passing completions.
passingIncompletionsnumber Total passing incompletions.
passingCompletionPercentagenumber Passing completions divided by passing attempts. This value is 0-100.
passingFirstDownsnumber Total passes resulting in first downs.
passingTouchdownsnumber Total passing TDs.
passing2PtConversionnumber Total passing 2 point conversion.
passingInterceptionsnumber Total passing attempts resulting in an interception (typically negative points).
sackednumber Total times the passer is sacked.
passingYardsPer5Yardsnumber Passing yards scored in 5 yard increments. See summary note for more detail.
passingYardsPer10Yardsnumber Passing yards scored in 10 yard increments. See summary note for more.
passingYardsPer20Yardsnumber Passing yards scored in 20 yard increments. See summary note for more.
passingYardsPer25Yardsnumber Passing yards scored in 25 yard increments. See summary note for more.
passingYardsPer50Yardsnumber Passing yards scored in 50 yard increments. See summary note for more.
passingYardsPer100Yardsnumber Passing yards scored in 100 yard increments. See summary note for more.
passingCompletionsPer5Completionsnumber Passing completions scored in 5 completion increments. See summary note for more.
passingCompletionsPer10Completionsnumber Passing completions scored in 10 completion increments. See summary note for more.
passingIncompletionsPer5Incompletionsnumber Passing incompletions scored in 5 incompletion increments. See summary note for more.
passingIncompletionsPer10Incompletionsnumber Passing incompletions scored in 10 incompletion increments. See summary note for more.
passingYards300To399number If the player threw for 300-399 yards in the game.
passingYards400Plusnumber If the player threw for 400+ yards in the game.
passingTouchdowns40Plusnumber Total number of passing touchdowns where the passing touchdown play was 40 yards or more.
passingTouchdowns50Plusnumber Total number of passing touchdowns where the passing touchdown play was 50 yards or more.
rushingAttemptsnumber Total rushing attempts.
rushingYardsnumber Total rushing yards.
rushingYardsPerAttemptnumber Rushing yards divided by rushing attempts.
rushingFirstDownsnumber Total rushes resulting in first downs.
rushingTouchdownsnumber Total rushing touchdowns.
rushing2PtConversionsnumber Total rushing 2 point conversions.
rushingYardsPer5Yardsnumber Rushing yards scored in 5 yard increments. See summary note for more.
rushingYardsPer10Yardsnumber Rushing yards scored in 10 yard increments. See summary note for more.
rushingYardsPer20Yardsnumber Rushing yards scored in 20 yard increments. See summary note for more.
rushingYardsPer25Yardsnumber Rushing yards scored in 25 yard increments. See summary note for more.
rushingYardsPer50Yardsnumber Rushing yards scored in 50 yard increments. See summary note for more.
rushingYardsPer100Yardsnumber Rushing yards scored in 100 yard increments. See summary note for more.
rushingAttemptsPer5Attemptsnumber Rushing attempts scored in 5 attempt increments. See summary note for more.
rushingAttemptsPer10Attemptsnumber Rushing attempts scored in 10 attempt increments. See summary note for more.
rushingTouchdowns40Plusnumber Total number of rushing touchdowns where the rushing touchdown play was 40 yards or more.
rushingTouchdowns50Plusnumber Total number of rushing touchdowns where the rushing touchdown play was 50 yards or more.
rushingGame100To199Yardsnumber Scored if the player rushes for 100-199 yards in a NFL game.
rushingGame200PlusYardsnumber Scored if the player rushes for 200+ yards in a NFL game.
receivingTargetsnumber Total times the player was targeted on a pass, regardless if the pass was completed.
receivingReceptionsnumber Total receptions (only populated in PPR leagues).
receivingYardsnumber Total receiving yards.
receivingFirstDownsnumber Total catches resulting in first downs.
receivingTouchdownsnumber Total receiving touchdowns.
receivingYardsAfterCatchnumber Total yards gained by the player after passes were caught.
receivingYardsPerReceptionnumber Total yards divided by receptions.
receiving2PtConversionsnumber Total receiving 2 point conversions.
receivingYardsPer5Yardsnumber Receiving yards scored in 5 yard increments. See summary note for more.
receivingYardsPer10Yardsnumber Receiving yards scored in 10 yard increments. See summary note for more.
receivingYardsPer20Yardsnumber Receiving yards scored in 20 yard increments. See summary note for more.
receivingYardsPer25Yardsnumber Receiving yards scored in 25 yard increments. See summary note for more.
receivingYardsPer50Yardsnumber Receiving yards scored in 50 yard increments. See summary note for more.
receivingYardsPer100Yardsnumber Receiving yards scored in 100 yard increments. See summary note for more.
receptionsPer5Receptionsnumber Receptions scored in 5 reception increments. See summary note for more.
receptionsPer10Receptionsnumber Receptions scored in 10 reception increments. See summary note for more.
receivingTouchdowns40Plusnumber Total number of receiving touchdowns where the receiving touchdown play was 40 yards or more.
receivingTouchdowns50Plusnumber Total number of receiving touchdowns where the receiving touchdown play was 50 yards or more.
receivingGame100To199Yardsnumber Scored if the player catches for 100-199 yards in a NFL game.
receivingGame200PlusYardsnumber Scored if the player catches for 200+ yards in a NFL game.)
fumblesnumber Total fumbles, regardless of whether the fumble was recovered by the opposing team (i.e "lost") or not
lostFumblesnumber Total fumbles lost (typically negative points) (applies to all offensive players).
totalTurnoversnumber Total turnovers (typically fumbles and interceptions, possibly safeties and downs as well?)
madeFieldGoalsnumber Made field goal attempts (any distance).
attemptedFieldGoalsnumber Total field goal attempts (any distance).
missedFieldGoalsnumber Missed field goal attempts (any distance) (typically negative points).
madeFieldGoalsFrom60Plusnumber Total made field goals from 60 yards or further.
madeFieldGoalsFrom50Plusnumber Total made field goals from 50 yards or further.
madeFieldGoalsFrom50To59number Total made field goals from 50 yards to 59 yards.
madeFieldGoalsFrom40To49number Total made field goals from 40 yards to 49 yards.
madeFieldGoalsFromUnder40number Total made field goals from under 40 yards.
attemptedFieldGoalsFrom60Plusnumber Total attempted field goals from 60 yards or further.
attemptedFieldGoalsFrom50Plusnumber Total attempted field goals from 50 yards or further.
attemptedFieldGoalsFrom50To59number Total attempted field goals from 50 yards to 59 yards.
attemptedFieldGoalsFrom40To49number Total attempted field goals from 40 yards to 49 yards.
attemptedFieldGoalsFromUnder40number Total attempted field goals from under 40 yards.
missedFieldGoalsFrom60Plusnumber Total missed field goals from 60 yards or further (typically negative or zero points).
missedFieldGoalsFrom50Plusnumber Total missed field goals from 50 yards or further (typically negative or zero points).
missedFieldGoalsFrom50To59number Total missed field goals from 50 yards to 59 yards (typically negative or zero points).
missedFieldGoalsFrom40To49number Total missed field goals from 40 yards to 49 yards (typically negative or zero points).
missedFieldGoalsFromUnder40number Total missed field goals from under 40 yards (typically negative or zero points).
fieldGoalMadeYardsnumber The total yards in distance of all made field goals scored in 1 yard increments.
fieldGoalMadeYardsPer5Yardsnumber The total yards in distance of all made field goals scored in 5 yard increments.
fieldGoalMadeYardsPer10Yardsnumber The total yards in distance of all made field goals scored in 10 yard increments.
fieldGoalMadeYardsPer20Yardsnumber The total yards in distance of all made field goals scored in 20 yard increments.
fieldGoalMadeYardsPer25Yardsnumber The total yards in distance of all made field goals scored in 25 yard increments.
fieldGoalMadeYardsPer50Yardsnumber The total yards in distance of all made field goals scored in 50 yard increments.
fieldGoalMadeYardsPer100Yardsnumber The total yards in distance of all made field goals scored in 100 yard increments.
fieldGoalMissedYardsnumber The total yards in distance of all missed field goals scored in 1 yard increments.
fieldGoalMissedYardsPer5Yardsnumber The total yards in distance of all missed field goals scored in 5 yard increments.
fieldGoalMissedYardsPer10Yardsnumber The total yards in distance of all missed field goals scored in 10 yard increments.
fieldGoalMissedYardsPer20Yardsnumber The total yards in distance of all missed field goals scored in 20 yard increments.
fieldGoalMissedYardsPer25Yardsnumber The total yards in distance of all missed field goals scored in 25 yard increments.
fieldGoalMissedYardsPer50Yardsnumber The total yards in distance of all missed field goals scored in 50 yard increments.
fieldGoalMissedYardsPer100Yardsnumber The total yards in distance of all missed field goals scored in 100 yard increments.
fieldGoalAttemptedYardsnumber The total yards in distance of all attempted field goals scored in 1 yard increments.
fieldGoalAttemptedYardsPer5Yardsnumber The total yards in distance of all attempted field goals scored in 5 yard increments.
fieldGoalAttemptedYardsPer10Yardsnumber The total yards in distance of all attempted field goals scored in 10 yard increments.
fieldGoalAttemptedYardsPer20Yardsnumber The total yards in distance of all attempted field goals scored in 20 yard increments.
fieldGoalAttemptedYardsPer25Yardsnumber The total yards in distance of all attempted field goals scored in 25 yard increments.
fieldGoalAttemptedYardsPer50Yardsnumber The total yards in distance of all attempted field goals scored in 50 yard increments.
fieldGoalAttemptedYardsPer100Yardsnumber The total yards in distance of all attempted field goals scored in 100 yard increments.
madeExtraPointsnumber Made extra point attempts.
attemptedExtraPointsnumber Total extra point attempts.
missedExtraPointsnumber Missed extra point attempts (typically negative points).
defensiveBlockedKickForTouchdownsnumber When a DST blocks any kick and returns it for a touchdown.
defensiveInterceptionsnumber When a DST records an interception.
defensiveFumblesnumber When a DST recovers a fumble.
defensiveBlockedKicksnumber When a DST blocks any kick.
defensiveSafetiesnumber When a DST records a safety.
defensiveSacksnumber When a DST records a sack.
defensiveHalfSacksnumber When a DST records an half sack. Like an assist for sacks.
kickoffReturnTouchdownnumber When a DST returns a kickoff for a touchdown.
puntReturnTouchdownnumber When a DST returns a punt for a touchdown.
fumbleReturnTouchdownnumber When a DST returns a fumble for a touchdown.
interceptionReturnTouchdownnumber When a DST returns an interception for a touchdown.
totalReturnTouchdownsnumber Total times a DST returns a kick, punt, fumble, or interception for a touchdown.
kickoffReturnYardsnumber Total yards on kickoff returns.
puntReturnYardsnumber Total yards on punt returns.
kickoffReturnYardsPer10Yardsnumber Kickoff return yards scored in 10 yard increments.
kickoffReturnYardsPer25Yardsnumber Kickoff return yards scored in 25 yard increments.
puntReturnYardsPer10Yardsnumber Punt return yards scored in 10 yard increments.
puntReturnYardsPer25Yardsnumber Punt return yards scored in 25 yard increments.
defensiveForcedFumblesnumber No description
defensiveAssistedTacklesnumber No description
defensiveSoloTacklesnumber No description
defensiveTotalTacklesnumber No description
defensiveTacklesPer3Tacklesnumber No description
defensiveTacklesPer5Tacklesnumber No description
defensiveStuffsnumber No description
defensivePointsAllowednumber Total points allowed by the defense in the NFL game (real points allowed, not fantasy points).
defensive0PointsAllowednumber When a DST allowed 0 points in their NFL game.
defensive1To6PointsAllowednumber When a DST allowed 1-6 points in their NFL game.
defensive7To13PointsAllowednumber When a DST allowed 7-13 points in their NFL game.
defensive14To17PointsAllowednumber When a DST allowed 14-17 points in their NFL game.
defensive18To21PointsAllowednumber When a DST allows 18-21 points in their NFL game.
defensive22To27PointsAllowednumber When a DST allows 22-27 points in their NFL game.
defensive28To34PointsAllowednumber When a DST allows 28-34 points in their NFL game.
defensive35To45PointsAllowednumber When a DST allows 35-45 points in their NFL game.
defensiveOver45PointsAllowednumber When a DST allows more than 45 points in their NFL game.
defensiveYardsAllowednumber Total yards allowed by a DST.
defensiveLessThan100YardsAllowednumber When a DST allows less than 100 yards in their NFL game.
defensive100To199YardsAllowednumber When a DST allows 100-199 yards in their NFL game.
defensive200To299YardsAllowednumber When a DST allows 200-299 yards in their NFL game.
defensive350To399YardsAllowednumber When a DST allows 350-399 yards in their NFL game.
defensive400To449YardsAllowednumber When a DST allows 400-449 yards in their NFL game.
defensive450To499YardsAllowednumber When a DST allows 450-499 yards in their NFL game.
defensive500To549YardsAllowednumber When a DST allows 500-549 yards in their NFL game.
defensiveOver550YardsAllowednumber When a DST allows 550 or more yards in their NFL game.
teamWinnumber Scored when the NFL player's team wins their NFL game.
teamLossnumber Scored when the NFL player's team loses their NFL game.
teamTienumber Scored when the NFL player's team ties their NFL game.
teamPointsScorednumber Fantasy points awarded based on the total point sscored by a player's team in their NFL game.
teamWinMargin25Plusnumber Scored when a player's NFL team wins their NFL games by 25 or more points.
teamWinMargin20To24number Scored when a player's NFL team wins their NFL games by 20-24 points.
teamWinMargin15To19number Scored when a player's NFL team wins their NFL games by 15-19 points.
teamWinMargin10To14number Scored when a player's NFL team wins their NFL games by 10-14 points.
teamWinMargin5To9number Scored when a player's NFL team wins their NFL games by 5-9 points.
teamWinMargin1To4number Scored when a player's NFL team wins their NFL games by 1-4 points.
teamLossMargin25Plusnumber Scored when a player's NFL team loses their NFL games by 25 or more points.
teamLossMargin20To24number Scored when a player's NFL team loses their NFL games by 20-24 points.
teamLossMargin15To19number Scored when a player's NFL team loses their NFL games by 15-19 points.
teamLossMargin10To14number Scored when a player's NFL team loses their NFL games by 10-14 points.
teamLossMargin5To9number Scored when a player's NFL team loses their NFL games by 5-9 points.
teamLossMargin1To4number Scored when a player's NFL team loses their NFL games by 1-4 points.
netPuntsnumber No description.
puntYardsnumber No description.
puntsInsideThe10number Total number of punts ending inside the opponent's 10 yard line.
puntsInsideThe20number Total number of punts ending inside the opponent's 20 yard line.
fairCatchesnumber lol
-
Properties:
Name Type Description idnumber The id of the team in the ESPN universe.
abbreviationstring The team's abbreviation.
namestring The team's name.
ownerNamestring The team's primary owner's name
logoURLstring The URL for the team's uploaded logo.
wavierRanknumber The team's position in the current wavier order.
rosterArray.<Player> The team's roster of players.
winsnumber The number of regular season match-ups the team has won.
lossesnumber The number of regular season match-ups the team has lost.
tiesnumber The number of regular season match-ups the team has tied.
divisionWinsnumber The number of regular season match-ups the team has won in the division.
divisionLossesnumber The number of regular season match-ups the team has lost in the division.
divisionTiesnumber The number of regular season match-ups the team has tied in the division.
homeWinsnumber The number of regular season match-ups the team has won at home.
homeLossesnumber The number of regular season match-ups the team has lost at home.
homeTiesnumber The number of regular season match-ups the team has tied at home.
awayWinsnumber The number of regular season match-ups the team has won away.
awayLossesnumber The number of regular season match-ups the team has lost away.
awayTiesnumber The number of regular season match-ups the team has tied away.
totalPointsScorednumber The total points scored by the team in the regular season and playoffs combined.
regularSeasonPointsFornumber The total points scored by the team in the regular season.
regularSeasonPointsAgainstnumber The total points scored against the team in the regular season.
winningPercentagenumber The percentage of games won by the team in the regular season.
playoffSeednumber The seeding for the team entering the playoffs.
finalStandingsPositionnumber The final standings position the team ended the season in.
-
All possible types of transactions.
-
Which team won a matchup.