Highlightly Rugby API (4.2.1)

Download OpenAPI specification:Download

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

Rugby API

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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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 rugby-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.Standings

Get league standings.

Retrieve current league standings for a specific season.

query Parameters

leagueId required	number Example: leagueId=69715
season required	number Example: season=2022

header Parameters

x-rapidapi-host required	string rugby-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": "Group A",
"standings": [{"team": {"id": 361608,
"logo": "https://example.com/logos/team/361608.png",
"name": "Germany 7s"
},
"wins": 3,
"loses": 0,
"draws": 0,
"position": 1,
"points": 9,
"gamesPlayed": 18,
"scoredPoints": 53,
"receivedPoints": 10
}
]
}
],
"league": {"id": 69715,
"logo": "https://example.com/logos/league/69715.png",
"name": "Sevens Europe Series - Portugal",
"season": 2022
}
}