Leagues

Retrieve a list of leagues.

Refresh interval

Multiple times a day

Pagination

limit and offset

Use leagueName to check whether a specific league exists, or to fetch just its record. Narrow further with countryCode or countryName, both of which come from countries.

limit sets how many leagues come back. When the number of matching leagues exceeds it, request the next page by increasing offset. See Pagination and limits.

Leagues carry their seasons

Each league record includes the seasons it has data for. That matters because standings requires both a leagueId and a season, and the season values come from here.

The usual sequence is to fetch a league once, store its id and the seasons you care about, then query the other endpoints with those values rather than by name. Name filters work, but an id matches exactly where a name is a guess at spelling.

Parameters

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/leagues?season=2023&leagueName=Big%20Bash%20League' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

const params = new URLSearchParams({
  season: '2023',
  leagueName: 'Big Bash League'
})
const response = await fetch(`https://cricket.highlightly.net/leagues?${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/leagues',
    params={
        'season': '2023',
        'leagueName': 'Big Bash League',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

Example response

{
  "data": [
    {
      "id": "48513362",
      "logo": "https://example.com/logos/league/1635.png",
      "name": "Big Bash League",
      "country": {
        "code": "AU",
        "name": "Australia",
        "logo": "https://example.com/logos/country/AU.png"
      },
      "seasons": [
        {
          "season": 2023
        }
      ]
    }
  ],
  "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