FPL Wrapper - A Wrapper for the FPL API

Report a Bug · Request a Feature . Ask a Question

Table of Contents

• FPL API Endpoint Support Matrix
  • Usage Examples
  • Future Development
  • Hatch Environment:
  • Usage
    • Activating the Environment
    • Running the Application
      • Command Line
  • Development
    • Installing Dependencies
    • Linting & Formatting
  • Testing
• Documentation
  • Deployment
    • Building the Package
  • Contributing
  • License

FPL API Endpoint Support Matrix

This table provides an overview of the Fantasy Premier League API endpoints supported by the FPL Wrapper library.

Endpoint	Status	Method	Description	CLI Command
/bootstrap-static/	✅ Supported	get_bootstrap_data()	Retrieves static data including teams, players, game settings	N/A (internal use)
/fixtures/	✅ Supported	FixtureProvider.get_fixtures()	Retrieves all fixtures for the season	fpl_get_fixtures
/element-summary/{player_id}/	✅ Supported	Players.get_player_by_id()	Retrieves detailed data for a specific player	fpl_get_player --player_id ID
/elements/	✅ Supported	Players.get_all_player_detail()	Retrieves all player data	fpl_get_players
/entry/{team_id}/event/{event_id}/picks/	✅ Supported	Managers.get_manager_gw_data()	Retrieves team selection for a specific manager in a gameweek	fpl_get_manager_gw_data --team_id ID --gw GW
/leagues-classic/{league_id}/standings/?page_standings={page}	✅ Supported	Managers.get_league_data()	Retrieves standings for a classic league	fpl_get_league_data --league_id ID --page PAGE
/entry/{team_id}/history/	❌ Not Supported	-	Retrieves a manager's season history	-
/dream-team/	✅ Supported	DreamTeamFetcher.get_dream_team()	Retrieves the dream team	-
/entry/{team_id}/	✅ Supported	Managers.get_manager_basic_info()	Retrieves general data about an FPL team	-
/event/{event_id}/live/	✅ Supported	GWLiveData.get_live_data()	Retrieves live player data for a gameweek	fpl_get_gw_live_data --gameweek GW
/event-status/	❌ Not Supported	-	Retrieves status of each gameweek	-
/my-team/{team_id}/	❌ Not Supported	-	Retrieves authenticated user's team	-
/transfers/	❌ Not Supported	-	Retrieves authenticated user's transfer data	-
/me/	❌ Not Supported	-	Retrieves authenticated user data	-

Resource Download Support Matrix

Resource	Method	CLI Command
Player photo (single)	PlayerDetail.get_player_photo()	fpl_get_player_photos --player_id ID
Player photos (all)	PlayerDetail.get_player_photo()	fpl_get_player_photos_all
Team crest (single)	TeamData.get_team_crest()	fpl_get_team_crest --team_id ID
Team crests (all)	TeamData.get_team_crest()	fpl_get_all_team_crests
Team shirt (outfield)	TeamData.get_team_shirt()	fpl_get_team_shirt --team_id ID
Team shirt (goalkeeper)	TeamData.get_team_goalkeeper_shirt()	fpl_get_team_shirt --team_id ID --keeper-shirt
Team shirts (all teams, both kits)	TeamData.get_team_shirt() + get_team_goalkeeper_shirt()	fpl_get_all_team_shirts

Hatch Environment:

This project uses Hatch for environment management. To set up the environment, follow these steps:

1. Install Hatch if you haven't already:

uv pip install hatch

2. Navigate to the project directory:

hatch env create

Usage

Activating the Environment

To activate the Hatch environment, run:

hatch shell

Running the Application

uv pip install .

Command Line

When installed the following commands are available:

• fpl_get_fixtures - Fetch the fixture list for the current season.
• fpl_get_league_data - Fetch standings data for a classic league with pagination support.
• fpl_get_manager_gw_data - Fetch team selection data for a specific manager in a gameweek.
• fpl_get_players - Get detailed data for all players in the game.
• fpl_get_player - Get detailed information and history for a specific player.
• fpl_get_gw_live_data - Fetch live player data for a gameweek.

Usage:

# fpl_get_fixtures
usage: fpl_get_fixtures [-h] --gameweek GAMEWEEK --team_id TEAM_ID [--output_file OUTPUT_FILE]

options:
  -h, --help            show this help message and exit
  --gameweek GAMEWEEK   Gameweek number (required)
  --team_id TEAM_ID     Team ID (required)
  --output_file OUTPUT_FILE

# fpl_get_league_data
usage: fpl_get_league_data [-h] -lid LEAGUE_ID -p PAGE [-o OUTPUT_FILE]

options:
  -h, --help            show this help message and exit
  -lid LEAGUE_ID, --league_id LEAGUE_ID
  -p PAGE, --page PAGE
  -o OUTPUT_FILE, --output_file OUTPUT_FILE

# fpl_get_manager_gw_data
usage: fpl_get_manager_gw_data [-h] -tid TEAM_ID -gw GAMEWEEK --output_file OUTPUT_FILE

options:
  -h, --help            show this help message and exit
  -tid TEAM_ID, --team_id TEAM_ID
  -gw GAMEWEEK, --gameweek GAMEWEEK
  --output_file OUTPUT_FILE

# fpl_get_players
(no arguments)

# fpl_get_player
usage: fpl_get_player [-h] --player_id PLAYER_ID [--output_file OUTPUT_FILE]

options:
  -h, --help            show this help message and exit
  --player_id PLAYER_ID
  --output_file OUTPUT_FILE

# fpl_get_gw_live_data
usage: fpl_get_gw_live_data [-h] --gameweek GAMEWEEK [-o OUTPUT_FILE]

options:
  -h, --help            show this help message and exit
  --gameweek GAMEWEEK
  -o OUTPUT_FILE, --output_file OUTPUT_FILE

There is also functionality to get various resources from the fpl server such as shirt images, player images, and team logos. These can be accessed via the FPLWrapper class methods:

# fpl_get_player_photos (single)
usage: fpl_get_player_photos [-h] --player_id PLAYER_ID

options:
  -h, --help            show this help message and exit
  --player_id PLAYER_ID

# fpl_get_player_photos_all
usage: fpl_get_player_photos_all [-h] [--output_directory OUTPUT_DIRECTORY]

options:
  -h, --help            show this help message and exit
  --output_directory OUTPUT_DIRECTORY

# fpl_get_team_shirts
usage: fpl_get_team_shirts [-h] --team_id TEAM_ID [--output_directory OUTPUT_DIRECTORY] [--keeper-shirt]

options:
  -h, --help            show this help message and exit
  --team_id TEAM_ID
  --output_directory OUTPUT_DIRECTORY
  --keeper-shirt

# fpl_get_all_team_shirts
usage: fpl_get_all_team_shirts [-h] [--output_directory OUTPUT_DIRECTORY]

options:
  -h, --help            show this help message and exit
  --output_directory OUTPUT_DIRECTORY

# fpl_get_team_crest
usage: fpl_get_team_crest [-h] --team_id TEAM_ID

options:
  -h, --help            show this help message and exit
  --team_id TEAM_ID

# fpl_get_all_team_crests
usage: fpl_get_all_team_crests [-h] [--output_directory OUTPUT_DIRECTORY]

options:
  -h, --help            show this help message and exit
  --output_directory OUTPUT_DIRECTORY

Or alternatively you can use the package as a library:

The documentation can be found here

Development

Installing Dependencies

To install the project dependencies, activate the Hatch environment and run:

hatch env install

Linting & Formatting

Run the following command to lint and format code with Ruff:

hatch fmt

Testing

To run tests using PyTest, execute:

hatch run test:test

You can also run tests with coverage:

hatch run test:cov-xml

You can also generate a coverage report in HTML format:

hatch run test:cov-html

Documentation

The documentation is generated using pdoc and can be found in the docs directory. To generate the documentation, run:

hatch run docs:build

Deployment

Building the Package

To build the package, run:

hatch build

Contributing

Contributions to this project are welcomed! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Install pre-commit hooks
4. Make your changes.
5. Ensure your changes pass pre-commit and conform to the Contributing Guidelines and Code of Conduct.
6. Submit a pull request with a detailed description of your changes Pull Request template can be found here.

License

This project is distributed under the terms of the MIT license.