Cricket API / highlights

Get highlight by ID

GET https://cricket.highlightly.net/highlights/{id} Cricket API
GET https://sports.highlightly.net/cricket/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://cricket.highlightly.net/highlights/{id}' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const response = await fetch('https://cricket.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://cricket.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.
matchCricketMatchResponserequired35 fields
idstringrequired
endDatestringrequired
startDatestringrequired
startTimestring
countryCricketCountryResponserequired3 fields
codestringrequiredCountry code specified by the ISO 3166 standard.
namestringrequired
logostringrequired
awayTeamCricketTeamResponserequired4 fields
idstringrequired
logostring
namestringrequired
abbreviationstringrequired
homeTeamCricketTeamResponserequired4 fields
idstringrequired
logostring
namestringrequired
abbreviationstringrequired
leagueCricketMatchLeagueResponserequired4 fields
idstringrequired
seasonnumberrequired
namestringrequired
logostring
formatstringCricket match format, e.g. T20, ODI, TEST
dayTypestringInformation that tells us whether the match will be played across multiple daysSINGLEMULTI
stateCricketMatchStateResponserequired9 fields
descriptionstringrequiredState of the match.FinishedUnknownNo live coverageIn playStumpsLunchInnings breakDrinksTimeoutTeaScheduledMatch delayedCancelledAbandonedPostponed
reportstringDescriptive report of the match based on the match status.
teamsCricketMatchScoreTeamsrequired6 fields
awayCricketMatchScoreTeamAwayrequired2 fields
infostring
scorestring
homeCricketMatchScoreTeamHomerequired2 fields
infostring
scorestring
channelstringChannel title of a given highlight.
sourcestringAggregation source from social media and other equivalent platforms.
categorystringAssumed highlight category

Example response

200 application/json 
[
  {
    "id": 75,
    "type": "VERIFIED",
    "imgUrl": "https://example.com/images/preview/75.png",
    "title": "Big Bash League: Melbourne Renegades vs Melbourne Stars",
    "description": "Game recap of the match.",
    "url": "https://example.com/highlight/213123safas132e",
    "embedUrl": "https://example.com/embed/213123safas132e",
    "match": {
      "id": "48514657",
      "endDate": "2024-01-13T00:00:00.000Z",
      "startDate": "2024-01-13T00:00:00.000Z",
      "startTime": "2024-01-13T14:30:00.000Z",
      "country": {
        "code": "AU",
        "name": "Australia",
        "logo": "https://example.com/logos/country/AU.png"
      },
      "awayTeam": {
        "id": "17838627",
        "logo": "https://example.com/logos/team/17838627.png",
        "name": "Melbourne Stars",
        "abbreviation": "MS"
      },
      "homeTeam": {
        "id": "17838627",
        "logo": "https://example.com/logos/team/17838627.png",
        "name": "Melbourne Stars",
        "abbreviation": "MS"
      },
      "league": {
        "id": "48513362",
        "season": 2023,
        "name": "Big Bash League",
        "logo": "https://example.com/logos/league/48513362.png"
      },
      "format": "T20",
      "dayType": "SINGLE",
      "state": {
        "description": "Finished",
        "report": "Renegades won by 6 wickets (with 16 balls remaining)",
        "teams": {
          "away": {
            "info": "17.2/20 ov, T:138",
            "score": "139/4"
          },
          "home": {
            "info": null,
            "score": "137/8"
          }
        }
      }
    },
    "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.