NHL & NCAAH API / head-2-head

Head to head

GET https://nhl.highlightly.net/head-2-head NHL & NCAAH API
GET https://sports.highlightly.net/nhl/head-2-head All Sports API

Retrieve the last ten head to head games between two teams.

Pagination
Not paginated

Specify teamIdOne and teamIdTwo, both from teams. The order does not matter, so you do not need to work out which side is at home before calling.

Use it to compare two teams on their past results, which is the usual companion to a game preview. For each team's recent form independent of the opponent, use last five games.

A head to head comparison between two teams

Parameters

Parameter Type Description
teamIdOnerequired number No description in the spec.e.g. 1
teamIdTworequired number No description in the spec.e.g. 2

Request

curl --request GET \
  --url 'https://nhl.highlightly.net/head-2-head?teamIdOne=1&teamIdTwo=2' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
  teamIdOne: '1',
  teamIdTwo: '2'
})
const response = await fetch(`https://nhl.highlightly.net/head-2-head?${params}`, {
  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/head-2-head',
    params={
        'teamIdOne': '1',
        'teamIdTwo': '2',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

idnumberrequired
roundstringrequired
datestringrequired
leaguestringrequired
seasonnumberrequired
awayTeamNhlMatchTeamResponserequired5 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
homeTeamNhlMatchTeamResponserequired5 fields
idnumberrequired
logostring
namestring
displayNamestringrequired
abbreviationstringrequired
stateNhlMatchStateResponserequired10 fields
periodnumberCurrent in play period.
clocknumberCurrent minute of the in play period.
descriptionstringrequiredCurrent status/description of the match.SuspendedPostponedCancelledAbandonedFinishedIn progressEnd periodHalf timeUnknownScheduled
scoreNhlMatchScoreResponserequired5 fields
currentstringHome - Away score for the match.
firstPeriodstringHome - Away score in 1st period.
secondPeriodstringHome - Away score in 2nd period.
thirdPeriodstringHome - Away score in 3rd period.
overtimePeriodstringHome - Away score in the overtime period.
reportstringAdditional description of the match state.

Example response

200 application/json 
[
  {
    "id": 1,
    "round": "Regular Season - 14",
    "date": "2023-05-20T15:30:00.000Z",
    "league": "NHL",
    "season": 2023,
    "awayTeam": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Panthers",
      "displayName": "Florida Panthers",
      "abbreviation": "FLA"
    },
    "homeTeam": {
      "id": 1,
      "logo": "https://example.com/logos/team/1.png",
      "name": "Panthers",
      "displayName": "Florida Panthers",
      "abbreviation": "FLA"
    },
    "state": {
      "period": 2,
      "clock": 8,
      "description": "In progress",
      "score": {
        "current": "1 - 1",
        "firstPeriod": "0 - 0",
        "secondPeriod": "1 - 1",
        "thirdPeriod": "2 - 2",
        "overtimePeriod": "1 - 0"
      },
      "report": "Final"
    }
  }
]

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.