Highlightly Rugby API (2.0.1)

Download OpenAPI specification:Download

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

Rugby Highlights API

Rugby.Countries

Get all countries.

Retrieve a list of all supported.

query Parameters
name
object
Example: name=France
header Parameters
x-rapidapi-host
required
string

rugby-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

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

rugby-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

Rugby.Highlights

Get all highlights.

Retrieve a list of all highlights.

query Parameters
countryCode
string
Example: countryCode=FR

Country code specified by the ISO 3166 standard.

countryName
string
Example: countryName=France
leagueName
string
Example: leagueName=Top 14
leagueId
number
Example: leagueId=14400
date
string
Example: date=2023-12-23

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=35117299
homeTeamId
number
Example: homeTeamId=90990
awayTeamId
number
Example: awayTeamId=85884
homeTeamName
string
Example: homeTeamName=Stade Francais Paris
awayTeamName
string
Example: awayTeamName=Stade Rochelais
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

Content type
application/json
{}

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

rugby-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

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=2023
leagueName
string
Example: leagueName=Top 14
countryCode
string
Example: countryCode=FR

Country code specified by the ISO 3166 standard.

countryName
string
Example: countryName=France
header Parameters
x-rapidapi-host
required
string

rugby-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "pagination": {
    },
  • "plan": {
    }
}

Get league by id.

Retrieve league details by league id.

path Parameters
id
required
number
Example: 14400

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

Content type
application/json
[]

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=Top 14
leagueId
object
Example: leagueId=14400
date
object
Example: date=2023-12-23

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=90990
awayTeamId
object
Example: awayTeamId=85884
homeTeamName
object
Example: homeTeamName=Stade Francais Paris
awayTeamName
object
Example: awayTeamName=Stade Rochelais
countryCode
object
Example: countryCode=FR
countryName
object
Example: countryName=France
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

Content type
application/json
{
  • "data": [],
  • "pagination": {
    },
  • "plan": {
    }
}

Get match by id.

Retrieve match details by match id.

path Parameters
id
required
number
Example: 35117299

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

Content type
application/json
[]

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=Stade Francais Paris
header Parameters
x-rapidapi-host
required
string

rugby-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "pagination": {
    },
  • "plan": {
    }
}

Get team by id.

Retrieve team details by team id.

path Parameters
id
required
number
Example: 90990

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

Content type
application/json
[]