HIhighlightly
Basketball.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
Not startedMatch has not been started yet.
First quarterMatch is considered in play and is in the first period.
Second quarterMatch is considered in play and is in the second period.
Third quarterMatch is considered in play and is in the third period.
Fourth quarterMatch is considered in play and is in the fourth period.
Over timeGame was considered a draw in normal time. Additional extra time is needed to decide the winner.
Break timeRegulation period between quarters or over time.
Half timeHalf time pause between second and third quarter.
FinishedMatch has been concluded.
Finished after over timeMatch has been concluded in over time.
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.
CancelledGame will not be played.
SuspendedMatch has already been in play but was suspended. In the future the game will resume from the exact point where it was halted.
AwardedGame awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc.
AbandonedConsidered "abandoned" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game might be resumed from the exact point where it was halted.
UnknownUnknown match coverage or state.
To be announcedMatch's start time will be updated or competing teams are not yet known.

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

Basketball matches example

get/basketball/matches

Request

Query parameters

leagueNamestring
Example:NBL
leagueIdnumber
Example:1635
datestring
Example:2023-10-01

Date that follows the YYYY-MM-DD format.

timezonestring
Example:Europe/London

Valid timezone identifier.

seasonnumber
Example:2023
homeTeamIdnumber
Example:7592
awayTeamIdnumber
Example:1635
homeTeamNamestring
Example:Adelaide
awayTeamNamestring
Example:Melbourne United
countryCodestring
Example:AU
countryNamestring
Example:Australia
limitnumber
Example:100
offsetnumber

Headers

x-rapidapi-hoststring required

sport-highlights-api.p.rapidapi.com

x-rapidapi-keystring required

Rapid API Token

Response

Example response

{
  "data": [
    {
      "id": 489389,
      "week": "1",
      "stage": "Final",
      "date": "2023-10-01T03:00:00.000Z",
      "country": {
        "code": "AU",
        "name": "Australia",
        "logo": "https://example.com/logos/country/AU.png"
      },
      "awayTeam": {
        "id": 7592,
        "logo": "https://example.com/logos/team/7592.png",
        "name": "Adelaide"
      },
      "homeTeam": {
        "id": 7592,
        "logo": "https://example.com/logos/team/7592.png",
        "name": "Adelaide"
      },
      "league": {
        "id": 1635,
        "season": 2023,
        "name": "NBL",
        "logo": "https://example.com/logos/league/1635.png"
      },
      "state": {
        "description": "Finished",
        "clock": 9,
        "score": {
          "current": "105 - 104",
          "q1": "22 - 15",
          "q2": "17 - 33",
          "q3": "11 - 27",
          "q4": "33 - 14",
          "overTime": "22 - 15"
        }
      }
    }
  ],
  "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.