Highlightly Sports API (4.3.1)

Download OpenAPI specification:Download

The API provides a standardized way for developers to interact with the service and retrieve sport 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.

Sports API

Football.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	string Example: name=France

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: FR

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
}
]

Football.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 104,
"logo": "https://example.com/logos/league/104.png",
"name": "UEFA Champions League",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 97798

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 104,
"logo": "https://example.com/logos/league/104.png",
"name": "UEFA Champions League",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"seasons": [{"season": 2022
}
]
}
]

Football.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Skövde AIK

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 5700782

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
}
]

Football.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 489389,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 1002433681

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1002433681,
"round": "Apertura - 9",
"date": "\"2024-03-31T20:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"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"
}
}
]

Football.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "Ligue 1: Lyon vs Reims",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/29g9urg92387",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"id": 489389,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 125344

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 7082

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "Ligue 1: Lyon vs Reims",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/29g9urg92387",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"id": 489389,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"state": {"description": "Second half",
"clock": 67,
"score": {"current": "3 - 1",
"penalties": "6 - 4"
}
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Football.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Stake.com
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 1

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Stake.com"
}
]

Football.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

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.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Football.Standings

Get league standings.

Retrieve current league standings for a specific season.

query Parameters

leagueId	number Example: leagueId=33973
season	number Example: season=2023

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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
},
"team": {"id": 56950,
"logo": "https://example.com/logos/team/56950.png",
"name": "Aston Villa"
},
"total": {"wins": 11,
"draws": 4,
"games": 17,
"loses": 5,
"scoredGoals": 28,
"receivedGoals": 27
},
"points": 63,
"position": 4
}
]
}
],
"league": {"id": 33973,
"logo": "https://example.com/logos/league/33973.png",
"name": "Premier League",
"season": 2023
}
}

Football.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=5700782

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 489389,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"state": {"description": "Second half",
"clock": 67,
"score": {"current": "3 - 1",
"penalties": "6 - 4"
}
}
}
]

Football.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=314803
teamIdTwo required	number Example: teamIdTwo=5700782

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 489389,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"country": {"code": "FR",
"name": "France",
"logo": "https://example.com/logos/country/FR.png"
},
"awayTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"homeTeam": {"id": 553,
"logo": "https://example.com/logos/team/553.png",
"name": "Montpellier"
},
"league": {"id": 133,
"season": 2023,
"name": "Ligue 1",
"logo": "https://example.com/logos/league/133.png"
},
"state": {"description": "Second half",
"clock": 67,
"score": {"current": "3 - 1",
"penalties": "6 - 4"
}
}
}
]

American Football.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

name	object Example: name=Miners
displayName	object Example: displayName=UTEP Miners
abbreviation	object Example: abbreviation=UTEP
league	object Example: league=NCAA

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO",
"league": "NFL"
}
]

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 21

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO",
"league": "NFL"
}
]

American Football.Matches

Get all matches.

Retrieve a list of all matches.

query Parameters

league	object Example: league=NCAA
date	object Example: date=2023-08-26 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2023
homeTeamId	object Example: homeTeamId=21
awayTeamId	object Example: awayTeamId=22
homeTeamName	object Example: homeTeamName=Gamecocks
awayTeamName	object Example: awayTeamName=Miners
homeTeamAbbreviation	object Example: homeTeamAbbreviation=JVST
awayTeamAbbreviation	object Example: awayTeamAbbreviation=UTEP
homeTeamDisplayName	object Example: homeTeamDisplayName=Jacksonville State Gamecocks
awayTeamDisplayName	object Example: awayTeamDisplayName=UTEP Miners
limit	number [ 0 .. 100 ] Default: 100 Example: limit=100
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
}
],
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 39

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
}
]

American Football.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

league	object Example: league=NCAA
date	object Example: date=2023-09-01 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2023
matchId	object Example: matchId=35
homeTeamId	object Example: homeTeamId=69
awayTeamId	object Example: awayTeamId=70
homeTeamName	object Example: homeTeamName=Eagles
awayTeamName	object Example: awayTeamName=Bison
homeTeamAbbreviation	object Example: homeTeamAbbreviation=EMU
awayTeamAbbreviation	object Example: awayTeamAbbreviation=HOW
homeTeamDisplayName	object Example: homeTeamDisplayName=Eastern Michigan Eagles
awayTeamDisplayName	object Example: awayTeamDisplayName=Howard Bison
limit	number [ 0 .. 40 ] Default: 40
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "NFL: New Orleans Saints vs Kansas City Chiefs",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/v23r23fds2cff",
"embedUrl": "https://example.com/embed/v23r23fds2cff",
"match": {"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
},
"channel": "NFL",
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 12774

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 12

Requested highlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "NFL: New Orleans Saints vs Kansas City Chiefs",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/v23r23fds2cff",
"embedUrl": "https://example.com/embed/v23r23fds2cff",
"match": {"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
},
"channel": "NFL",
"source": "youtube"
}
]

American Football.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=21

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
}
]

American Football.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=13
teamIdTwo required	number Example: teamIdTwo=3

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"round": "Regular Season - 32",
"date": "2023-05-20T15:30:00.000Z",
"league": "NFL",
"season": 2023,
"awayTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"homeTeam": {"id": 1,
"logo": "https://example.com/logos/team/111.png",
"name": "Saints",
"displayName": "New Orleans Saints",
"abbreviation": "NO"
},
"state": {"period": 2,
"clock": 8,
"description": "In progress",
"score": {"current": "21 - 7",
"firstPeriod": "0 - 0",
"secondPeriod": "7 - 7",
"thirdPeriod": "7 - 0",
"fourthPeriod": "7 - 0"
}
}
}
]

Basketball.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Australia

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: AU

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
}
]

Basketball.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

leagueName	object Example: leagueName=NBL
leagueId	object Example: leagueId=1635
date	object Example: date=2023-10-01 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2023
homeTeamId	object Example: homeTeamId=7592
awayTeamId	object Example: awayTeamId=1635
homeTeamName	object Example: homeTeamName=Adelaide
awayTeamName	object Example: awayTeamName=Melbourne United
countryCode	object Example: countryCode=AU
countryName	object Example: countryName=Australia
limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 318831338

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 318831338,
"week": "50",
"stage": "Final",
"date": "2024-03-31T11:35: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"
}
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Basketball.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

countryCode	string Example: countryCode=AU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Australia
leagueName	string Example: leagueName=NBL
leagueId	number Example: leagueId=1635
date	string Example: date=2023-10-01 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=299340885
homeTeamId	number Example: homeTeamId=7592
awayTeamId	number Example: awayTeamId=1635
homeTeamName	string Example: homeTeamName=Adelaide
awayTeamName	string Example: awayTeamName=Melbourne United
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 28,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/28.png",
"title": "NBL: Adelaide vs Melbourne United",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"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"
}
}
},
"channel": "NBA",
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 13

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 28

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 28,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/28.png",
"title": "NBL: Adelaide vs Melbourne United",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"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"
}
}
},
"channel": "NBA",
"source": "youtube"
}
]

Basketball.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
season	number >= 0 Example: season=2023
leagueName	string Example: leagueName=NBL
countryCode	string Example: countryCode=AU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Australia

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1635,
"logo": "https://example.com/logos/league/1635.png",
"name": "NBL",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 1635

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1635,
"logo": "https://example.com/logos/league/1635.png",
"name": "NBL",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"seasons": [{"season": 2023
}
]
}
]

Basketball.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Adelaide

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 7592,
"logo": "https://example.com/logos/team/7592.png",
"name": "Adelaide"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 7592

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 7592,
"logo": "https://example.com/logos/team/7592.png",
"name": "Adelaide"
}
]

Basketball.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Stake.com
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 1

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Stake.com"
}
]

Basketball.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueId	number Example: leagueId=85033
leagueName	string Example: leagueName=Superettan
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=75
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=298649022
bookmakerName	string Example: bookmakerName=Powbet
date	string Example: date=2024-03-23 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": 298649022,
"odds": [{"bookmakerId": 75,
"bookmakerName": "Powbet",
"type": "prematch",
"market": "Total Points 161.5",
"values": [{"odd": 1.75,
"value": "Over"
}
]
}
]
}
],
"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"
}
}

Basketball.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=1635

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"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"
}
}
}
]

Basketball.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=1635
teamIdTwo required	number Example: teamIdTwo=7592

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"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"
}
}
}
]

Basketball.Standings

Get league standings.

Retrieve current league standings for a specific season.

query Parameters

leagueId required	number Example: leagueId=2486
season required	number Example: season=2023

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"groups": [{"name": "Regular Season",
"standings": [{"team": {"id": 14400,
"logo": "https://example.com/logos/team/14400.png",
"name": "Monaco"
},
"wins": 28,
"loses": 4,
"position": 1,
"gamesPlayed": 32,
"scoredPoints": 2759,
"receivedPoints": 2383
}
]
}
],
"league": {"id": 2486,
"logo": "https://example.com/logos/league/2486.png",
"name": "LNB",
"season": 2023
}
}

Hockey.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Germany

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: DE

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
}
]

Hockey.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 16,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/16.png",
"title": "DEL: Frankfurt Lowen vs Kolner",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"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"
}
}
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 16

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 16

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 16,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/16.png",
"title": "DEL: Frankfurt Lowen vs Kolner",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"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"
}
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Hockey.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 16953,
"logo": "https://example.com/logos/league/16953.png",
"name": "DEL",
"country": {"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 16953

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 16953,
"logo": "https://example.com/logos/league/16953.png",
"name": "DEL",
"country": {"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"seasons": [{"season": 2023
}
]
}
]

Hockey.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

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

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 308606573

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 308606573,
"week": "Quarter-finals",
"date": "2024-03-30T15:00: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"
}
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"referee": {"name": "Brace, Andrew",
"nationality": "Ireland"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Hockey.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Frankfurt Lowen

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 223746

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 223746,
"logo": "https://example.com/logos/team/223746.png",
"name": "Frankfurt Lowen"
}
]

Hockey.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Stake.com
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 1

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Stake.com"
}
]

Hockey.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

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.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Hockey.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=214385

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"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"
}
}
}
]

Hockey.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=214385
teamIdTwo required	number Example: teamIdTwo=223746

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"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"
}
}
}
]

Rugby.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Europe

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: EU

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
}
]

Rugby.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

countryCode	string Example: countryCode=EU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Europe
leagueName	string Example: leagueName=Six Nations U20
leagueId	number Example: leagueId=48440
date	string Example: date=2024-03-08 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	number Example: season=2024
matchId	number Example: matchId=36224450
homeTeamId	number Example: homeTeamId=384585
awayTeamId	number Example: awayTeamId=385436
homeTeamName	string Example: homeTeamName=Italy U20
awayTeamName	string Example: awayTeamName=Scotland U20
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/28.png",
"title": "HIGHLIGHTS | Italy v Scotland | Under-20 Six Nations Championship 2024",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 36224450,
"week": "4",
"date": "2024-03-08T19:15:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
}
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 88

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 1034

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/28.png",
"title": "HIGHLIGHTS | Italy v Scotland | Under-20 Six Nations Championship 2024",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 36224450,
"week": "4",
"date": "2024-03-08T19:15:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Rugby.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
season	number >= 0 Example: season=2024
leagueName	string Example: leagueName=Six Nations U20
countryCode	string Example: countryCode=EU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Europe

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 48440,
"logo": "https://example.com/logos/league/48440.png",
"name": "Six Nations U20",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"seasons": [{"season": 2024
}
]
}
],
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 48440

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 48440,
"logo": "https://example.com/logos/league/48440.png",
"name": "Six Nations U20",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"seasons": [{"season": 2024
}
]
}
]

Rugby.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

leagueName	object Example: leagueName=Six Nations U20
leagueId	object Example: leagueId=48440
date	object Example: date=2024-03-08 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2024
homeTeamId	object Example: homeTeamId=384585
awayTeamId	object Example: awayTeamId=385436
homeTeamName	object Example: homeTeamName=Italy U20
awayTeamName	object Example: awayTeamName=Scotland U20
countryCode	object Example: countryCode=EU
countryName	object Example: countryName=Europe
limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 36224450,
"week": "4",
"date": "2024-03-08T19:15:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
}
}
],
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 36125734

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 36125734,
"week": "14",
"date": "2024-03-30T15:00:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"referee": {"name": "Brace, Andrew",
"nationality": "Ireland"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Rugby.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Italy U20

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 384585

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400

Content type

application/json

[{"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
}
]

Rugby.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Marathonbet
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 5,
"name": "Marathonbet"
}
],
"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 5

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 5,
"name": "Marathonbet"
}
]

Rugby.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueId	number Example: leagueId=47589
leagueName	string Example: leagueName=Six Nations Women
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=219
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=34909655
bookmakerName	string Example: bookmakerName=Bets10
date	string Example: date=2024-03-23 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": 34909655,
"odds": [{"bookmakerId": 1,
"bookmakerName": "Bets10",
"type": "prematch",
"market": "Over/Under 58.5",
"values": [{"odd": 1.92,
"value": "Over"
}
]
}
]
}
],
"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"
}
}

Rugby.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=384585

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 36224450,
"week": "4",
"date": "2024-03-08T19:15:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
}
}
]

Rugby.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=385436
teamIdTwo required	number Example: teamIdTwo=384585

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 36224450,
"week": "4",
"date": "2024-03-08T19:15:00.000Z",
"country": {"code": "EU",
"name": "Europe",
"logo": "https://example.com/logos/country/EU.png"
},
"awayTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"homeTeam": {"id": 384585,
"logo": "https://example.com/logos/team/90990.png",
"name": "Italy U20"
},
"league": {"id": 48440,
"season": 2024,
"name": "Six Nations U20",
"logo": "https://example.com/logos/league/48440.png"
},
"state": {"description": "Finished",
"score": "47 - 14"
}
}
]

Handball.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Germany

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: DE

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
}
]

Handball.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

countryCode	string Example: countryCode=DE Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Germany
leagueName	string Example: leagueName=1. Bundesliga Women
leagueId	number Example: leagueId=36526
date	string Example: date=2023-12-27 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=127621850
homeTeamId	number Example: homeTeamId=302038
awayTeamId	number Example: awayTeamId=332674
homeTeamName	string Example: homeTeamName=Bensheim-Auerbach W
awayTeamName	string Example: awayTeamName=Solingen W
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "1. Bundesliga Women: Bensheim-Auerbach W vs Solingen W",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 126347903,
"week": "9",
"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"
}
}
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 53

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 1

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "1. Bundesliga Women: Bensheim-Auerbach W vs Solingen W",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 126347903,
"week": "9",
"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"
}
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Handball.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
season	number >= 0 Example: season=2023
leagueName	string Example: leagueName=1. Bundesliga Women
countryCode	string Example: countryCode=DE Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Germany

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 36526,
"logo": "https://example.com/logos/league/36526.png",
"name": "1. Bundesliga Women",
"country": {"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 36526

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 36526,
"logo": "https://example.com/logos/league/36526.png",
"name": "1. Bundesliga Women",
"country": {"code": "DE",
"name": "Germany",
"logo": "https://example.com/logos/country/DE.png"
},
"seasons": [{"season": 2023
}
]
}
]

Handball.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

leagueName	string Example: leagueName=1. Bundesliga Women
leagueId	number Example: leagueId=36526
date	string Example: date=2023-12-27 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=302038
awayTeamId	number Example: awayTeamId=332674
homeTeamName	string Example: homeTeamName=Bensheim-Auerbach W
awayTeamName	string Example: awayTeamName=Solingen W
countryCode	string Example: countryCode=DE
countryName	string Example: countryName=Germany
limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 126347903,
"week": "9",
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 127484839

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 127484839,
"week": "21",
"date": "2024-04-06T16:00: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"
}
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Handball.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Solingen W

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 332674,
"logo": "https://example.com/logos/team/332674.png",
"name": "Solingen W"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 332674

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 332674,
"logo": "https://example.com/logos/team/332674.png",
"name": "Solingen W"
}
]

Handball.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Stake.com
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 1

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Stake.com"
}
]

Handball.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueId	number Example: leagueId=89288
leagueName	string Example: leagueName=Division de Honor Plata
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=3
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=123121762
bookmakerName	string Example: bookmakerName=22Bet
date	string Example: date=2024-03-26 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": 123121762,
"odds": [{"bookmakerId": 3,
"bookmakerName": "22Bet",
"type": "prematch",
"market": "Full Time Result",
"values": [{"odd": 1.7,
"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"
}
}

Handball.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=302038

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 126347903,
"week": "9",
"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"
}
}
}
]

Handball.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=881569
teamIdTwo required	number Example: teamIdTwo=892632

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 126347903,
"week": "9",
"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"
}
}
}
]

Volleyball.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Italy

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: IT

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
}
]

Volleyball.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

countryCode	string Example: countryCode=IT Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Italy
leagueName	string Example: leagueName=SuperLega
leagueId	number Example: leagueId=83331
date	string Example: date=2023-12-30 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=126347903
homeTeamId	number Example: homeTeamId=630524
awayTeamId	number Example: awayTeamId=631375
homeTeamName	string Example: homeTeamName=Trentino
awayTeamName	string Example: awayTeamName=Cisterna
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "SuperLega: Trentino vs Cisterna",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 126347903,
"week": "12",
"date": "2023-12-30T17:00:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
}
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 93

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 1

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/1.png",
"title": "SuperLega: Trentino vs Cisterna",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/13efe2g4t542",
"embedUrl": "https://example.com/embed/13efe2g4t542",
"match": {"id": 126347903,
"week": "12",
"date": "2023-12-30T17:00:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Volleyball.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
season	number >= 0 Example: season=2023
leagueName	string Example: leagueName=SuperLega
countryCode	string Example: countryCode=IT Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Italy

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 83331,
"logo": "https://example.com/logos/league/83331.png",
"name": "SuperLega",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 83331

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 83331,
"logo": "https://example.com/logos/league/83331.png",
"name": "SuperLega",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"seasons": [{"season": 2023
}
]
}
]

Volleyball.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

leagueName	string Example: leagueName=SuperLega
leagueId	number Example: leagueId=83331
date	string Example: date=2023-12-30 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=630524
awayTeamId	number Example: awayTeamId=631375
homeTeamName	string Example: homeTeamName=Trentino
awayTeamName	string Example: awayTeamName=Cisterna
countryCode	string Example: countryCode=IT
countryName	string Example: countryName=Italy
limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 126347903,
"week": "12",
"date": "2023-12-30T17:00:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
}
}
],
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 139134178

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 139134178,
"week": "Semi-finals",
"date": "2024-04-06T14:30:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Volleyball.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Trentino

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 630524

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
}
]

Volleyball.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Stake.com
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 1

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 1,
"name": "Stake.com"
}
]

Volleyball.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueId	number Example: leagueId=11847
leagueName	string Example: leagueName=AVL
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=2
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=138243181
bookmakerName	string Example: bookmakerName=22Bet
date	string Example: date=2024-03-26 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": 138243181,
"odds": [{"bookmakerId": 2,
"bookmakerName": "22Bet",
"type": "prematch",
"market": "Match Winner",
"values": [{"odd": 3.39,
"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"
}
}

Volleyball.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=630524

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 126347903,
"week": "12",
"date": "2023-12-30T17:00:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
}
}
]

Volleyball.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=630524
teamIdTwo required	number Example: teamIdTwo=631375

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 126347903,
"week": "12",
"date": "2023-12-30T17:00:00.000Z",
"country": {"code": "IT",
"name": "Italy",
"logo": "https://example.com/logos/country/IT.png"
},
"awayTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"homeTeam": {"id": 630524,
"logo": "https://example.com/logos/team/630524.png",
"name": "Trentino"
},
"league": {"id": 83331,
"season": 2023,
"name": "SuperLega",
"logo": "https://example.com/logos/league/83331.png"
},
"state": {"description": "Second set",
"score": {"current": "3 - 1",
"firstSet": "19 - 25",
"secondSet": "25 - 12",
"thirdSet": "22 - 17",
"fourthSet": "22 - 17",
"fifthSet": "25 - 19"
}
}
}
]

Cricket.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters

name	object Example: name=Australia

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
}
]

Get country by country code.

Retrieve country details by country code.

path Parameters

countryCode

required

string

Example: AU

A string value code of the country, following the ISO 3166 standard.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"name": "Australia"
}
]

Cricket.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

countryCode	string Example: countryCode=AU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Australia
leagueName	string Example: leagueName=Big Bash League
leagueId	number Example: leagueId=48513362
date	string Example: date=2024-01-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=48514657
homeTeamId	number Example: homeTeamId=17838627
awayTeamId	number Example: awayTeamId=17838662
homeTeamName	string Example: homeTeamName=Melbourne Renegades
awayTeamName	string Example: awayTeamName=Melbourne Stars
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0
homeTeamAbbreviation	string Example: homeTeamAbbreviation=MR
awayTeamAbbreviation	string Example: awayTeamAbbreviation=MS

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 75,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/75.png",
"title": "Big Bash League: Melbourne Renegades vs Melbourne Stars",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"id": "48514657",
"endDate": "2024-01-13T00:00:00.000Z",
"startDate": "2024-01-13T00:00:00.000Z",
"startTime": "2024-01-13T14:30:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
}
},
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 117

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 75

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 75,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/75.png",
"title": "Big Bash League: Melbourne Renegades vs Melbourne Stars",
"description": "Game recap of the match.",
"url": "https://example.com/highlight/213123safas132e",
"embedUrl": "https://example.com/embed/213123safas132e",
"match": {"id": "48514657",
"endDate": "2024-01-13T00:00:00.000Z",
"startDate": "2024-01-13T00:00:00.000Z",
"startTime": "2024-01-13T14:30:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
}
},
"channel": "Ligue 1 Uber Eats",
"source": "youtube"
}
]

Cricket.Leagues

Get all leagues.

Retrieve a list of all leagues.

query Parameters

limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
season	number >= 0 Example: season=2023
leagueName	string Example: leagueName=Big Bash League
countryCode	string Example: countryCode=AU Country code specified by the ISO 3166 standard.
countryName	string Example: countryName=Australia

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": "48513362",
"logo": "https://example.com/logos/league/1635.png",
"name": "Big Bash League",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"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"
}
}

Get league by id.

Retrieve league details by league id.

path Parameters

id

required

number

Example: 48513362

Requested league id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "48513362",
"logo": "https://example.com/logos/league/1635.png",
"name": "Big Bash League",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"seasons": [{"season": 2023
}
]
}
]

Cricket.Matches

Get all matches.

Retrieve a list of all matches. At least one parameter has to be specified.

query Parameters

leagueName	object Example: leagueName=Big Bash League
leagueId	object Example: leagueId=48513362
date	object Example: date=2024-01-13 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2023
homeTeamId	object Example: homeTeamId=17838627
awayTeamId	object Example: awayTeamId=17838662
homeTeamName	object Example: homeTeamName=Melbourne Renegades
awayTeamName	object Example: awayTeamName=Melbourne Stars
countryCode	object Example: countryCode=AU
countryName	object Example: countryName=Australia
limit	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0
homeTeamAbbreviation	string Example: homeTeamAbbreviation=MR
awayTeamAbbreviation	string Example: awayTeamAbbreviation=MS

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": "48514657",
"endDate": "2024-01-13T00:00:00.000Z",
"startDate": "2024-01-13T00:00:00.000Z",
"startTime": "2024-01-13T14:30:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
}
}
],
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 49877382

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "49877382",
"endDate": "2024-03-31T00:00:00.000Z",
"startDate": "2024-03-31T00:00:00.000Z",
"startTime": "2024-03-31T06:00:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
},
"venue": {"city": "Swansea",
"name": "Liberty Stadium",
"country": "Wales",
"capacity": "20827"
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Cricket.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

limit	object [ 0 .. 500 ] Default: 500 Example: limit=50
offset	object >= 0 Default: 0
name	string Example: name=Melbourne Stars
abbreviation	string Example: abbreviation=MS

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 17838627

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
}
]

Cricket.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=22Bet
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 3,
"name": "22Bet"
}
],
"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 3

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 3,
"name": "22Bet"
}
]

Cricket.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueName	string Example: leagueName=Indian Premier League
leagueId	number Example: leagueId=49361342
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=3
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=49774517
bookmakerName	string Example: bookmakerName=22Bet
date	string Example: date=2024-03-26 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": "49774517",
"odds": [{"bookmakerId": 3,
"bookmakerName": "22Bet",
"type": "prematch",
"market": "Odd or Even",
"values": [{"odd": 1.69,
"value": "Odd"
}
]
}
]
}
],
"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"
}
}

Cricket.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=17838662

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "48514657",
"endDate": "2024-01-13T00:00:00.000Z",
"startDate": "2024-01-13T00:00:00.000Z",
"startTime": "2024-01-13T14:30:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
}
}
]

Cricket.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=17838627
teamIdTwo required	number Example: teamIdTwo=17838662

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "48514657",
"endDate": "2024-01-13T00:00:00.000Z",
"startDate": "2024-01-13T00:00:00.000Z",
"startTime": "2024-01-13T14:30:00.000Z",
"country": {"code": "AU",
"name": "Australia",
"logo": "https://example.com/logos/country/AU.png"
},
"awayTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"homeTeam": {"id": "17838627",
"logo": "https://example.com/logos/team/17838627.png",
"name": "Melbourne Stars",
"abbreviation": "MS"
},
"league": {"id": "48513362",
"season": 2023,
"name": "Big Bash League",
"logo": "https://example.com/logos/league/48513362.png"
},
"format": "T20",
"dayType": "SINGLE",
"state": {"description": "Finished",
"report": "Renegades won by 6 wickets (with 16 balls remaining)",
"teams": {"away": {"info": "17.2/20 ov, T:138",
"score": "139/4"
},
"home": {"info": null,
"score": "137/8"
}
}
}
}
]

Baseball.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters

league	object Example: league=NCAA
date	object Example: date=2024-03-06 Date that follows the YYYY-MM-DD format.
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2024
matchId	object Example: matchId=394
homeTeamId	object Example: homeTeamId=219
awayTeamId	object Example: awayTeamId=302
homeTeamName	object Example: homeTeamName=Bears
awayTeamName	object Example: awayTeamName=Patriots
homeTeamAbbreviation	object Example: homeTeamAbbreviation=BAY
awayTeamAbbreviation	object Example: awayTeamAbbreviation=DBU
homeTeamDisplayName	object Example: homeTeamDisplayName=Baylor
awayTeamDisplayName	object Example: awayTeamDisplayName=Dallas Baptist
limit	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 27,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/27.png",
"title": "NCAA: Bears vs Patriots",
"description": "Tom Poole sends one deep to right to give Dallas Baptist an insurance run over Baylor.",
"url": "https://example.com/highlight/v23r23fds2cff",
"embedUrl": "https://example.com/embed/v23r23fds2cff",
"match": {"id": 394,
"round": "regular-season",
"date": "2024-03-06T00:30:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY"
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY"
}
},
"channel": "MLB",
"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"
}
}

Get geo restrictions for highlight.

Retrieve applied geo restrictions to the given highlight id.

path Parameters

id

required

number

Example: 44

Requested higlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"state": "Allowed countries restriction",
"allowedCountries": ["IT"
],
"blockedCountries": [ ],
"embeddable": true
}

Get highlight by id.

Retrieve highlight details by highlight id.

path Parameters

id

required

number

Example: 27

Requested highlight id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 27,
"type": "VERIFIED",
"imgUrl": "https://example.com/images/preview/27.png",
"title": "NCAA: Bears vs Patriots",
"description": "Tom Poole sends one deep to right to give Dallas Baptist an insurance run over Baylor.",
"url": "https://example.com/highlight/v23r23fds2cff",
"embedUrl": "https://example.com/embed/v23r23fds2cff",
"match": {"id": 394,
"round": "regular-season",
"date": "2024-03-06T00:30:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY"
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY"
}
},
"channel": "MLB",
"source": "youtube"
}
]

Baseball.Matches

Get all matches.

Retrieve a list of all matches.

query Parameters

league	object Example: league=NCAA
date	object Example: date=2024-03-06 Date that follows the YYYY-MM-DD format.
timezone	string Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
season	object Example: season=2024
homeTeamId	object Example: homeTeamId=219
awayTeamId	object Example: awayTeamId=302
homeTeamName	object Example: homeTeamName=Bears
awayTeamName	object Example: awayTeamName=Patriots
homeTeamAbbreviation	object Example: homeTeamAbbreviation=BAY
awayTeamAbbreviation	object Example: awayTeamAbbreviation=DBU
homeTeamDisplayName	object Example: homeTeamDisplayName=Baylor
awayTeamDisplayName	object Example: awayTeamDisplayName=Dallas Baptist
limit	number [ 0 .. 100 ] Default: 100 Example: limit=100
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 394,
"round": "regular-season",
"date": "2024-03-06T00:30:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"state": {"description": "Finished",
"report": "Final",
"score": {"home": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"away": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"current": "5 - 8"
}
}
}
],
"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"
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 58348

Requested match id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 58348,
"round": "regular-season",
"date": "2024-03-31T17:00:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"state": {"description": "Finished",
"report": "Final",
"score": {"home": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"away": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"current": "5 - 8"
}
},
"venue": {"city": "Waco",
"name": "Baylor Ballpark",
"state": "Texas"
},
"stats": {"homeTeam": [{"batting": [{"value": 8,
"displayName": "Strikeouts"
}
],
"fielding": [null
],
"pitching": [null
]
}
],
"awayTeam": [{"batting": [{"value": 8,
"displayName": "Strikeouts"
}
],
"fielding": [null
],
"pitching": [null
]
}
]
},
"plays": [{"type": "Start Inning",
"teamId": 229,
"description": "Top of the 1st inning",
"currentOuts": 0,
"period": "Top 1st Inning",
"pitch": {"type": "CURVE",
"velocity": 78.2,
"ballsCount": 0,
"strikesCount": 0
},
"result": {"ballsCount": 1,
"strikesCount": 2
},
"score": {"away": 1,
"home": 2
}
}
],
"referees": [{"name": "Jonathan Parra",
"position": "Home Plate Umpire"
}
],
"rosters": {"awayTeam": {"jersey": 1,
"fullName": "Hunter Hines",
"position": "First Baseman",
"isStarter": true
},
"homeTeam": {"jersey": 1,
"fullName": "Hunter Hines",
"position": "First Baseman",
"isStarter": true
}
},
"forecast": {"status": "cloudy",
"temperature": "11.97°C"
}
}
]

Baseball.Teams

Get all teams.

Retrieve a list of all teams.

query Parameters

league	object Example: league=NCAA
name	object Example: name=Bears
displayName	object Example: displayName=Baylor
abbreviation	object Example: abbreviation=BAY

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"league": "NCAA",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
}
],
"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"
}
}

Get team by id.

Retrieve team details by team id.

path Parameters

id

required

number

Example: 219

Requested team id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"league": "NCAA",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
}
]

Baseball.Standings

Get standings list.

Retrieve a list of all standings based on passed query parameters.

query Parameters

leagueType	string Enum: "MLB" "NCAA" Example: leagueType=MLB
limit	number [ 0 .. 10 ] Default: 10 Example: limit=5
offset	number >= 0 Default: 0
leagueName	string Example: leagueName=National League (MLB)
abbreviation	string Example: abbreviation=NL
year	number Example: year=2024

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"leagueName": "Cactus League (MLB)",
"abbreviation": "CAC",
"year": 2024,
"leagueType": "MLB",
"seasonType": "Spring Training",
"startDate": "2024-02-15T08:00:00.000Z",
"endDate": "2024-03-27T06:59:00.000Z",
"data": [{"id": 58,
"logo": "https://example.com/baseball/images/teams/58.png",
"name": "Dodgers",
"stats": [{"description": "Number of Overtime Losses",
"abbreviation": "OTL",
"displayValue": "0"
}
]
}
]
}
],
"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"
}
}

Baseball.Odds

Get a list of odds.

Retrieve a list of all odds based on passed query parameters. At least one parameter has to be specified.

query Parameters

leagueName	object Example: leagueName=NCAA
timezone	object Default: "Etc/UTC" Example: timezone=Europe/London Valid timezone identifier.
bookmakerId	number Example: bookmakerId=53
limit	number [ 0 .. 5 ] Default: 5 Example: limit=5
offset	number >= 0 Default: 0
matchId	number Example: matchId=394
bookmakerName	string Example: bookmakerName=Megapari Sport
date	object Example: date=2024-03-06 Date that follows the YYYY-MM-DD format.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"matchId": 394,
"odds": [{"bookmakerId": 53,
"bookmakerName": "Megapari Sport",
"type": "prematch",
"market": "Odd or Even",
"values": [{"odd": 2.8,
"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"
}
}

Baseball.Bookmakers

Get a list of available bookmakers.

Retrieve a list of all bookmakers based on passed query parameters.

query Parameters

name	object Example: name=Megapari Sport
limit	number [ 0 .. 100 ] Default: 20 Example: limit=20
offset	number >= 0 Default: 0

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": 53,
"name": "Megapari Sport"
}
],
"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"
}
}

Get bookmaker by id.

Retrieve bookmaker details by bookmaker id.

path Parameters

id

required

number

Example: 53

Requested bookmaker id.

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 53,
"name": "Megapari Sport"
}
]

Baseball.Last Five Games

Get last five games for specific team id.

Retrieve a list of last five games played for given team id.

query Parameters

teamId

required

number

Example: teamId=42

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 394,
"round": "regular-season",
"date": "2024-03-06T00:30:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"state": {"description": "Finished",
"report": "Final",
"score": {"home": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"away": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"current": "5 - 8"
}
}
}
]

Baseball.Head 2 Head

Get head 2 head data for a specific set of teams.

Retrieve a list of head 2 head games played for given team ids.

query Parameters

teamIdOne required	number Example: teamIdOne=42
teamIdTwo required	number Example: teamIdTwo=52

header Parameters

x-rapidapi-host required	string sport-highlights-api.p.rapidapi.com
x-rapidapi-key required	string Rapid API Token

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 394,
"round": "regular-season",
"date": "2024-03-06T00:30:00.000Z",
"league": "NCAA",
"season": 2024,
"awayTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"homeTeam": {"id": 219,
"logo": "https://example.com/logos/team/219.png",
"name": "Bears",
"displayName": "Baylor",
"abbreviation": "BAY",
"records": {"home": {"wins": 2,
"losses": 6
},
"away": {"wins": 2,
"losses": 3
},
"total": {"wins": 4,
"losses": 9
}
}
},
"state": {"description": "Finished",
"report": "Final",
"score": {"home": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"away": {"hits": 4,
"errors": 2,
"innings": [0,
0,
1,
1,
0,
0,
1,
1,
1
]
},
"current": "5 - 8"
}
}
}
]