This is a python API for scraping data from understat.com. Understat is a website with football data for 6 european leagues for every season since 2014/15 season. The leagues available are the Premier League, La Liga, Ligue 1, Serie A, Bundesliga and the Russian Premier League.
NOTE
I am not affiliated with understat.com in any way
To install the package run
pip install understatapiIf you would like to use the package with the latest development changes you can clone this repo and install the package
git clone [email protected]:collinb9/understatAPI understatAPI
cd understatAPI
python -m pip install .The API contains endpoints which reflect the structure of the understat website. Below is a table showing the different endpoints and the pages on understat.com to which they correspond
| Endpoint | Webpage |
|---|---|
| UnderstatClient.league | https://understat.com/league/<league_name> |
| UnderstatClient.team | https://understat.com/team/<team_name>/<season> |
| UnderstatClient.player | https://understat.com/player/<player_id> |
| UnderstatClient.match | https://understat.com/match/<match_id> |
Every method in the public API corresponds to one of the tables visible on the understat page for the relevant endpoint.
Each method returns JSON with the relevant data. Below are some examples of how to use the API. Note how the league() and team() methods can accept the names of leagues and teams respectively, but player() and match() must receive an id number.
from understatapi import UnderstatClient
understat = UnderstatClient()
# get data for every player playing in the Premier League in 2019/20
league_player_data = understat.league(league="EPL").get_player_data(season="2019")
# Get the name and id of one of the player
player_id, player_name = league_player_data[0]["id"], league_player_data[0]["player_name"]
# Get data for every shot this player has taken in a league match (for all seasons)
player_shot_data = understat.player(player=player_id).get_shot_data()from understatapi import UnderstatClient
understat = UnderstatClient()
# get data for every league match involving Manchester United in 2019/20
team_match_data = understat.team(team="Manchester_United").get_match_data(season="2019")
# get the id for the first match of the season
match_id = team_match_data[0]["id"]
# get the rosters for the both teams in that match
roster_data = understat.match(match=match_id).get_roster_data()You can also use the UnderstatClient class as a context manager which closes the session after it has been used, and also has some improved error handling. This is the recommended way to interact with the API.
from understatapi import UnderstatClient
with UnderstatClient() as understat:
team_match_data = understat.team(team="Manchester_United").get_match_data(season="2019")For a full API reference, see the documentation
If you find any bugs in the code or have any feature requests, please make an issue and I'll try to address it as soon as possible. If you would like to implement the changes yourself you can make a pull request
- Clone the repo
git clone [email protected]:collinb9/understatAPI - Create a branch to work off
git checkout -b descriptive_branch_name - Make and commit your changes
- Push your changes
git push - Come back to the repo on github, and click on Pull requests -> New pull request
Before a pull request can be merged the code will have to pass a number of checks that are run using CircleCI. These checks are
- Check that the code has been formatted using black
- Lint the code using pylint
- Check type annotations using mypy
- Run the unit tests and check that they have 100% coverage
These checks are in place to ensure a consistent style and quality across the code. To check if the changes you have made will pass these tests run
pip install -r requirements.txt
pip install -r test_requirments.txt
pip install -r docs_requirments.txt
chmod +x ci/run_tests.sh
ci/run_tests.shDon't let these tests deter you from making a pull request. Make the changes to introduce the new functionality/bug fix and then I will be happy to help get the code to a stage where it passes the tests.
The versioning for this project follows the semantic versioning conventions.
- Add asynchronous support
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent