Highlightly Sport Highlights API (1.0.0)

Download OpenAPI specification:Download

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

Sport Highlights 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 football-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 football-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 football-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
}
}

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 football-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 football-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
}
}

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 football-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 football-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"
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 853061055

Requested match id.

header Parameters

x-rapidapi-host required	string football-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"
}
}
]

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 football-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",
"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"
}
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

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 football-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",
"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"
}
}
}
]

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 nfl-ncaa-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 nfl-ncaa-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	object [ 0 .. 100 ] Default: 100 Example: limit=100
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string nfl-ncaa-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"
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

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 nfl-ncaa-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"
}
}
]

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	object [ 0 .. 40 ] Default: 40
offset	object >= 0 Default: 0

header Parameters

x-rapidapi-host required	string nfl-ncaa-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",
"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"
}
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

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 nfl-ncaa-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",
"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"
}
}
}
]

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 basketball-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 basketball-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 basketball-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"
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 299340885

Requested match id.

header Parameters

x-rapidapi-host required	string basketball-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"
}
}
]

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 basketball-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",
"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"
}
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

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 basketball-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",
"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"
}
}
}
]

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 basketball-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
}
}

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 basketball-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 basketball-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
}
}

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 basketball-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"
}
]

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 hockey-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 hockey-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 hockey-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",
"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"
}
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

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 hockey-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",
"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"
}
}
}
]

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 hockey-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
}
}

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 hockey-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 hockey-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"
}
}
],
"pagination": {"totalCount": 490,
"offset": 20,
"limit": 100
}
}

Get match by id.

Retrieve match details by match id.

path Parameters

id

required

number

Example: 291869956

Requested match id.

header Parameters

x-rapidapi-host required	string hockey-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"
}
}
]

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 hockey-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
}
}

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 hockey-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"
}
]