HIhighlightly
Cricket.Matches

Get all matches

Refresh interval: Once a minute

Route returns only general match information. For additional match details check the matches/{matchId} route.

Retrieve a list of matches based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get matches relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned matches will be. If the number of actual matches is above the limit value you can make subsequent requests by increasing the offset value.

Matches have different possible states they can be in:

StateDescription
FinishedMatch has been concluded.
UnknownThe status of the match is not known.
No live coverageThere is no live coverage for the match.
In playThe match is currently in progress.
StumpsThe end of a day's play in a multi-day match (e.g. Test match).
LunchThe break taken during lunch time in a match.
Innings breakThe interval between the end of one innings and the start of the next.
DrinksA short break for players to have drinks.
TimeoutA strategic break taken during the match.
TeaThe break taken during tea time in a match, typically in Test matches.
ScheduledThe match is planned and scheduled to be played.
Match delayedThe match start or continuation is delayed, often due to weather or other interruptions.
CancelledThe match has been cancelled and will not be played.
PostponedMatch has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future.
AbandonedThe match has started but is stopped and will not continue, typically due to weather or other uncontrollable circumstances.

Below is an example of what you can aim to achieve with the matches endpoint:

Cricket matches example

get/cricket/matches

Request

Query parameters

leagueNamestring
Example:Big Bash League
leagueIdnumber
Example:48513362
datestring
Example:2024-01-13

Date that follows the YYYY-MM-DD format.

timezonestring
Example:Europe/London

Valid timezone identifier.

seasonnumber
Example:2023
homeTeamIdnumber
Example:17838627
awayTeamIdnumber
Example:17838662
homeTeamNamestring
Example:Melbourne Renegades
awayTeamNamestring
Example:Melbourne Stars
countryCodestring
Example:AU
countryNamestring
Example:Australia
limitnumber
Example:100
offsetnumber
homeTeamAbbreviationstring
Example:MR
awayTeamAbbreviationstring
Example:MS

Headers

x-rapidapi-hoststring required

sport-highlights-api.p.rapidapi.com

x-rapidapi-keystring required

Rapid API Token

Response

Example response

{
  "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": {
            "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.