Highlights

Highlights are the core of the Cricket API. They cover everything from a single six through to full innings recaps, complete match replays and post match interviews.

Refresh interval

Once a minute

Plan

May be restricted on Basic/Free

Pagination

limit and offset, up to 40 per page

Verified and unverified clips

Clips are aggregated from many different platforms. Depending on the source and what verification it has been through, each one falls into one of two types.

Reading a highlight

Every highlight carries a title describing what the video shows. Certain highlights also carry a description that expands on it.

The source field records where the clip was aggregated from, for example youtube, twitter, reddit or espn. For some sources a channel is present as well, which is the uploading channel's title. Together these let you narrow down which videos you want to show. Where embedUrl is present you can embed the video directly in your own site or app.

Categories

The category field describes what kind of content the clip contains. Categorisation happens automatically when a highlight is aggregated. A clip that cannot be placed confidently is labelled other rather than being forced into a category it does not belong to, so filtering on category in your own code will not return unrelated content.

Plan coverage

Highlights come from every league this API covers, on every plan.

Querying

At least one primary query parameter must be specified before you can retrieve data. timezone, limit and offset are considered secondary and do not count on their own.

Combine timezone with date to get highlights relevant to your own location rather than UTC.

limit sets how many highlights come back. When the number of matching highlights exceeds it, request the next page by increasing offset. The pagination object in every response tells you the totalCount to page through.

Parameters

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/highlights?countryCode=AU&countryName=Australia' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  countryCode: 'AU',
  countryName: 'Australia'
})
const response = await fetch(`https://cricket.highlightly.net/highlights?${params}`, {
  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',
    params={
        'countryCode': 'AU',
        'countryName': 'Australia',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "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": {}
        }
      },
      "channel": "Ligue 1 Uber Eats",
      "source": "youtube",
      "category": "match-highlights"
    }
  ],
  "pagination": {
    "totalCount": 490,
    "offset": 20,
    "limit": 100
  },
  "plan": {
    "tier": "BASIC",
    "message": "Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"
  }
}

Values are the examples declared in the OpenAPI spec, not a captured live response.

Errors