espn-api Python Library

You can install the package via pip or by cloning the repository. For Python versions >= 3.9, it is recommended to use the requirementsV2.txt file and pytest instead of setup.py and nosetests.

# Using pip (Recommended)
pip install espn_api

# Using Git and Requirements.txt (Recommended for Python >= 3.9)
git clone https://github.com/cwendt94/espn-api
cd espn-api
python -m venv myenv
# On Windows:
myenv\Scripts\activate.bat
# On Unix/macOS:
source myenv/bin/activate
pip install -r requirementsV2.txt

To interact with an ESPN Fantasy league, import the League class from the specific sport module (football, basketball, hockey, or baseball) and initialize it with a league_id and year.

Note: As of the current version, Hockey and Baseball support are in development.

# Football API
from espn_api.football import League

# Basketball API
from espn_api.basketball import League

# Hockey API
from espn_api.hockey import League

# Baseball API
from espn_api.baseball import League

# Initialize the league
league = League(league_id=222, year=2019)

If you are developing or testing the package, use pytest for Python versions >= 3.9. For older versions, you can use nosetests via setup.py.

# Recommended for Python >= 3.9
pytest

# Not recommended for Python >= 3.9
python3 setup.py nosetests

When reporting bugs, you can enable debug mode by passing debug=True to the League constructor. This will print all requests and responses from ESPN's API to the console. It is recommended to pipe this output to a text file due to the high volume of data.

# Enable debug mode to see raw API traffic
league = League(league_id=1245, year=2019, debug=True)