Football API Tech Docs

Search in tech docs

Football API Play-by-Play

Provides all match drives and plays during the match with their detailed informations.

Football Play by Play Request URL

GET

References / Dependencies

Tournament ID The id of the tournament. You can find list of the tournament from Tournament List endpoint

Stage / Round Structure Stage / Round structures change tournament by tournament. You can find the structures with Tournament Id from Tournament Info endpoint

Matches from Fixture Match Ids can be retrieved from The fixture of the tournament. You can find all matches of the tournament from Tournament Fixture endpoint

Matches from Match List Match Ids can be retrieved from The Daily Match List. You can find all matches in 7-days period from Match List endpoint

Call Rate / Interval

Recommended API Call Interval at live: 12 Request / Minute Recommended API Call Interval at 1 hour after game end: 1 Request / Minute Recommended API Call Interval at more than 1 hour after game end: 4 Request / Hour

Request Headers

Data	Type	O / R	Example	Description
languageId	INT	R	{languageId}	The id of the language that you select.
Ocp-Apim-Subscription-Key	STR	R	{yourOcp-Apim-Subscription-Key}	Your account key.
Accept	STR	O	application/xml	Selection of data presentation type as XML/JSON.

^*O= Optional, R= Required

Request Parameters

Data	Type	O / R	Example	Description
matchId	INT	R	{matchId}	The id of the match

Response Output

{ "date": "03/02/2019 23:30:00", "id": 18656, "homeTeam": { "name": "Los Angeles Rams", "shortName": "LAR", "mediumName": "Rams", "id": 31 }, "awayTeam": { "name": "New England Patriots", "shortName": "NE", "mediumName": "Patriots", "id": 5 }, "drives": [ { "id": 19228, "period": 15, "startTime": "01:12", "playCount": 6, "yardsGained": 55, "totalFirstDowns": 2, "duration": "1:07", "team": { "name": "Los Angeles Rams", "shortName": "LAR", "id": 31 }, "plays": [ { "quarter": 4, "time": "01:12", "down": 0, "yardsToGo": 0, "startYardTeamShortName": "NE", "startYardLine": 35, "commentaryText": "Stephen Gostkowski kicks 65 yards from NE 35 to end zone, Touchback." }, { "quarter": 4, "time": "01:12", "down": 1, "yardsToGo": 10, "startYardTeamShortName": "LAR", "startYardLine": 25, "commentaryText": "(01:12) PENALTY on Rob Havenstein (LAR), 10 yards, enforced at LAR 25." }, { "quarter": 4, "time": "01:06", "down": 1, "yardsToGo": 20, "startYardTeamShortName": "LAR", "startYardLine": 15, "commentaryText": "(01:06) Jared Goff pass to Robert Woods to LAR 25 for 10 yards (J. C. Jackson; Jonathan Jones)." }, { "quarter": 4, "time": "00:45", "down": 2, "yardsToGo": 10, "startYardTeamShortName": "LAR", "startYardLine": 25, "commentaryText": "(00:45) Jared Goff pass to Brandin Cooks to LAR 49 for 24 yards (Jonathan Jones)." }, { "quarter": 4, "time": "00:25", "down": 1, "yardsToGo": 10, "startYardTeamShortName": "LAR", "startYardLine": 49, "commentaryText": "(00:25) Jared Goff pass incomplete to Josh Reynolds." }, { "quarter": 4, "time": "00:21", "down": 2, "yardsToGo": 10, "startYardTeamShortName": "LAR", "startYardLine": 49, "commentaryText": "(00:21) Jared Goff pass to Brandin Cooks to NE 30 for 21 yards (Jonathan Jones)." }, { "quarter": 4, "time": "00:09", "down": 1, "yardsToGo": 10, "startYardTeamShortName": "NE", "startYardLine": 30, "commentaryText": "(00:09) Jared Goff pass incomplete." }, { "quarter": 4, "time": "00:08", "down": 2, "yardsToGo": 10, "startYardTeamShortName": "NE", "startYardLine": 30, "commentaryText": "(00:08) Greg Zuerlein 48 yards field goal is No Good." } ] }, { "id": 19229, "period": 15, "startTime": "00:05", "playCount": 1, "yardsGained": -1, "totalFirstDowns": 0, "duration": "0:05", "team": { "name": "New England Patriots", "shortName": "NE", "id": 5 }, "plays": [ { "quarter": 4, "time": "00:05", "down": 1, "yardsToGo": 10, "startYardTeamShortName": "NE", "startYardLine": 38, "commentaryText": "(00:05) Tom Brady rush to NE 37 for -1 yards." }, { "quarter": 4, "isStatusPlayGame": true } ] } ], "tournament": { "name": "National Football League", "shortName": "NFL", "id": 1 }, "stage": { "name": "Super Bowl", "shortName": "SB", "id": 726 }, "round": { "name": "Single Game", "shortName": "SG", "id": 209 } }

Response Output Definitions

match

Data

Type

Example

Description

INT

18656

The id of the match

date

DATE/STR

03/02/2019 23:30:00

The date of the match

tournament

Data	Type	Example	Description
name	STR	National Football League	The name of the tournament
shortName	STR	NFL	The short name of the tournament
id	INT	1	The id of the tournament

stage

Data	Type	Example	Description
name	STR	Super Bowl	The name of the stage
shortName	STR	SB	The short name of the stage
id	INT	726	The id of the stage

round

Data	Type	Example	Description
name	STR	Single Game	The name of the round
shortName	STR	SG	The short name of the round
id	INT	209	The id of the round

homeTeam/awayTeam

Data	Type	Example	Description
name	STR	New England Patriots	The name of the home/away team for the match
mediumName	STR	Patriots	The short name of the home/away team for the match
shortName	STR	NE	The short name of the home/away for the match
id	INT	5	The id of the home/away for the match

drives

Data

Type

Example

Description

INT

19228

Id of the drive

period

INT

Status Id of the drive

startTime

STR

01:12

Starting game clock of the drive

yardsGained

INT

Total gained yards for the drive

totalFirstDowns

INT

Total gained yards for the drive

duration

STR

1:07

Total duration of the drive

team

Data	Type	Example	Description
name	STR	Los Angeles Rams	Name of the drive’s team
shortName	STR	LAR	Short name of the drive’s team
id	INT	31	Id of the drive’s team

plays

Data	Type	Example	Description
quarter	INT	4	period of the play
time	STR	01:12	starting game clock of the play
down	INT	1	down order of the play
yardsToGo	INT	10	The remaining yard value to the next down
startYardTeamShortName	STR	LAR	Start line's team short name of the play
startYardLine	INT	25	Start line's yard of the play
commentaryText	STR	(00:21) Jared Goff pass to Brandin Cooks to NE 30 for 21 yards (Jonathan Jones).	Commentary text of the play

Football API Tech Docs

Tech Docs Index

Documentation+

Widgets+

Lookups+

Global API+

Soccer API+

Basketball API+

Football API+

Baseball API+

Ice Hockey API+

Volleyball API+

Handball API+

Table Tennis API+

Tennis API+