Skip to content

Commit 95942d5

Browse files
committed
docs(Statcast): Add catcher_throwing function documentation
1 parent e366d46 commit 95942d5

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

docs/catcher_throwing.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Statcast Catcher Throwing
2+
3+
## `catcher_throwing`
4+
5+
Function to get catcher throwing data from each stolen base attempt for a specific catcher. Based on Baseball Savant's [Catcher Throwing](https://baseballsavant.mlb.com/leaderboard/catcher-throwing).
6+
7+
**Examples**
8+
9+
```python
10+
from baseball_stats_python import catcher_throwing
11+
12+
# Get Will Smith's catcher throwing data
13+
catcher_throwing('669257')
14+
15+
# Get Will Smith's catcher throwing data in 2023
16+
catcher_throwing('669257', season='2023')
17+
18+
# Get Will Smith's catcher throwing data in playoffs
19+
catcher_throwing('669257', game_type=GameType.PLAYOFFS)
20+
```
21+
22+
**Arguments**
23+
24+
| Argument | Data Type | Description |
25+
| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| catcher_id (Required) | `str` | The MLBAM ID of the catcher. |
27+
| game_type | `str` or `GameType` | The game type to filter by. Can be `R` for regular season, `PO` for playoffs, or `All` for all games. Check enum [GameType](../enums/statcast_leaderboard.py) |
28+
| season | `str` | The season to filter by. The earliest season available is 2016. |
29+
30+
**Return**
31+
32+
A DataFrame with columns that related to the [Catcher Throwing](https://baseballsavant.mlb.com/leaderboard/catcher-throwing) leaderboard. The DataFrame will represent each stolen base attempt for a specific catcher which contains data like `pop_time`, `throw_type`, `r_primary_lead`, etc.

0 commit comments

Comments
 (0)