Football API / highlights

Get highlight by ID

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

Parameters

Parameter Type Description
idrequired numberpath Requested highlight id.

Request

curl --request GET \
  --url 'https://soccer.highlightly.net/highlights/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://soccer.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://soccer.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.
matchMatchResponserequired28 fields
idnumberrequired
roundstringrequired
datestringrequired
countryCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamTeamResponserequired4 fields
idnumberrequired
logostring
namestringrequired
typestringclubnational
homeTeamTeamResponserequired4 fields
idnumberrequired
logostring
namestringrequired
typestringclubnational
leagueMatchLeagueResponserequired4 fields
idnumberrequired
seasonnumberrequired
namestringrequired
logostring
stateMatchStateResponserequired5 fields
descriptionstringrequiredState of the match.To be announcedNot startedFirst halfHalf timeSecond halfExtra timeBreak timePenaltiesSuspendedInterruptedFinishedFinished after penaltiesFinished after extra timePostponedCancelledAbandonedAwardedIn progressUnknown
clocknumberCurrent minute of the match.
scoreMatchScoreResponserequired2 fields
currentstringHome - Away score up to penalties.
penaltiesstringHome - Away team score after the penalties phase.
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": "Ligue 1: Lyon vs Reims",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/29g9urg92387",
    "embedUrl": "https://example.com/embed/213123safas132e",
    "match": {
      "id": 489389,
      "round": "Regular Season - 32",
      "date": "2023-05-20T15:30:00.000Z",
      "country": {
        "code": "FR",
        "name": "France",
        "logo": "https://example.com/logos/country/FR.png"
      },
      "awayTeam": {
        "id": 553,
        "logo": "https://example.com/logos/team/553.png",
        "name": "Montpellier",
        "type": "club"
      },
      "homeTeam": {
        "id": 553,
        "logo": "https://example.com/logos/team/553.png",
        "name": "Montpellier",
        "type": "club"
      },
      "league": {
        "id": 133,
        "season": 2023,
        "name": "Ligue 1",
        "logo": "https://example.com/logos/league/133.png"
      },
      "state": {
        "description": "Second half",
        "clock": 67,
        "score": {
          "current": "3 - 1",
          "penalties": "6 - 4"
        }
      }
    },
    "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.