HIhighlightly
Handball.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 halfMatch is considered in play and is in the first half.
Second halfMatch is considered in play and is in the second half.
Half timeHalf time pause between first and second half.
Extra timeGame was considered a draw in normal time. Additional extra time is needed to decide the winner.
Break timeShort pause between in play periods and extra time.
PenaltiesPenalty shootout to decide the winner of the match.
FinishedMatch has been concluded.
Finished after penaltiesMatch has been concluded with the penalty shootout.
Finished after extra timeMatch has been concluded in extra 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.
SuspendedMatch has already been in play but was suspended. In the future the game will resume from the exact point where it was halted.
CancelledGame will not be played.
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.
InterruptedAn issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned.
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:

Handball matches example

get/handball/matches

Request

Query parameters

leagueNamestring
Example:Handball Bundesliga Frauen
leagueIdnumber
Example:36526
datestring
Example:2023-12-27

Date that follows the YYYY-MM-DD format.

timezonestring
Example:Europe/London

Valid timezone identifier.

seasonnumber
Example:2023
homeTeamIdnumber
Example:302038
awayTeamIdnumber
Example:332674
homeTeamNamestring
Example:Bensheim-Auerbach Women
awayTeamNamestring
Example:Solingen Women
countryCodestring
Example:DE
countryNamestring
Example:Germany
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": 126347903,
      "date": "2023-12-27T18:30:00.000Z",
      "country": {
        "code": "DE",
        "name": "Germany",
        "logo": "https://example.com/logos/country/DE.png"
      },
      "awayTeam": {
        "id": 332674,
        "logo": "https://example.com/logos/team/332674.png",
        "name": "Solingen W"
      },
      "homeTeam": {
        "id": 332674,
        "logo": "https://example.com/logos/team/332674.png",
        "name": "Solingen W"
      },
      "league": {
        "id": 36526,
        "season": 2023,
        "name": "1. Bundesliga Women",
        "logo": "https://example.com/logos/league/36526.png"
      },
      "state": {
        "description": "Finished",
        "score": {
          "current": "26 - 26",
          "firstHalf": "13 - 15",
          "secondHalf": "13 - 11"
        }
      }
    }
  ],
  "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.