Rugby API / highlights

Get highlight by ID

GET https://rugby.highlightly.net/highlights/{id} Rugby API
GET https://sports.highlightly.net/rugby/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 full match the clip belongs to comes back with it, including its state and, when present, its score, 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://rugby.highlightly.net/highlights/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://rugby.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://rugby.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.
matchRugbyMatchResponserequired23 fields
idnumberrequired
weekstring
datestringrequired
countryRugbyCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamRugbyTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
homeTeamRugbyTeamResponserequired3 fields
idnumberrequired
logostring
namestringrequired
leagueRugbyMatchLeagueResponserequired4 fields
idnumberrequired
seasonnumberrequired
namestringrequired
logostring
stateRugbyMatchStateResponserequired2 fields
descriptionstringrequiredState of the match.Not startedFirst halfHalf timeSecond halfExtra timeBreak timePenaltiesSuspendedInterruptedFinishedFinished after extra timePostponedCancelledAbandonedAwardedUnknownTo be announced
scorestringHome - Away match score.
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/28.png",
    "title": "HIGHLIGHTS | Italy v Scotland | Under-20 Six Nations Championship 2024",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/213123safas132e",
    "embedUrl": "https://example.com/embed/13efe2g4t542",
    "match": {
      "id": 36224450,
      "week": "4",
      "date": "2024-03-08T19:15:00.000Z",
      "country": {
        "code": "EU",
        "name": "Europe",
        "logo": "https://example.com/logos/country/EU.png"
      },
      "awayTeam": {
        "id": 384585,
        "logo": "https://example.com/logos/team/90990.png",
        "name": "Italy U20"
      },
      "homeTeam": {
        "id": 384585,
        "logo": "https://example.com/logos/team/90990.png",
        "name": "Italy U20"
      },
      "league": {
        "id": 48440,
        "season": 2024,
        "name": "Six Nations U20",
        "logo": "https://example.com/logos/league/48440.png"
      },
      "state": {
        "description": "Finished",
        "score": "47 - 14"
      }
    },
    "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.