Download OpenAPI specification:Download
The API provides a standardized way for developers to interact with the service and retrieve hockey data. With this API, users can request highlights based on various parameters such as team, country, match, or specific timeframes. The specification defines the endpoints and their corresponding operations, such as retrieving a list of all available highlights, retrieving a specific highlight by its ID, filtering highlights based on specific criteria, and more. The API specification also includes detailed information about the data models used, such as the structure of a highlight object, including properties like title, description, teams involved, players featured, and video URLs. In addition to the basic functionality, the API specification may also include optional features such as pagination for retrieving large result sets, sorting and filtering options, and authentication mechanisms for secure access to the API.
Retrieve country details by country code.
countryCode required | string Example: DE A string value code of the country, following the ISO 3166 standard. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[
]
Retrieve a list of all highlights.
countryCode | string Example: countryCode=DE Country code specified by the ISO 3166 standard. |
countryName | string Example: countryName=Germany |
leagueName | string Example: leagueName=DEL |
leagueId | number Example: leagueId=16953 |
date | string Example: date=2023-10-13 Date that follows the YYYY-MM-DD format. |
timezone | object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier. |
season | number Example: season=2023 |
matchId | number Example: matchId=291869956 |
homeTeamId | number Example: homeTeamId=223746 |
awayTeamId | number Example: awayTeamId=214385 |
homeTeamName | string Example: homeTeamName=Frankfurt Lowen |
awayTeamName | string Example: awayTeamName=Kolner |
limit | object [ 0 .. 40 ] Default: 40 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 16,
- "type": "VERIFIED",
- "title": "DEL: Frankfurt Lowen vs Kolner",
- "description": "Game recap of the match.",
- "match": {
- "id": 291869956,
- "week": "1",
- "date": "2023-10-13T17:30:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "state": {
- "description": "1st period",
- "score": {
- "current": "4 - 4",
- "overTime": "6 - 4",
- "penalties": "17 - 33",
- "firstPeriod": "2 - 0",
- "secondPeriod": "2 - 1",
- "thirdPeriod": "5 - 2"
}
}
}, - "channel": "Ligue 1 Uber Eats",
- "source": "youtube"
}
], - "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"
}
}
Retrieve applied geo restrictions to the given highlight id.
id required | number Example: 16 Requested higlight id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "state": "Allowed countries restriction",
- "allowedCountries": [
- "IT"
], - "blockedCountries": [ ],
- "embeddable": true
}
Retrieve highlight details by highlight id.
id required | number Example: 16 Requested higlight id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 16,
- "type": "VERIFIED",
- "title": "DEL: Frankfurt Lowen vs Kolner",
- "description": "Game recap of the match.",
- "match": {
- "id": 291869956,
- "week": "1",
- "date": "2023-10-13T17:30:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "state": {
- "description": "1st period",
- "score": {
- "current": "4 - 4",
- "overTime": "6 - 4",
- "penalties": "17 - 33",
- "firstPeriod": "2 - 0",
- "secondPeriod": "2 - 1",
- "thirdPeriod": "5 - 2"
}
}
}, - "channel": "Ligue 1 Uber Eats",
- "source": "youtube"
}
]
Retrieve a list of all leagues.
limit | object [ 0 .. 100 ] Default: 100 Example: limit=100 |
offset | object >= 0 Default: 0 |
season | number >= 0 Example: season=2023 |
leagueName | string Example: leagueName=DEL |
countryCode | string Example: countryCode=DE Country code specified by the ISO 3166 standard. |
countryName | string Example: countryName=Germany |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 16953,
- "name": "DEL",
- "seasons": [
- {
- "season": 2023
}
]
}
], - "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"
}
}
Retrieve league details by league id.
id required | number Example: 16953 Requested league id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 16953,
- "name": "DEL",
- "seasons": [
- {
- "season": 2023
}
]
}
]
Retrieve a list of all matches. At least one parameter has to be specified.
leagueName | string Example: leagueName=DEL |
leagueId | number Example: leagueId=16953 |
date | string Example: date=2023-10-13 Date that follows the YYYY-MM-DD format. |
timezone | object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier. |
season | number Example: season=2023 |
homeTeamId | number Example: homeTeamId=223746 |
awayTeamId | number Example: awayTeamId=214385 |
homeTeamName | string Example: homeTeamName=Frankfurt Lowen |
awayTeamName | string Example: awayTeamName=Kolner |
countryCode | string Example: countryCode=DE |
countryName | string Example: countryName=Germany |
limit | object [ 0 .. 100 ] Default: 100 Example: limit=100 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 291869956,
- "week": "1",
- "date": "2023-10-13T17:30:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "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"
}
}
Retrieve match details by match id.
id required | number Example: 308606573 Requested match id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 308606573,
- "week": "Quarter-finals",
- "date": "2024-03-30T15:00:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "state": {
- "description": "1st period",
- "score": {
- "current": "4 - 4",
- "overTime": "6 - 4",
- "penalties": "17 - 33",
- "firstPeriod": "2 - 0",
- "secondPeriod": "2 - 1",
- "thirdPeriod": "5 - 2"
}
}, - "venue": {
- "city": "Swansea",
- "name": "Liberty Stadium",
- "country": "Wales",
- "capacity": "20827"
}, - "referee": {
- "name": "Brace, Andrew",
- "nationality": "Ireland"
}, - "forecast": {
- "status": "cloudy",
- "temperature": "11.97°C"
}
}
]
Retrieve a list of all teams.
limit | object [ 0 .. 500 ] Default: 500 Example: limit=50 |
offset | object >= 0 Default: 0 |
name | string Example: name=Frankfurt Lowen |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
], - "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"
}
}
Retrieve team details by team id.
id required | number Example: 223746 Requested team id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[
]
Retrieve a list of all bookmakers based on passed query parameters.
name | object Example: name=Stake.com |
limit | number [ 0 .. 100 ] Default: 20 Example: limit=20 |
offset | number >= 0 Default: 0 |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 1,
- "name": "Stake.com"
}
], - "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"
}
}
Retrieve bookmaker details by bookmaker id.
id required | number Example: 1 Requested bookmaker id. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "name": "Stake.com"
}
]
Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.
leagueId | number Example: leagueId=50142 |
leagueName | string Example: leagueName=AHL |
timezone | object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier. |
bookmakerId | number Example: bookmakerId=19 |
limit | number [ 0 .. 5 ] Default: 5 Example: limit=5 |
offset | number >= 0 Default: 0 |
matchId | number Example: matchId=295119925 |
bookmakerName | string Example: bookmakerName=1Bet |
date | string Example: date=2024-03-26 Date that follows the YYYY-MM-DD format. |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "matchId": 295119925,
- "odds": [
- {
- "bookmakerId": 19,
- "bookmakerName": "1Bet",
- "type": "prematch",
- "market": "3-Way Moneyline",
- "values": [
- {
- "odd": 2.2,
- "value": "Home"
}
]
}
]
}
], - "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"
}
}
Retrieve a list of last five games played for given team id.
teamId required | number Example: teamId=214385 |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 291869956,
- "week": "1",
- "date": "2023-10-13T17:30:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "state": {
- "description": "1st period",
- "score": {
- "current": "4 - 4",
- "overTime": "6 - 4",
- "penalties": "17 - 33",
- "firstPeriod": "2 - 0",
- "secondPeriod": "2 - 1",
- "thirdPeriod": "5 - 2"
}
}
}
]
Retrieve a list of head 2 head games played for given team ids.
teamIdOne required | number Example: teamIdOne=214385 |
teamIdTwo required | number Example: teamIdTwo=223746 |
x-rapidapi-host required | string hockey-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 291869956,
- "week": "1",
- "date": "2023-10-13T17:30:00.000Z",
- "awayTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "homeTeam": {
- "id": 223746,
- "name": "Frankfurt Lowen"
}, - "league": {
- "id": 16953,
- "season": 2023,
- "name": "DEL",
}, - "state": {
- "description": "1st period",
- "score": {
- "current": "4 - 4",
- "overTime": "6 - 4",
- "penalties": "17 - 33",
- "firstPeriod": "2 - 0",
- "secondPeriod": "2 - 1",
- "thirdPeriod": "5 - 2"
}
}
}
]