Feed Information
Detail |
Info |
|---|---|
Update Interval |
As data is updated |
Atom feed keyword |
/football/play-by-play |
HTTP NFL |
Note that the URLs listed above are not valid; keywords in parentheses must be replaced with real values.
Common Data
League Data
Item |
| Notes |
|---|---|---|
Sport Id |
|
|
Sport Name |
|
|
League Id |
|
|
League Name |
|
|
League Short Name |
|
|
Season Data
Item |
| Notes |
|---|---|---|
Id |
|
|
Name |
|
|
Start Date |
|
|
End Date |
|
|
Team Data
Included for both the home and visitor teams.
Item |
| Notes |
|---|---|---|
Id |
|
|
Display Name |
|
|
Player Data
Included for all players involved in the game.
Item |
| Notes |
|---|---|---|
Id |
|
|
First Name |
|
|
Last Name |
|
|
| City |
|
|
State |
| For Canada, USA only. |
Country |
|
|
Venue Data
Item |
| Notes |
|---|---|---|
Id |
|
|
Name |
|
|
Short Name |
|
|
City |
|
|
State |
| For Canada, USA only. |
Country |
|
|
| Timezone |
| |
Capacity |
| Season-specific. |
Field Type |
| Football and Baseball only. |
Game Info
Item |
| Notes |
|---|---|---|
Id |
|
|
Start date/time |
|
|
| Continue Date |
| Continue date, if the game is/was suspended |
Name |
| Name of event (if applicable) |
Status |
| Scheduled, etc. |
Game Type |
| Regular season, etc. |
Neutral Site? |
| True/false |
Day Game? |
| True/false |
Date/time TBD? |
| True/false |
Attendance |
| Typically not available until the game is complete. |
QA Status |
| Post game metadata describing the completeness and verification of game statistics (verified/finalized) |
Football Game Info
Item | NFL | NCAAF | CFL | AFL | Notes |
|---|---|---|---|---|---|
Weather Conditions |
|
|
|
| Cloudy, Sunny, etc.; Available for 2014-15 season forward |
Temperature |
|
|
|
| Degrees fahrenheit; Available for 2014-15 season forward |
Wind Direction |
|
|
|
| Available for 2014-15 season forward |
Wind Speed |
|
|
|
| MPH; Available for 2014-15 season forward |
Play-by-Play Data
Play-by-play data consists of a sequence of elements describing game events in order of when they occurred during the game.
Possession
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
Team |
|
|
Play
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
Team |
|
|
Play events |
|
see Play Event description below |
Down |
|
down attempt |
Yards to go |
|
yards to go; either a 'yards', 'goal' or 'inches' sub-element |
Yard line |
|
yard line at the start of play |
Yards to go 'goal' and 'inches' sub-elements are empty elements
Yards
Item |
|
|
|---|---|---|
Yards |
|
yards value (e.g. 10) |
Play Event
Item |
| Notes |
|---|---|---|
Type |
|
see Play Event Type list below |
Player |
|
if the Play Event involves a player |
Team |
|
if the Play Event involves a team |
Yards |
|
the change in yardage as a result of this Play Event |
Play Event Types
Type |
|---|
assisted_tackle_by |
ball_out_of_bounds |
blocked_by |
defensive_touchdown |
direct_snap_to |
downed_by |
failed_one_point_conversion |
failed_two_point_conversion |
fair_catch_by |
fake_field_goal |
field_goal_attempted_by |
field_goal_by |
flea_flicker_to |
forced_fumble_by |
forced_out_of_bounds |
fumble_by |
fumble_return |
half_sack_by |
handoff_to |
intercepted_by |
kickoff_by |
kneel |
lateral_to |
missed_field_goal_by |
muffed_catch_by |
on_side_kick_by |
one_point_conversion |
out_of_bounds |
pass_complete_to |
pass_complete_to_yards_unavailable |
pass_incomplete |
pass_incomplete_to |
pass_intended_for |
punt_by |
punt_formation |
ran_out_of_bounds |
received_by |
recovered_by |
return_by |
rush_by |
rush_by_yards_unavailable |
sack_by |
safety |
snap_to |
spikes_ball |
tackle_by |
touchback |
touchdown |
turnover_to |
two_point_conversion |
Play Penalties
Item |
| Notes |
|---|---|---|
Team |
|
The team receiving the penalty |
Type |
|
|
Enforced |
|
True if the penalty was enforced, false otherwise |
Yards |
|
|
Offset |
|
True if the penalty is offsetting, false otherwise |
No Play |
|
True if the penalty resulted in no play, false otherwise |
Play Challenges
Item |
| Notes |
|---|---|---|
Caller |
|
Team, or official |
Play Reversed |
|
True if the challenge caused the play to be reversed, false otherwise |
Two-Minute-Warning
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
Team Timeout
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
Team |
|
the team that called the timeout |
Official Timeout
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
Injury Timeout
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
Clock time |
|
|
End of Quarter
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|
End of Game
Item |
| Notes |
|---|---|---|
Id |
|
|
Quarter |
|
|