NBA & NCAAB API / highlights

Get highlight by ID

GET https://nba.highlightly.net/highlights/{id} NBA & NCAAB API
GET https://sports.highlightly.net/nba/highlights/{id} All Sports API

Retrieve one highlight by its id.

Use this to check whether a highlight you have already stored still exists, or whether its information has been updated since you fetched it. Clips are hosted on third party platforms and can be removed or edited after aggregation, so a highlight you cached last week may no longer resolve.

Parameters

Parameter Type Description
idrequired numberpath Requested highlight id.

Request

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

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

Response

idnumberrequired
matchNbaMatchBaseInforequired14 fields
idnumberrequired
leaguestringrequiredNBANCAA
homeTeamNbaTeamInfoResponserequired5 fields
idnumberrequired
displayNamestringrequired
namestringrequired
logostring
abbreviationstringrequired
awayTeamNbaTeamInfoResponserequired5 fields
idnumberrequired
displayNamestringrequired
namestringrequired
logostring
abbreviationstringrequired
typestringrequired
imgUrlstringPreview picture of the highlight.
titlestring
descriptionstring
urlstringrequiredUrl location of the video highlight.
embedUrlstringrequiredUrl of embeddable video highlight.
channelstringChannel title of a given highlight.
sourcestringAggregation source from social media and other equivalent platforms.
categorystringAssumed highlight category

Example response

200 application/json 
[
  {
    "id": 1361,
    "match": {
      "id": 9853,
      "league": "NBA",
      "homeTeam": {
        "id": 3,
        "displayName": "Denver Nuggets",
        "name": "Nuggets",
        "logo": "https://highlightly.net/nba/images/teams/3.png",
        "abbreviation": "DEN"
      },
      "awayTeam": {
        "id": 3,
        "displayName": "Denver Nuggets",
        "name": "Nuggets",
        "logo": "https://highlightly.net/nba/images/teams/3.png",
        "abbreviation": "DEN"
      }
    },
    "type": "VERIFIED",
    "imgUrl": "https://example.com/images/preview/1.png",
    "title": "NCAA: Huskies vs Crimson Tide",
    "description": "Following an impressive postseason run that came to an end in a program-first Final Four appearance, Nate Oats expresses his pride in the Tide and says they'll be \"knocking on the door\" next season.",
    "url": "https://example.com/highlight/29g9urg92387",
    "embedUrl": "https://example.com/embed/213123safas132e",
    "channel": "",
    "source": "youtube",
    "category": "match-highlights"
  }
]

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.