Download OpenAPI specification:Download
The API provides a standardized way for developers to interact with the service and retrieve football 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: FR A string value code of the country, following the ISO 3166 standard. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[
]
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=Superettan |
countryCode | string Example: countryCode=SE Country code specified by the ISO 3166 standard. |
countryName | string Example: countryName=Sweden |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 104,
- "name": "UEFA Champions League",
- "seasons": [
- {
- "season": 2022
}
]
}
], - "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: 97798 Requested league id. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 104,
- "name": "UEFA Champions League",
- "seasons": [
- {
- "season": 2022
}
]
}
]
Retrieve a list of all teams.
limit | object [ 0 .. 500 ] Default: 500 Example: limit=50 |
offset | object >= 0 Default: 0 |
name | string Example: name=Skövde AIK |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "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: 5700782 Requested team id. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[
]
Retrieve a list of all matches. At least one parameter has to be specified.
leagueName | string Example: leagueName=Superettan |
leagueId | number Example: leagueId=97798 |
date | string Example: date=2023-08-06 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=5700782 |
awayTeamId | number Example: awayTeamId=1907875 |
homeTeamName | string Example: homeTeamName=Skövde AIK |
awayTeamName | string Example: awayTeamName=Vasteras SK FK |
countryCode | string Example: countryCode=SE Country code specified by the ISO 3166 standard. |
countryName | string Example: countryName=Sweden |
limit | object [ 0 .. 100 ] Default: 100 Example: limit=100 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 489389,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}
}
], - "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: 1002433681 Requested match id. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1002433681,
- "round": "Apertura - 9",
- "date": "\"2024-03-31T20:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}, - "referee": {
- "name": "Brace, Andrew",
- "nationality": "Ireland"
}, - "venue": {
- "city": "Swansea",
- "name": "Liberty Stadium",
- "country": "Wales",
- "capacity": "20827"
}, - "forecast": {
- "status": "cloudy",
- "temperature": "11.97°C"
}
}
]
Retrieve a list of all highlights.
countryCode | string Example: countryCode=SE Country code specified by the ISO 3166 standard. |
countryName | string Example: countryName=Sweden |
leagueName | string Example: leagueName=Superettan |
leagueId | number Example: leagueId=97798 |
date | string Example: date=2023-08-06 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=853061055 |
homeTeamId | number Example: homeTeamId=5700782 |
awayTeamId | number Example: awayTeamId=1907875 |
homeTeamName | string Example: homeTeamName=Skövde AIK |
awayTeamName | string Example: awayTeamName=Vasteras SK FK |
limit | object [ 0 .. 40 ] Default: 40 |
offset | object >= 0 Default: 0 |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "id": 1,
- "type": "VERIFIED",
- "title": "Ligue 1: Lyon vs Reims",
- "description": "Game recap of the match.",
- "match": {
- "id": 489389,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}
}, - "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: 125344 Requested higlight id. |
x-rapidapi-host required | string football-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: 7082 Requested higlight id. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 1,
- "type": "VERIFIED",
- "title": "Ligue 1: Lyon vs Reims",
- "description": "Game recap of the match.",
- "match": {
- "id": 489389,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}
}, - "channel": "Ligue 1 Uber Eats",
- "source": "youtube"
}
]
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 football-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 football-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=35675 |
leagueName | string Example: leagueName=League One |
timezone | object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier. |
bookmakerId | number Example: bookmakerId=1 |
limit | number [ 0 .. 5 ] Default: 5 Example: limit=5 |
offset | number >= 0 Default: 0 |
matchId | number Example: matchId=884822928 |
bookmakerName | string Example: bookmakerName=Stake.com |
date | string Example: date=2024-03-23 Date that follows the YYYY-MM-DD format. |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "data": [
- {
- "matchId": 884822928,
- "odds": [
- {
- "bookmakerId": 1,
- "bookmakerName": "Stake.com",
- "type": "prematch",
- "market": "Full Time Result",
- "values": [
- {
- "odd": 6.6,
- "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 current league standings for a specific season.
leagueId | number Example: leagueId=33973 |
season | number Example: season=2023 |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
{- "groups": [
- {
- "name": "Premier League - Regular Season",
- "standings": [
- {
- "away": {
- "wins": 11,
- "draws": 4,
- "games": 17,
- "loses": 5,
- "scoredGoals": 28,
- "receivedGoals": 27
}, - "home": {
- "wins": 11,
- "draws": 4,
- "games": 17,
- "loses": 5,
- "scoredGoals": 28,
- "receivedGoals": 27
}, - "total": {
- "wins": 11,
- "draws": 4,
- "games": 17,
- "loses": 5,
- "scoredGoals": 28,
- "receivedGoals": 27
}, - "points": 63,
- "position": 4
}
]
}
], - "league": {
- "id": 33973,
- "name": "Premier League",
- "season": 2023
}
}
Retrieve a list of last five games played for given team id.
teamId required | number Example: teamId=5700782 |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 489389,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}
}
]
Retrieve a list of head 2 head games played for given team ids.
teamIdOne required | number Example: teamIdOne=314803 |
teamIdTwo required | number Example: teamIdTwo=5700782 |
x-rapidapi-host required | string football-highlights-api.p.rapidapi.com |
x-rapidapi-key required | string Rapid API Token |
[- {
- "id": 489389,
- "round": "Regular Season - 32",
- "date": "2023-05-20T15:30:00.000Z",
- "league": {
- "id": 133,
- "season": 2023,
- "name": "Ligue 1",
}, - "state": {
- "description": "Second half",
- "clock": 67,
- "score": {
- "current": "3 - 1",
- "penalties": "6 - 4"
}
}
}
]