Volleyball API / highlights

Get highlight by ID

GET https://volleyball.highlightly.net/highlights/{id} Volleyball API
GET https://sports.highlightly.net/volleyball/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.

The match the clip belongs to always comes back with it, in the same general shape as the matches list. That includes its state and score, although each set score within score is optional. For venue, forecast and predictions, use get match by ID.

Parameters

Parameter Type Description
idrequired numberpath Requested highlight id.

Request

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

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

Response

idnumberrequired
typestringrequired
imgUrlstringPreview picture of the highlight.
titlestringrequired
descriptionstring
urlstringrequiredUrl location of the video highlight.
embedUrlstringUrl of embeddable video highlight.
matchVolleyballMatchResponserequired29 fields
idnumberrequired
weekstring
datestringrequired
countryVolleyballCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamVolleyballTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
homeTeamVolleyballTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
leagueVolleyballMatchLeagueResponserequired4 fields
idnumberrequired
seasonnumberrequired
namestringrequired
logostring
stateVolleyballMatchStateResponserequired8 fields
descriptionstringrequiredState of the match.Not startedFirst setSecond setThird setFourth setFifth setAwardedPostponedCancelledInterruptedAbandonedFinishedUnknownTo be announced
scoreVolleyballMatchScoreResponserequired6 fields
currentstringHome - Away score for the match.
firstSetstringHome - Away score for the first set.
secondSetstringHome - Away score for the second set.
thirdSetstringHome - Away score for the third set.
fourthSetstringHome - Away score for the fourth set.
fifthSetstringHome - Away score for the fifth set.
channelstringChannel title of a given highlight.
sourcestringAggregation source from social media and other equivalent platforms.
categorystringAssumed highlight category

Example response

200 application/json 
[
  {
    "id": 1,
    "type": "VERIFIED",
    "imgUrl": "https://example.com/images/preview/1.png",
    "title": "SuperLega: Trentino vs Cisterna",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/13efe2g4t542",
    "embedUrl": "https://example.com/embed/13efe2g4t542",
    "match": {
      "id": 126347903,
      "week": "12",
      "date": "2023-12-30T17:00:00.000Z",
      "country": {
        "code": "IT",
        "name": "Italy",
        "logo": "https://example.com/logos/country/IT.png"
      },
      "awayTeam": {
        "id": 630524,
        "logo": "https://example.com/logos/team/630524.png",
        "name": "Trentino"
      },
      "homeTeam": {
        "id": 630524,
        "logo": "https://example.com/logos/team/630524.png",
        "name": "Trentino"
      },
      "league": {
        "id": 83331,
        "season": 2023,
        "name": "SuperLega",
        "logo": "https://example.com/logos/league/83331.png"
      },
      "state": {
        "description": "Second set",
        "score": {
          "current": "3 - 1",
          "firstSet": "19 - 25",
          "secondSet": "25 - 12",
          "thirdSet": "22 - 17",
          "fourthSet": "22 - 17",
          "fifthSet": "25 - 19"
        }
      }
    },
    "channel": "Ligue 1 Uber Eats",
    "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.