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:
| State | Description |
|---|---|
| Not started | Match has not been started yet. |
| 1st period | Match is in the first period of regular play. |
| 2nd period | Match is in the second period of regular play. |
| 3nd period | Match is in the third period of regular play. |
| Over time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |
| Break time | Short pause between in play periods and over time. |
| Penalties | Penalty shootout to decide the winner of the match. |
| Finished | Match has been concluded. |
| Finished after penalties | Match has been concluded with the penalty shootout. |
| Finished after over time | Match has been concluded in over time. |
| Postponed | Match 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. |
| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |
| Cancelled | Game will not be played. |
| Awarded | Game 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. |
| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |
| Abandoned | Considered "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. |
| Unknown | Unknown match coverage or state. |
| To be announced | Match'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:
Request
- Base URLhttps://sports.highlightly.net
- Authnone declared. Required headers: x-rapidapi-host, x-rapidapi-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Date that follows the YYYY-MM-DD format.
Valid timezone identifier.
Headers
sport-highlights-api.p.rapidapi.com
Rapid API Token
Response
Example response
{
"data": [
{
"id": 291869956,
"week": "1",
"date": "2023-10-13T17:30:00.000Z",
"country": {
"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"awayTeam": {
"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
},
"homeTeam": {
"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
},
"league": {
"id": 16953,
"season": 2023,
"name": "DEL",
"logo": "https://example.com/logos/league/16953.png"
},
"state": {
"description": "1st period",
"score": {
"current": "4 - 4",
"overTime": "6 - 4",
"penalties": "17 - 33",
"firstPeriod": "2 - 0",
"secondPeriod": "2 - 1",
"thirdPeriod": "5 - 2"
}
}
}
],
"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.