Skip to content

janerikcarlsen/fpl-cli

Repository files navigation

Build Status Python Versions Downloads

fpl-cli

fpl-cli is a command line tool for Fantasy Premier League, written in Python. The tool gets its data from the official Fantasy Premier League API, and currently supports the following actions:

fpl                     Returns help menu
fpl configure           Set up team_id (required)
fpl points              Returns live points for a team
fpl leagues             Returns all leagues for a team entry
fpl league <id>         Returns confirmed scores for a league by id
fpl liveleague <id>     Returns live scores for a league by id
fpl entry               Returns information about a team entry
fpl players             Returns all players in the game, sorted by total score

Installing

fpl-cli has been tested with Python versions 2.7, 3.4, 3.5, 3.6 and 3.7 on Mac and Linux, and with 3.6 and 3.7 on Windows.

In a terminal window, verify that Python and pip is available:

python --version
pip --version

If no Python/pip version is found, download Python and pip before proceeding

pip install fplcli

Using fpl-cli

Configure fpl-cli

Start using fpl-cli by telling it your team_id. You can find your team_id by going to the Points tab at https://fantasy.premierleague.com and find the number in between team/ and event/ in the url.

fpl configure

Get help

Get an overview of the allowed actions by typing fpl or fpl --help

fpl help

Get current points total for team

The points total and player score is updated during games based on live score data, including provisional bonus points.

fpl points

Get all leagues the team is member of

Returns all leagues you participate in (Head 2 Head leagues not included yet)

fpl leagues

Get live league standings

Returns live league standings for a single league, where all teams score are updated in real time based on live score data. Shows live league rank, captain, gameweek score, chips played and transfer info

fpl liveleague

Get league standings

Returns confirmed league standings for a single league. You find the league_id in the leftmost Id column in the fpl leagues result

fpl league

Planned features

  • Include H2H leagues in leagues view
  • Actions that require authentication with the FPL API (Making transfers, prepare team for next Gameweek)
  • Player sorting/filtering and enriched player staticstics
  • Cache API calls to improve response times

Ideas for features or enhancements that you would like to see from fpl-cli are welcome. Please post an issue in the GitHub repository, or even better, check out the Contributing guidelines and submit a Pull Request with the suggested change.