HIhighlightly
NHL, NCAAH.Highlights

Get highlight by id

Retrieve highlight information by specifying the highlight id path parameter.

Note: Used to check whether a highlight still exists or had its information updated.

get/nhl/highlights/{id}

Request

Path parameters

idnumber required

Requested highlight id.

Headers

x-rapidapi-hoststring required

sport-highlights-api.p.rapidapi.com

x-rapidapi-keystring required

Rapid API Token

Response

idnumber required
typestring required
imgUrlstring

Preview picture of the highlight.

titlestring required
descriptionstring
urlstring required

Url location of the video highlight.

embedUrlstring

Url of embeddable video highlight.

channelstring

Channel title of a given highlight.

sourcestring

Aggregation source from social media and other equivalent platforms.

Example response

[
  {
    "id": 1,
    "type": "VERIFIED",
    "imgUrl": "https://example.com/images/preview/1.png",
    "title": "NFL: New Orleans Saints vs Kansas City Chiefs",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/v23r23fds2cff",
    "embedUrl": "https://example.com/embed/v23r23fds2cff",
    "match": {
      "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"
      }
    },
    "channel": "NHL",
    "source": "youtube"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.