Highlightly Hockey API (4.0.0)

Download OpenAPI specification:Download

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

Hockey API

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

Content type
application/json
[]

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

Content type
application/json
[]

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

Content type
application/json
{}

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

Content type
application/json
[]

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

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

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

Content type
application/json
[]

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

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

Get match by id.

Retrieve match details by match id.

path Parameters
id
required
number
Example: 308606573

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

Content type
application/json
[
  • {
    }
]

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

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

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

Content type
application/json
[]

Hockey.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

hockey-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

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

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

hockey-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Hockey.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=50142
leagueName
string
Example: leagueName=AHL
timezone
object
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.

bookmakerId
number
Example: bookmakerId=19
limit
number [ 0 .. 5 ]
Default: 5
Example: limit=5
offset
number >= 0
Default: 0
matchId
number
Example: matchId=295119925
bookmakerName
string
Example: bookmakerName=1Bet
date
string
Example: date=2024-03-26

Date that follows the YYYY-MM-DD format.

header Parameters
x-rapidapi-host
required
string

hockey-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

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

Hockey.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=214385
header Parameters
x-rapidapi-host
required
string

hockey-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]

Hockey.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=214385
teamIdTwo
required
number
Example: teamIdTwo=223746
header Parameters
x-rapidapi-host
required
string

hockey-highlights-api.p.rapidapi.com

x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[]