Members
-
Maps
proTeam
numerical enum to readable team names. -
Maps
proTeam
numerical 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 homeScore
number The total points scored by the home team.
homeProjectedScore
number The projected total points scored by the home team. NOTE: This field is only populated in the boxscore for the current matchup period!
homeTeamId
number The home team's id. Can be used to load a cached Team.
homeRoster
Array.<BoxscorePlayer> The home team's roster, containing player info and stats.
awayScore
number The total points scored by the away team.
awayProjectedScore
number The projected total points scored by the away team. NOTE: This field is only populated in the boxscore for the current matchup period!
awayTeamId
number The away team's id. Can be used to load a cached Team.
awayRoster
Array.<BoxscorePlayer> The away team's roster, containing player info and stats.
-
BoxscorePlayerMap PlayerMap
-
Properties:
Name Type Description player
Player The player model representing the NFL player.
rosteredPosition
string The position the player is slotted at in the fantasy lineup
totalPoints
number The total points scored by the player.
pointBreakdown
PlayerStats The PlayerStats model with the points scored by the player.
rawStats
PlayerStats The PlayerStats model with the raw statistics registered by the player.
-
All possible draft types for a league.
-
DraftPlayerMap PlayerMap
-
Properties:
Name Type Description id
number The id of the player in the ESPN universe.
teamId
number The teamId of the fantasy team that drafted the player. Use
Client#getTeamAtWeek
to access fantasy team data.overallPickNumber
number The overall pick number
roundNumber
number The round in which the pick occurred
roundPickNumber
number The pick number inside the round
isKeeper
boolean FOR KEEPER DRAFTS ONLY: Whether or not the "drafted" player is a keeper pick
bidAmount
number FOR AUCTION DRAFTS ONLY: How much the winning bid was
nominatingTeamId
number FOR AUCTION DRAFTS ONLY: The teamId of the fantasy team that nominatied the player. Use
Client#getTeamAtWeek
to access fantasy team data. -
Properties:
Name Type Description date
Date The date of the draft.
type
DRAFT_TYPE The type of draft.
timePerPick
number The amount of time to make a selection.
canTradeDraftPicks
boolean Whether or not draft picks can be traded.
currentMatchupPeriodId
number The current matchup period id (see README.md for matchupPeriod v. scoringPeriod)
currentScoringPeriodId
number The current scoring period id (see README.md for matchupPeriod v. scoringPeriod)
-
FreeAgentPlayerMap PlayerMap
-
Properties:
Name Type Description rawStats
PlayerStats The PlayerStats model with the raw statistics registered by the player over the season.
projectedRawStats
PlayerStats 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 name
string The name of the league.
size
number The number of teams in the league.
isPublic
boolean Whether or not the league is publically visible and accessible.
draftSettings
DraftSettings The draft settings of the league.
rosterSettings
RosterSettings The roster settings of the league.
scheduleSettings
ScheduleSettings The schedule settings of the league.
scoringSettings
object 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 startTime
Date The date and time when the game starts in Eastern Time.
quarter
number The quarter the game is in.
clock
string The current game clock formatted as MM:SS.
odds
string The odds for the game formatted as "TEAM_ABBREV LINE". NOTE: These may only display for the current week.
broadcaster
string Who is broadcasting the game on TV.
gameStatus
string Whether or not the game has not started, is in progress, or has finished.
homeTeam
NFLTeam The home team in the game.
awayTeam
NFLTeam The away team in the game.
-
Properties:
Name Type Description id
number The id of the NFL team in the ESPN universe.
team
string The name of the NFL team.
teamAbbrev
string The name abbreviation of the NFL team.
record
string The win/loss/tie record of the NFL team.
score
number 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 id
number The id of the player in the ESPN universe.
firstName
string The first name of the player.
lastName
string The last name of the player.
fullName
string The full name of the player.
jerseyNumber
number The jersey number the player wears.
proTeam
string The NFL team the player is rostered on.
proTeamAbbreviation
string The NFL team abbreviation the player is rostered on.
defaultPosition
string The default position in a fantasy roster for the player.
eligiblePositions
Array.<string> A list of the eligible positions in a fantasy roster the player may be slotted in.
averageDraftPosition
number The average position the player was drafted at in ESPN snake drafts.
averageAuctionValue
number The average auction price the player fetched in ESPN auction drafts.
percentChange
number The change in player ownership percentage in the last week across all ESPN leagues.
percentStarted
number The percentage of ESPN league in which this player is/was started.
percentOwned
number The percentage of ESPN leagues in which this player is owned.
acquiredDate
Date The datetime the player was acquired by their current fantasy team.
availabilityStatus
PLAYER_AVAILABILITY_STATUSES The fantasy roster status of the player.
isDroppable
boolean Whether or not the player can be dropped from a team.
isInjured
boolean Whether or not the player is injured.
injuryStatus
INJURY_STATUSES The specific injury status/timeline of the player.
-
The rule by which playoff seeds are determined.
-
Properties:
Name Type Description lineupPositionCount
object How many slots of each position are in a starting lineup. Key is position; value is count.
positionLimits
object The maximum number of players that may be rostered of each position. Key is position; value is count.
locktime
LINEUP_LOCK_TIMES When the starting lineup for a roster locks.
-
Properties:
Name Type Description numberOfRegularSeasonMatchups
number The number of regular season matchups a team will have on the schedule.
regularSeasonMatchupLength
number How many weeks each regular season matchup lasts.
numberOfPlayoffMatchups
number The number of playoff matchups a team will have on the schedule.
playoffMatchupLength
number How many weeks each playoff matchup lasts.
numberOfPlayoffTeams
number The number of playoff teams there will be.
-
scoringItemToId
andscoringIdToItem
map 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
defensive350To399YardsAllowed
will be scored (value is 1 when statistical) and the other defensive yard stats will not be populated.Properties:
Name Type Description passingAttempts
number Total passing attempts.
passingYards
number Total passing yards.
passingCompletions
number Total passing completions.
passingIncompletions
number Total passing incompletions.
passingCompletionPercentage
number Passing completions divided by passing attempts. This value is 0-100.
passingFirstDowns
number Total passes resulting in first downs.
passingTouchdowns
number Total passing TDs.
passing2PtConversion
number Total passing 2 point conversion.
passingInterceptions
number Total passing attempts resulting in an interception (typically negative points).
sacked
number Total times the passer is sacked.
passingYardsPer5Yards
number Passing yards scored in 5 yard increments. See summary note for more detail.
passingYardsPer10Yards
number Passing yards scored in 10 yard increments. See summary note for more.
passingYardsPer20Yards
number Passing yards scored in 20 yard increments. See summary note for more.
passingYardsPer25Yards
number Passing yards scored in 25 yard increments. See summary note for more.
passingYardsPer50Yards
number Passing yards scored in 50 yard increments. See summary note for more.
passingYardsPer100Yards
number Passing yards scored in 100 yard increments. See summary note for more.
passingCompletionsPer5Completions
number Passing completions scored in 5 completion increments. See summary note for more.
passingCompletionsPer10Completions
number Passing completions scored in 10 completion increments. See summary note for more.
passingIncompletionsPer5Incompletions
number Passing incompletions scored in 5 incompletion increments. See summary note for more.
passingIncompletionsPer10Incompletions
number Passing incompletions scored in 10 incompletion increments. See summary note for more.
passingYards300To399
number If the player threw for 300-399 yards in the game.
passingYards400Plus
number If the player threw for 400+ yards in the game.
passingTouchdowns40Plus
number Total number of passing touchdowns where the passing touchdown play was 40 yards or more.
passingTouchdowns50Plus
number Total number of passing touchdowns where the passing touchdown play was 50 yards or more.
rushingAttempts
number Total rushing attempts.
rushingYards
number Total rushing yards.
rushingYardsPerAttempt
number Rushing yards divided by rushing attempts.
rushingFirstDowns
number Total rushes resulting in first downs.
rushingTouchdowns
number Total rushing touchdowns.
rushing2PtConversions
number Total rushing 2 point conversions.
rushingYardsPer5Yards
number Rushing yards scored in 5 yard increments. See summary note for more.
rushingYardsPer10Yards
number Rushing yards scored in 10 yard increments. See summary note for more.
rushingYardsPer20Yards
number Rushing yards scored in 20 yard increments. See summary note for more.
rushingYardsPer25Yards
number Rushing yards scored in 25 yard increments. See summary note for more.
rushingYardsPer50Yards
number Rushing yards scored in 50 yard increments. See summary note for more.
rushingYardsPer100Yards
number Rushing yards scored in 100 yard increments. See summary note for more.
rushingAttemptsPer5Attempts
number Rushing attempts scored in 5 attempt increments. See summary note for more.
rushingAttemptsPer10Attempts
number Rushing attempts scored in 10 attempt increments. See summary note for more.
rushingTouchdowns40Plus
number Total number of rushing touchdowns where the rushing touchdown play was 40 yards or more.
rushingTouchdowns50Plus
number Total number of rushing touchdowns where the rushing touchdown play was 50 yards or more.
rushingGame100To199Yards
number Scored if the player rushes for 100-199 yards in a NFL game.
rushingGame200PlusYards
number Scored if the player rushes for 200+ yards in a NFL game.
receivingTargets
number Total times the player was targeted on a pass, regardless if the pass was completed.
receivingReceptions
number Total receptions (only populated in PPR leagues).
receivingYards
number Total receiving yards.
receivingFirstDowns
number Total catches resulting in first downs.
receivingTouchdowns
number Total receiving touchdowns.
receivingYardsAfterCatch
number Total yards gained by the player after passes were caught.
receivingYardsPerReception
number Total yards divided by receptions.
receiving2PtConversions
number Total receiving 2 point conversions.
receivingYardsPer5Yards
number Receiving yards scored in 5 yard increments. See summary note for more.
receivingYardsPer10Yards
number Receiving yards scored in 10 yard increments. See summary note for more.
receivingYardsPer20Yards
number Receiving yards scored in 20 yard increments. See summary note for more.
receivingYardsPer25Yards
number Receiving yards scored in 25 yard increments. See summary note for more.
receivingYardsPer50Yards
number Receiving yards scored in 50 yard increments. See summary note for more.
receivingYardsPer100Yards
number Receiving yards scored in 100 yard increments. See summary note for more.
receptionsPer5Receptions
number Receptions scored in 5 reception increments. See summary note for more.
receptionsPer10Receptions
number Receptions scored in 10 reception increments. See summary note for more.
receivingTouchdowns40Plus
number Total number of receiving touchdowns where the receiving touchdown play was 40 yards or more.
receivingTouchdowns50Plus
number Total number of receiving touchdowns where the receiving touchdown play was 50 yards or more.
receivingGame100To199Yards
number Scored if the player catches for 100-199 yards in a NFL game.
receivingGame200PlusYards
number Scored if the player catches for 200+ yards in a NFL game.)
fumbles
number Total fumbles, regardless of whether the fumble was recovered by the opposing team (i.e "lost") or not
lostFumbles
number Total fumbles lost (typically negative points) (applies to all offensive players).
totalTurnovers
number Total turnovers (typically fumbles and interceptions, possibly safeties and downs as well?)
madeFieldGoals
number Made field goal attempts (any distance).
attemptedFieldGoals
number Total field goal attempts (any distance).
missedFieldGoals
number Missed field goal attempts (any distance) (typically negative points).
madeFieldGoalsFrom60Plus
number Total made field goals from 60 yards or further.
madeFieldGoalsFrom50Plus
number Total made field goals from 50 yards or further.
madeFieldGoalsFrom50To59
number Total made field goals from 50 yards to 59 yards.
madeFieldGoalsFrom40To49
number Total made field goals from 40 yards to 49 yards.
madeFieldGoalsFromUnder40
number Total made field goals from under 40 yards.
attemptedFieldGoalsFrom60Plus
number Total attempted field goals from 60 yards or further.
attemptedFieldGoalsFrom50Plus
number Total attempted field goals from 50 yards or further.
attemptedFieldGoalsFrom50To59
number Total attempted field goals from 50 yards to 59 yards.
attemptedFieldGoalsFrom40To49
number Total attempted field goals from 40 yards to 49 yards.
attemptedFieldGoalsFromUnder40
number Total attempted field goals from under 40 yards.
missedFieldGoalsFrom60Plus
number Total missed field goals from 60 yards or further (typically negative or zero points).
missedFieldGoalsFrom50Plus
number Total missed field goals from 50 yards or further (typically negative or zero points).
missedFieldGoalsFrom50To59
number Total missed field goals from 50 yards to 59 yards (typically negative or zero points).
missedFieldGoalsFrom40To49
number Total missed field goals from 40 yards to 49 yards (typically negative or zero points).
missedFieldGoalsFromUnder40
number Total missed field goals from under 40 yards (typically negative or zero points).
fieldGoalMadeYards
number The total yards in distance of all made field goals scored in 1 yard increments.
fieldGoalMadeYardsPer5Yards
number The total yards in distance of all made field goals scored in 5 yard increments.
fieldGoalMadeYardsPer10Yards
number The total yards in distance of all made field goals scored in 10 yard increments.
fieldGoalMadeYardsPer20Yards
number The total yards in distance of all made field goals scored in 20 yard increments.
fieldGoalMadeYardsPer25Yards
number The total yards in distance of all made field goals scored in 25 yard increments.
fieldGoalMadeYardsPer50Yards
number The total yards in distance of all made field goals scored in 50 yard increments.
fieldGoalMadeYardsPer100Yards
number The total yards in distance of all made field goals scored in 100 yard increments.
fieldGoalMissedYards
number The total yards in distance of all missed field goals scored in 1 yard increments.
fieldGoalMissedYardsPer5Yards
number The total yards in distance of all missed field goals scored in 5 yard increments.
fieldGoalMissedYardsPer10Yards
number The total yards in distance of all missed field goals scored in 10 yard increments.
fieldGoalMissedYardsPer20Yards
number The total yards in distance of all missed field goals scored in 20 yard increments.
fieldGoalMissedYardsPer25Yards
number The total yards in distance of all missed field goals scored in 25 yard increments.
fieldGoalMissedYardsPer50Yards
number The total yards in distance of all missed field goals scored in 50 yard increments.
fieldGoalMissedYardsPer100Yards
number The total yards in distance of all missed field goals scored in 100 yard increments.
fieldGoalAttemptedYards
number The total yards in distance of all attempted field goals scored in 1 yard increments.
fieldGoalAttemptedYardsPer5Yards
number The total yards in distance of all attempted field goals scored in 5 yard increments.
fieldGoalAttemptedYardsPer10Yards
number The total yards in distance of all attempted field goals scored in 10 yard increments.
fieldGoalAttemptedYardsPer20Yards
number The total yards in distance of all attempted field goals scored in 20 yard increments.
fieldGoalAttemptedYardsPer25Yards
number The total yards in distance of all attempted field goals scored in 25 yard increments.
fieldGoalAttemptedYardsPer50Yards
number The total yards in distance of all attempted field goals scored in 50 yard increments.
fieldGoalAttemptedYardsPer100Yards
number The total yards in distance of all attempted field goals scored in 100 yard increments.
madeExtraPoints
number Made extra point attempts.
attemptedExtraPoints
number Total extra point attempts.
missedExtraPoints
number Missed extra point attempts (typically negative points).
defensiveBlockedKickForTouchdowns
number When a DST blocks any kick and returns it for a touchdown.
defensiveInterceptions
number When a DST records an interception.
defensiveFumbles
number When a DST recovers a fumble.
defensiveBlockedKicks
number When a DST blocks any kick.
defensiveSafeties
number When a DST records a safety.
defensiveSacks
number When a DST records a sack.
defensiveHalfSacks
number When a DST records an half sack. Like an assist for sacks.
kickoffReturnTouchdown
number When a DST returns a kickoff for a touchdown.
puntReturnTouchdown
number When a DST returns a punt for a touchdown.
fumbleReturnTouchdown
number When a DST returns a fumble for a touchdown.
interceptionReturnTouchdown
number When a DST returns an interception for a touchdown.
totalReturnTouchdowns
number Total times a DST returns a kick, punt, fumble, or interception for a touchdown.
kickoffReturnYards
number Total yards on kickoff returns.
puntReturnYards
number Total yards on punt returns.
kickoffReturnYardsPer10Yards
number Kickoff return yards scored in 10 yard increments.
kickoffReturnYardsPer25Yards
number Kickoff return yards scored in 25 yard increments.
puntReturnYardsPer10Yards
number Punt return yards scored in 10 yard increments.
puntReturnYardsPer25Yards
number Punt return yards scored in 25 yard increments.
defensiveForcedFumbles
number No description
defensiveAssistedTackles
number No description
defensiveSoloTackles
number No description
defensiveTotalTackles
number No description
defensiveTacklesPer3Tackles
number No description
defensiveTacklesPer5Tackles
number No description
defensiveStuffs
number No description
defensivePointsAllowed
number Total points allowed by the defense in the NFL game (real points allowed, not fantasy points).
defensive0PointsAllowed
number When a DST allowed 0 points in their NFL game.
defensive1To6PointsAllowed
number When a DST allowed 1-6 points in their NFL game.
defensive7To13PointsAllowed
number When a DST allowed 7-13 points in their NFL game.
defensive14To17PointsAllowed
number When a DST allowed 14-17 points in their NFL game.
defensive18To21PointsAllowed
number When a DST allows 18-21 points in their NFL game.
defensive22To27PointsAllowed
number When a DST allows 22-27 points in their NFL game.
defensive28To34PointsAllowed
number When a DST allows 28-34 points in their NFL game.
defensive35To45PointsAllowed
number When a DST allows 35-45 points in their NFL game.
defensiveOver45PointsAllowed
number When a DST allows more than 45 points in their NFL game.
defensiveYardsAllowed
number Total yards allowed by a DST.
defensiveLessThan100YardsAllowed
number When a DST allows less than 100 yards in their NFL game.
defensive100To199YardsAllowed
number When a DST allows 100-199 yards in their NFL game.
defensive200To299YardsAllowed
number When a DST allows 200-299 yards in their NFL game.
defensive350To399YardsAllowed
number When a DST allows 350-399 yards in their NFL game.
defensive400To449YardsAllowed
number When a DST allows 400-449 yards in their NFL game.
defensive450To499YardsAllowed
number When a DST allows 450-499 yards in their NFL game.
defensive500To549YardsAllowed
number When a DST allows 500-549 yards in their NFL game.
defensiveOver550YardsAllowed
number When a DST allows 550 or more yards in their NFL game.
teamWin
number Scored when the NFL player's team wins their NFL game.
teamLoss
number Scored when the NFL player's team loses their NFL game.
teamTie
number Scored when the NFL player's team ties their NFL game.
teamPointsScored
number Fantasy points awarded based on the total point sscored by a player's team in their NFL game.
teamWinMargin25Plus
number Scored when a player's NFL team wins their NFL games by 25 or more points.
teamWinMargin20To24
number Scored when a player's NFL team wins their NFL games by 20-24 points.
teamWinMargin15To19
number Scored when a player's NFL team wins their NFL games by 15-19 points.
teamWinMargin10To14
number Scored when a player's NFL team wins their NFL games by 10-14 points.
teamWinMargin5To9
number Scored when a player's NFL team wins their NFL games by 5-9 points.
teamWinMargin1To4
number Scored when a player's NFL team wins their NFL games by 1-4 points.
teamLossMargin25Plus
number Scored when a player's NFL team loses their NFL games by 25 or more points.
teamLossMargin20To24
number Scored when a player's NFL team loses their NFL games by 20-24 points.
teamLossMargin15To19
number Scored when a player's NFL team loses their NFL games by 15-19 points.
teamLossMargin10To14
number Scored when a player's NFL team loses their NFL games by 10-14 points.
teamLossMargin5To9
number Scored when a player's NFL team loses their NFL games by 5-9 points.
teamLossMargin1To4
number Scored when a player's NFL team loses their NFL games by 1-4 points.
netPunts
number No description.
puntYards
number No description.
puntsInsideThe10
number Total number of punts ending inside the opponent's 10 yard line.
puntsInsideThe20
number Total number of punts ending inside the opponent's 20 yard line.
fairCatches
number lol
-
Properties:
Name Type Description id
number The id of the team in the ESPN universe.
abbreviation
string The team's abbreviation.
name
string The team's name.
ownerName
string The team's primary owner's name
logoURL
string The URL for the team's uploaded logo.
wavierRank
number The team's position in the current wavier order.
roster
Array.<Player> The team's roster of players.
wins
number The number of regular season match-ups the team has won.
losses
number The number of regular season match-ups the team has lost.
ties
number The number of regular season match-ups the team has tied.
divisionWins
number The number of regular season match-ups the team has won in the division.
divisionLosses
number The number of regular season match-ups the team has lost in the division.
divisionTies
number The number of regular season match-ups the team has tied in the division.
homeWins
number The number of regular season match-ups the team has won at home.
homeLosses
number The number of regular season match-ups the team has lost at home.
homeTies
number The number of regular season match-ups the team has tied at home.
awayWins
number The number of regular season match-ups the team has won away.
awayLosses
number The number of regular season match-ups the team has lost away.
awayTies
number The number of regular season match-ups the team has tied away.
totalPointsScored
number The total points scored by the team in the regular season and playoffs combined.
regularSeasonPointsFor
number The total points scored by the team in the regular season.
regularSeasonPointsAgainst
number The total points scored against the team in the regular season.
winningPercentage
number The percentage of games won by the team in the regular season.
playoffSeed
number The seeding for the team entering the playoffs.
finalStandingsPosition
number The final standings position the team ended the season in.
-
All possible types of transactions.
-
Which team won a matchup.