Cricket API / matches

Matches

GET https://cricket.highlightly.net/matches Cricket API
GET https://sports.highlightly.net/cricket/matches All Sports API

Retrieve a list of matches.

Refresh interval
Once a minute
Pagination
limit and offset
Detail
General information only

Querying

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

Combine timezone with date to get matches relevant to your own location rather than UTC. Team and league filters accept ids, which come from teams and leagues, as well as names and team abbreviations.

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

One day or several

A match can carry a dayType, which tells you whether it will be played across multiple days.

Day type Meaning
SINGLE The match is played on a single day.
MULTI The match is played across multiple days.

The format is a separate field. Where present, format names it, for example T20, ODI or TEST.

In a multi day match Stumps marks the end of a day's play, so a long pause is not the end of the game.

Match states

State Meaning
Scheduled The match is planned and scheduled to be played.
In play The match is currently in progress.
Innings break The interval between the end of one innings and the start of the next.
Drinks A short break for players to have drinks.
Lunch The break taken during lunch time in a match.
Tea The break taken during tea time, typically in Test matches.
Stumps The end of a day's play in a multi day match.
Timeout A strategic break taken during the match.
Match delayed The start or continuation is delayed, often due to weather or other interruptions.
Finished Match has been concluded.
Abandoned The match has started but is stopped and will not continue, typically due to weather or other uncontrollable circumstances.
Cancelled The match has been cancelled and will not be played.
Postponed Prevented from being played. The start time moves to a future moment.
No live coverage There is no live coverage for the match.
Unknown The status of the match is not known.

Cricket matches rendered in a client application

Parameters

Parameter Type Description
leagueNameoptional string No description in the spec.e.g. Big Bash League
leagueIdoptional number No description in the spec.e.g. 48513362
dateoptional string Date that follows the YYYY-MM-DD format.e.g. 2024-01-13
timezoneoptional stringdefault Etc/UTC Valid timezone identifier.e.g. Europe/London
seasonoptional number No description in the spec.e.g. 2023
homeTeamIdoptional number No description in the spec.e.g. 17838627
awayTeamIdoptional number No description in the spec.e.g. 17838662
homeTeamNameoptional string No description in the spec.e.g. Melbourne Renegades
awayTeamNameoptional string No description in the spec.e.g. Melbourne Stars
countryCodeoptional string No description in the spec.e.g. AU
countryNameoptional string No description in the spec.e.g. Australia
limitoptional numberdefault 100 No description in the spec.e.g. 100
offsetoptional numberdefault 0 No description in the spec.e.g. 0
homeTeamAbbreviationoptional string No description in the spec.e.g. MR
awayTeamAbbreviationoptional string No description in the spec.e.g. MS

Request

curl --request GET \
  --url 'https://cricket.highlightly.net/matches?leagueName=Big%20Bash%20League&leagueId=48513362' \
  --header 'x-rapidapi-key: YOUR_API_KEY'
const params = new URLSearchParams({
  leagueName: 'Big Bash League',
  leagueId: '48513362'
})
const response = await fetch(`https://cricket.highlightly.net/matches?${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/matches',
    params={
        'leagueName': 'Big Bash League',
        'leagueId': '48513362',
    },
    headers={
        'x-rapidapi-key': os.environ['HIGHLIGHTLY_API_KEY'],
    },
    timeout=10,
)

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

Response

dataCricketMatchResponse[]required35 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
paginationPaginationResponserequired3 fields
totalCountnumberrequiredAvailable number of items, relevant to the provided query.
offsetnumberrequired
limitnumberrequired
planPlanResponserequired2 fields
tierstringrequiredYour current API subscription tier.
messagestringrequiredExplanation message regarding your current tier.

Example response

200 application/json 
{
  "data": [
    {
      "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"
          }
        }
      }
    }
  ],
  "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

Status Description
400 Bad request descriptive error.
500 Internal server error.