Highlightly Basketball API (1.0.0)

Download OpenAPI specification:Download

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

Basketball Highlights API

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

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

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

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

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