get_plays
Use for play-by-play with nflfastR metrics: EPA, WPA, win probability, success, CPOE, air yards, formation flags, and the players involved. Filter by game, or by season plus week/team/player, plus play type, down, quarter, win-probability band, red zone, third down. Set include_charting for FTN manual charting from 2022 on -- alignment, pre-snap motion, play action, screens, run-pass options, blitzer counts, drops -- or filter directly on those flags. Returns a per-query EPA and success-rate summary. Paginate with offset. Costs 10 credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| down | No | Down | |
| week | No | Week | |
| limit | No | Max plays (default 200) | |
| is_rpo | No | Charting filter: run-pass option (2022+) | |
| max_wp | No | Maximum pre-play win probability | |
| min_wp | No | Minimum pre-play win probability for the offense | |
| offset | No | Pagination offset | |
| season | No | Season year (required when game_id is not set) | |
| defteam | No | Defense team code | |
| game_id | No | Game id, e.g. 2025_01_KC_BUF | |
| is_drop | No | Charting filter: charted drop (2022+) | |
| posteam | No | Offense team code | |
| quarter | No | Quarter (5+ = overtime) | |
| red_zone | No | Only plays inside the 20 | |
| is_motion | No | Charting filter: pre-snap motion (2022+) | |
| passer_id | No | GSIS id of the passer | |
| play_type | No | Play type | |
| rusher_id | No | GSIS id of the rusher | |
| third_down | No | Only third downs | |
| receiver_id | No | GSIS id of the receiver | |
| is_no_huddle | No | Charting filter: no huddle (2022+) | |
| min_blitzers | No | Charting filter: at least this many blitzers (2022+). FTN counts rushers beyond the base rush, so this is typically 0-3; 5+ is almost never charted. | |
| is_trick_play | No | Charting filter: trick play (2022+) | |
| is_play_action | No | Charting filter: play action (2022+) | |
| is_screen_pass | No | Charting filter: screen pass (2022+) | |
| include_charting | No | Attach FTN manual charting to each play (2022+): alignment, motion, play action, screens, RPO, blitzers, drops | |
| is_qb_out_of_pocket | No | Charting filter: quarterback out of the pocket (2022+) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| count | Yes | ||
| plays | Yes | ||
| summary | Yes | ||
| next_offset | Yes | ||
| charted_plays | No |