Getting started

Before your first request, you will need an API key. Send it in the x-rapidapi-key header with every request.

Your first request

Cricket data comes with two subscriptions. A Cricket API subscription covers cricket alone. An All Sports API subscription covers cricket and all other sports. Both are available on Highlightly and on RapidAPI, as the Cricket API and the All Sports API.

Once you have a key, look up a league. The request below uses the Cricket API base URL on Highlightly.

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()

With an All Sports API subscription, send the same request to https://sports.highlightly.net/cricket/leagues. On Highlightly your API key stays the same and only the base URL changes. Through RapidAPI, use the key, base URL and x-rapidapi-host value for your All Sports API subscription, listed in Authentication.

If the request returns data, you are set up correctly. A 403 means the x-rapidapi-key header is missing. A 401 means the key was not accepted, so check it against the key in your account. On RapidAPI, use the API key issued for the Cricket API.

Finding your way around

Under Endpoints each resource lists its own operations. Every endpoint page carries its parameters, a request in three languages, and the full response shape with nested objects expanded in place.

A note on ids

Many endpoints take an id, such as leagueId or homeTeamId. Fetch leagues or teams once, store the ids you care about, and use those. Some endpoints also accept a name, such as leagueName or homeTeamName, but an id refers to exactly one league or team.

OpenAPI specification

Import the OpenAPI 3.0 document into Postman or Insomnia, or generate a client from it.