How mkreiser/espn-fantasy-football-api works
This is a JavaScript client for retrieving ESPN Fantasy Football v3 data and mapping responses into usable objects. The primary workflow is: a consumer calls the Client with league and season parameters; the Client requests ESPN data and returns domain models such as teams, matchups, draft picks, and free agents. Models parse nested player and statistics data, with shared base classes providing response mapping and caching. The README also documents private-league support, which is Node-only. Some client methods and model details were not sampled, so only documented or indexed relationships are shown.
Main entry points: client.js Client · player.js NFL Player · base-object.js Response Mapper · player-stats.js Player Statistics
Components 16
Client and API
- Client
src/client/client.js
League Data
- League Settings
src/league/league.js - Fantasy Team
src/team/team.js - Matchup Boxscore
src/boxscore/boxscore.js - Boxscore Player
src/boxscore-player/boxscore-player.js - NFL Game
src/nfl-game/nfl-game.js
Player Data
- Draft Pick
src/draft-player/draft-player.js - Free Agent
src/free-agent-player/free-agent-player.js - NFL Player
src/player/player.js - Player Statistics
src/player-stats/player-stats.js
Mapping Foundation
- Response Mapper
src/base-classes/base-object/base-object.js - Cacheable Objects
src/base-classes/base-cacheable-object/base-cacheable-object.js - API Mappings
src/constants.js - Mapping Utility
src/utils.js
Other components
- API Consumer
- ESPN API
Connections 27
- API Consumer → Client: calls
README.md - Client → ESPN API: requests data
src/client/client.js - Client → Matchup Boxscore: builds matchups
src/client/client.js - Client → League Settings: builds league data
src/client/client.js - Client → Fantasy Team: builds teams
src/client/client.js - Client → Draft Pick: builds draft picks
src/client/client.js - Client → Free Agent: builds free agents
src/client/client.js - Client → NFL Game: builds game data
src/client/client.js - Matchup Boxscore → Boxscore Player: builds roster players
src/boxscore/boxscore.js - Boxscore Player → NFL Player: extends
src/boxscore-player/boxscore-player.js - Boxscore Player → Player Statistics: parses stats
src/boxscore-player/boxscore-player.js - Fantasy Team → NFL Player: builds roster
src/team/team.js - Draft Pick → NFL Player: extends
src/draft-player/draft-player.js - Draft Pick → Player Statistics: parses stats
src/draft-player/draft-player.js - Free Agent → NFL Player: uses player model
src/free-agent-player/free-agent-player.js - Free Agent → Player Statistics: uses stats parser
src/free-agent-player/free-agent-player.js - Cacheable Objects → Response Mapper: extends
src/base-classes/base-cacheable-object/base-cacheable-object.js - NFL Player → Cacheable Objects: extends
src/player/player.js - Fantasy Team → Cacheable Objects: extends
src/team/team.js - League Settings → Response Mapper: extends
src/league/league.js - Matchup Boxscore → Response Mapper: extends
src/boxscore/boxscore.js - NFL Game → Response Mapper: extends
src/nfl-game/nfl-game.js - Player Statistics → Response Mapper: extends
src/player-stats/player-stats.js - Response Mapper → Mapping Utility: flattens data
src/base-classes/base-object/base-object.js - NFL Player → API Mappings: maps identifiers
src/player/player.js - League Settings → API Mappings: maps settings
src/league/league.js - Player Statistics → API Mappings: maps scoring
src/player-stats/player-stats.js