Get Matchup
get_matchupRetrieve head-to-head matchup for current or chosen week, showing scores, projections, win probability, and roster details to see who you face and if you're ahead.
Instructions
Return the user's head-to-head matchup for the current week (or a given week).
Use this for "am I winning?", "who am I playing?", or "should I have started X?". week defaults to the current matchup period (current_week); pass an earlier week for a final result or next week's number for a preview with projections. There is no per-player game-state field: points of 0.0 may mean the player has not played yet OR played and scored nothing -- do not claim to know which.
Top level: week; status (UPCOMING, IN_PROGRESS, or FINAL); is_home; my_team; opponent. Each team has: team_id, name, abbrev, score (fantasy points so far this week), projected (ESPN's live projection for the week's final score, or for a future week the sum of starters' player projections -- see projected_source: "espn" | "sum_of_starters" | null), win_probability (0-1, may be null), and roster. Each roster row has the same fields as get_my_team (player_id, name, position, slot, pro_team, injury_status) plus points (scored so far this week) and projected (ESPN's projection for this player this week; null if unavailable). Only rows whose slot is not BENCH or IR count toward score.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| week | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||