NFL & NCAAF API / box-score

Box score

GET https://american-football.highlightly.net/box-score/{matchId} NFL & NCAAF API
GET https://sports.highlightly.net/american-football/box-score/{matchId} All Sports API

Retrieve per player statistics for one game.

Refresh interval
Every minute

The matchId comes from matches.

Shape of the response

The response is an array with two elements, home team first, then away team.

Each element holds a team object with the team's id, name, logo and a boxScores list holding one record per player. Each record has a player object with id, name and jersey, and a statistics list.

Statistic groups

Which groups a player carries depends on their position and on the match data, so treat every group as optional.

Group Example statistics
Passing

Total passes, successful passes, passing yards, yards per attempt, passing touchdowns, interceptions thrown, sacks taken, sack yards lost and quarterback rating.

Rushing Attempts, rushing yards, yards per rush, rushing touchdowns and longest rush.
Receiving Receptions, receiving yards, yards per reception, receiving touchdowns, longest reception and targets.
General

Fumbles, lost fumbles, recovered fumbles, interceptions, interception yards and interception touchdowns.

Defense

Tackles, solo tackles, sacks, tackles for loss, defended passes, defensive quarterback rating and defensive touchdowns.

Kicking

Kick returns, kick return yards, yards per kick return, longest kick return, kick return touchdowns, field goal attempts and makes, field goal percentage, longest field goal, extra point attempts and makes, and total kicking points.

Punting

Punts, punting yards, average gross punting yards, touchbacks, punts inside 20 yards, longest punt, punt returns, punt return yards, yards per punt return, longest punt return and punt return touchdowns.

For team level statistics, venue and injuries, use get match by ID.

Parameters

Parameter Type Description
matchIdrequired numberpath Requested match id

Request

curl --request GET \
  --url 'https://american-football.highlightly.net/box-score/{matchId}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://american-football.highlightly.net/box-score/{matchId}', {
  headers: {
    'x-rapidapi-key': process.env.HIGHLIGHTLY_API_KEY
  }
})

if (!response.ok) {
  throw new Error(`Highlightly responded ${response.status}`)
}

const data = await response.json()
import os
import requests

response = requests.get(
    'https://american-football.highlightly.net/box-score/{matchId}',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

response.raise_for_status()
data = response.json()

Response

teamAmericanFootballPlayerBoxScoreTeamResponserequired12 fields
idnumberrequired
namestringrequired
logostring
boxScoresAmericanFootballBoxScoreItemResponse[]required8 fields
playerAmericanFootballBoxScorePlayerItemResponserequired3 fields
idnumberrequired
namestringrequired
jerseynumber
statisticsAmericanFootballBoxScoreStatItemResponse[]required3 fields
groupstringrequired
namestringrequired
valuenumberrequired

Example response

200 application/json 
[
  {
    "team": {
      "id": 92743,
      "name": "Baltimore Ravens",
      "logo": "https://highlightly.net/american-football/images/teams/92743.png",
      "boxScores": [
        {
          "player": {
            "id": 58746872,
            "name": "Lamar Jackson",
            "jersey": 8
          },
          "statistics": [
            {
              "group": "Passing",
              "name": "Total Successful Passes",
              "value": 7
            }
          ]
        }
      ]
    }
  }
]

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors

Status Description
400 Bad request descriptive error.
500 Internal server error.