Handball API / highlights

Get highlight by ID

GET https://handball.highlightly.net/highlights/{id} Handball API
GET https://sports.highlightly.net/handball/highlights/{id} All Sports API

Retrieve one highlight by its id. The response is an array holding the highlight, so read the first element.

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 full match the clip belongs to comes back with it, including the score by half, so a stored highlight can be re-rendered in context without a second request.

Parameters

Parameter Type Description
idrequired numberpath Requested highlight id.

Request

curl --request GET \
  --url 'https://handball.highlightly.net/highlights/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://handball.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://handball.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.
matchHandballMatchResponserequired26 fields
idnumberrequired
weekobject
datestringrequired
countryHandballCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamHandballTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
homeTeamHandballTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
leagueHandballMatchLeagueResponserequired4 fields
idnumberrequired
seasonnumberrequired
namestringrequired
logostring
stateHandballMatchStateResponserequired5 fields
descriptionstringrequiredState of the match.Not startedFirst halfHalf timeSecond halfExtra timeBreak timePenaltiesSuspendedInterruptedFinishedPostponedCancelledAbandonedAwardedUnknownTo be announcedFinished after penaltiesFinished after extra time
scoreHandballMatchScoreResponserequired3 fields
currentstringHome - Away match score.
firstHalfstringHome - Away match score in the first half.
secondHalfstringHome - Away match score in the second half.
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": "1. Bundesliga Women: Bensheim-Auerbach W vs Solingen W",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/13efe2g4t542",
    "embedUrl": "https://example.com/embed/13efe2g4t542",
    "match": {
      "id": 126347903,
      "week": "9",
      "date": "2023-12-27T18:30:00.000Z",
      "country": {
        "code": "DE",
        "name": "Germany",
        "logo": "https://example.com/logos/country/DE.png"
      },
      "awayTeam": {
        "id": 332674,
        "logo": "https://example.com/logos/team/332674.png",
        "name": "Solingen W"
      },
      "homeTeam": {
        "id": 332674,
        "logo": "https://example.com/logos/team/332674.png",
        "name": "Solingen W"
      },
      "league": {
        "id": 36526,
        "season": 2023,
        "name": "1. Bundesliga Women",
        "logo": "https://example.com/logos/league/36526.png"
      },
      "state": {
        "description": "Finished",
        "score": {
          "current": "26 - 26",
          "firstHalf": "13 - 15",
          "secondHalf": "13 - 11"
        }
      }
    },
    "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.