Highlightly Basketball API (4.2.1)

Download OpenAPI specification:Download

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

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

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 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": 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 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": 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 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": [{"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 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"
},
"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 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"
},
"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 basketball-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
}
}