NHL & NCAAH API / lineups

Lineups

GET https://nhl.highlightly.net/lineups/{matchId} NHL & NCAAH API
GET https://sports.highlightly.net/nhl/lineups/{matchId} All Sports API

Retrieve the home and away lineups for a game.

When to query
Up to a few hours before the game starts

The matchId comes from matches.

Both squads come back together, so one request covers the whole game rather than one per side.

Lineups rendered in a client application

Parameters

Parameter Type Description
matchIdrequired numberpath Requested match id.

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/lineups/{matchId}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://nhl.highlightly.net/lineups/{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://nhl.highlightly.net/lineups/{matchId}',
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

homeNhlLineupsrequired14 fields
teamNhlTeamResponserequired6 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
leaguestringrequired
lineupNhlLineupsPlayer[]required6 fields
idnumberrequired
jerseynumber
playerstringrequired
positionstringrequired
positionAbbreviationstringrequired
isScratchedboolean
awayNhlLineupsrequired14 fields
teamNhlTeamResponserequired6 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
leaguestringrequired
lineupNhlLineupsPlayer[]required6 fields
idnumberrequired
jerseynumber
playerstringrequired
positionstringrequired
positionAbbreviationstringrequired
isScratchedboolean

Example response

200 application/json 
{
  "home": {
    "team": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Stars",
      "displayName": "Dallas Stars",
      "abbreviation": "DAL",
      "league": "NHL"
    },
    "lineup": [
      {
        "id": 74958347,
        "jersey": 14,
        "player": "B. Kramer",
        "position": "Defense",
        "positionAbbreviation": "D",
        "isScratched": false
      }
    ]
  },
  "away": {
    "team": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Stars",
      "displayName": "Dallas Stars",
      "abbreviation": "DAL",
      "league": "NHL"
    },
    "lineup": [
      {
        "id": 74958347,
        "jersey": 14,
        "player": "B. Kramer",
        "position": "Defense",
        "positionAbbreviation": "D",
        "isScratched": false
      }
    ]
  }
}

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.