API docs by Redocly

Football API | Highlightly (8.2.2)

Download OpenAPI specification:Download

Get ready for real time Football match/player statistics, live scores, match predictions, live events, highlights, game recaps, fouls, and post-match interviews on a global scale. Integrate a wide spectrum of pre-match and live game odds into your projects for a complete sports data solution.

Contact

For feature requests, questions, private plans or business inquiries you can contact us at [email protected].

You can also contact us via RapidAPI by starting a discussion or by sending us a private message.

Integration

To start using our API services you will first need to create an account via Highlightly or RapidAPI. Both platforms offer you the ability to view the API analytics, manage billing settings, control API keys and much more. However, there are a few differences. RapidAPI does not include custom plans nor does it provide long term plan discounts.

Accounts are not synced across platforms.

Please ensure that your API key is not made public to prevent potential abuse. Your API key can be managed either through Highlightly or RapidAPI.

API usage

Highlightly API base url: https://soccer.highlightly.net

RapidAPI API base url: https://football-highlights-api.p.rapidapi.com

Each API request will be considered valid only if the following headers are present:

Request Header Value
x-rapidapi-key Your Highlightly or RapidAPI API Key
x-rapidapi-host football-highlights-api.p.rapidapi.com - only needed for usage through RapidAPI

These headers are mandatory when requesting API data. They are not needed when requesting other resources such as logos or images.

Each API response will contain additional headers. The following three are considered the most important for developers:

Response Header Value
x-ratelimit-requests-limit This is a static value indicating the number of requests the plan you are currently subscribed to allows you to make.
x-ratelimit-requests-remaining The number of requests remaining (from your plan) before you reach the limit of requests your application is allowed to make. When this reaches zero, you will not be able to make any requests until your daily quota is reset. You can view these limits and quotas on the pricing page of the API in the API Hub.
content-type Value will always be application/json. XML format is not supported.

In the following sections we will guide you through all endpoints and functionalities the API has to offer.

Football API

Football.Countries

Get all countries

Refresh interval: Once a day

Retrieve a list of countries that are supported by the API.

By utilising the name query parameter you can check whether a specific country exists or simply retrieve the associated data.

Country name and code can be used to query other resources such as matches, leagues, highlights, etc.

Below is an example of supported countries and their associated logos: Countries example

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

football-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

Refresh interval: Once a day

Retrieve associated country details by specifying the country code path parameter. The path parameter should follow the ISO 3166 standard.

Country name and code can be used to query other resources such as matches, leagues, highlights, etc.

path Parameters
countryCode
required
string

A string value code of the country, following the ISO 3166 standard.

header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Leagues

Get all leagues

Refresh interval: Multiple times a day

Retrieve a list of leagues.

By utilising the leagueName query parameter you can check whether a specific league exists or simply retrieve the associated data. You can also narrow down your search by specifying the countryCode or countryName query parameters.

There are two other important query parameters. The limit parameter defines what the number of returned leagues will be. If the number of actual leagues is above the limit value you can make subsequent requests by increasing the offset value.

The league information and their associated seasons can be used to request data from other endpoints such as standings.

query Parameters
limit
number [ 0 .. 100 ]
Default: 100
Example: limit=100
offset
number >= 0
Default: 0
Example: offset=0
season
number >= 0
Example: season=2023
leagueName
string
Example: leagueName=Superettan
countryCode
string
Example: countryCode=SE

Country code specified by the ISO 3166 standard.

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

football-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 information by specifying the league id path parameter.

Note: Used to check whether a league still exists or had its information updated.

path Parameters
id
required
number

Requested league id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Teams

Get all teams

Retrieve a list of teams that are supported by the API.

By utilising the name query parameter you can check whether a specific team exists or simply retrieve the associated data.

There are two other important query parameters. The limit parameter defines what the number of returned teams will be. If the number of actual teams is above the limit value you can make subsequent requests by increasing the offset value.

query Parameters
limit
number [ 0 .. 500 ]
Default: 500
Example: limit=50
offset
number >= 0
Default: 0
Example: offset=0
name
string
Example: name=Skövde AIK
header Parameters
x-rapidapi-host
required
string

football-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 statistics

Refresh interval: Immediately once a match is finished.

Retrieve team stats for each league and season by specifying the team's id path parameter. Requires fromDate query parameter to be specified in the YYYY-MM-DD format. Additionally, the timezone query parameter can be specified to futher narrow down the search results based on your location.

path Parameters
id
required
number

Requested team id.
query Parameters
fromDate
required
string
Example: fromDate=2023-08-06

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get team by team id

Retrieve team information by specifying the team id path parameter.

Note: Used to check whether a team still exists or had its information updated.

path Parameters
id
required
number

Requested team id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Matches

Get all matches

Refresh interval: Once a minute

Route returns only general match information. For additional match details check the matches/{matchId} route.

Retrieve a list of matches based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get matches relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned matches will be. If the number of actual matches is above the limit value you can make subsequent requests by increasing the offset value.

Matches have different possible states they can be in:

State Description
Not started Match has not been started yet.
First half Match is considered in play and is in the first half.
Second half Match is considered in play and is in the second half.
Half time Half time pause between first and second half.
Extra time Game was considered a draw in normal time. Additional extra time is needed to decide the winner.
Break time Short pause between in play periods and extra time.
Penalties Penalty shootout to decide the winner of the match.
Finished Match has been concluded.
Finished after penalties Match has been concluded with the penalty shootout.
Finished after extra time Match has been concluded in extra time.
Postponed Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future.
Suspended Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted.
Cancelled Game will not be played.
Awarded Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc.
Interrupted An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned.
Abandoned Considered "abandoned" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game might be resumed from the exact point where it was halted.
In progress Match is considered in play but the coverage information is minimal.
Unknown Unknown match coverage or state.
To be announced Match's start time will be updated or competing teams are not yet known.

Below is an example of what you can aim to achieve with the matches endpoint:

Football matches example

query Parameters
leagueName
string
Example: leagueName=Superettan
leagueId
number
Example: leagueId=97798
date
string
Example: date=2023-08-06

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
season
number
Example: season=2023
homeTeamId
number
Example: homeTeamId=5700782
awayTeamId
number
Example: awayTeamId=1907875
homeTeamName
string
Example: homeTeamName=Skövde AIK
awayTeamName
string
Example: awayTeamName=Vasteras SK FK
countryCode
string
Example: countryCode=SE

Country code specified by the ISO 3166 standard.

countryName
string
Example: countryName=Sweden
limit
number [ 0 .. 100 ]
Default: 100
Example: limit=100
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

football-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 detailed match information by specifying the match id path parameter.

Certain popular leagues and their associated matches will have additional data about the venue, weather forecast, match statistics, match news and who the game's referee is. The retrieved data will also contain a list of important events that happened:

Type Description
Goal A player strikes the ball into the opposing team's goal.
Own Goal A player strikes or deflects the ball into their own team's goal.
Penalty A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area.
Missed Penalty The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper.
Yellow Card A player is cautioned by the referee for unsporting behavior or foul play.
Red Card A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card.
Substitution A player is replaced by another player from the bench during a stoppage in play.
VAR Goal Confirmed The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand.
VAR Goal Cancelled The VAR review determines that a goal should be disallowed due to an infringement or violation.
VAR Penalty The VAR review results in a penalty being awarded to a team.
VAR Penalty Cancelled The VAR review results in a previously awarded penalty being overturned.
VAR Goal Cancelled - Offside The VAR review determines that a goal should be disallowed due to an offside infringement.

The above list may be updated with additional entries in the future.

Note: Used to retrieve additional match information.

path Parameters
id
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Football.Highlights

Get all highlights

Refresh interval: Once a minute

Note: Certain highlights might be uploaded whilst the game is playing. Full game recaps tend to be uploaded anywhere from 1 to 48 hours after a match is finished.

Highlights represent the core of our API. They include various different kinds of clips ranging from real time live events such as insane plays, last minute scores to full game recaps, pre/post match interviews.

Currently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:

Type Description
VERIFIED Videos come from reputable sources that have been thoroughly inspected. In most cases the clips are from official authors who own the copyrights to the video itself. The hosting platform can impose geo restrictions or prevent direct embedding (highlights/geo-restrictions/{highlightId} route can be used to check for potential restrictions). Verified highlights are uploaded anywhere from 1 to 48 hours of the match being finished.
UNVERIFIED Highlights vary and might not have gone through the verification process or are considered user uploaded. Videos include a wide spectrum of topics such as last minute scores, memorable plays, game recaps, etc. Unverified highlights are considered more real time and might be uploaded even when the match is still being played. The lifetime of these clips vary and is dependant on the hosting platform.

Each highlight has a title which describes what the video is about. Certain entries will have a description as well which is used to further describe the associated clip. The source field defines where the clip was aggregated from (e.g. would be youtube, twitter, reddit, espn, etc.). For certain sources you will see additional information being present in the channel field. By utilising this information you can further narrow down which videos you want to showcase. Highlights might also have an embedUrl property which is used to directly embed the videos into your website or mobile application.

Below is an example of what you can aim to achieve with our highlights data:

Highlights example

Retrieve highlights

Retrieve a list of highlights based on the requested query parameters.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset are considered secondary).

You can specify the timezone field in combination with the date query parameter to get highlights relevant to your location.

There are two other important parameters. The limit parameter defines what the number of returned highlights will be. If the number of actual highlights is above the limit value you can make subsequent requests by increasing the offset value.

Note: The Basic/Free plan might have certain restrictions in place. More information can be found here.

query Parameters
countryCode
string
Example: countryCode=TR

Country code specified by the ISO 3166 standard.

countryName
string
Example: countryName=Turkey
leagueName
string
Example: leagueName=Süper Lig
leagueId
number
Example: leagueId=173537
date
string
Example: date=2023-08-11

Date that follows the YYYY-MM-DD format.
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
season
number
Example: season=2023
matchId
number
Example: matchId=914490490
homeTeamId
number
Example: homeTeamId=850082
awayTeamId
number
Example: awayTeamId=856039
homeTeamName
string
Example: homeTeamName=Trabzonspor
awayTeamName
string
Example: awayTeamName=Antalyaspor
limit
number [ 0 .. 40 ]
Default: 40
Example: limit=40
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{ }

Get geo restrictions for highlight

Refresh interval: Once an hour

Note: Endpoint is not available in the Basic/Free plan.

Geo restrictions are a plague that have been around for quite a while. They restrict access to online content based on the viewers geographical location. Trying to show restricted highlights to your users can greatly hinder the viewing experience.

Each highlight has a state property which defines how the geo restrictions are applied.

State Description
No restricitons applied Highlight has no restrictions applied and is available globally.
Allowed countries restriction Highlight is only available to users whose country code is found in the allowedCountries list.
Blocked countries restriction Highlight is blocked to all users whose country code is found in the blockedCountries list.
Unknown restrictions There is no guaranteed way to define all allowed or blocked countries.

As presented before, certain highlights have an embedUrl field which can be used to directly embed the video into your website or application. The embeddable field specifies whether this is allowed or not.

path Parameters
id
required
number

Requested highlight id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "state": "Allowed countries restriction",
  • "allowedCountries": [
    ],
  • "blockedCountries": [ ],
  • "embeddable": true
}

Get highlight by id

Retrieve highlight information by specifying the highlight id path parameter.

Note: Used to check whether a highlight still exists or had its information updated.

path Parameters
id
required
number

Requested highlight id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Bookmakers

Get all bookmakers

Refresh interval: Once a day

Retrieve a list of supported bookmakers.

There are two important parameters that are used to navigate through the pagination. The limit parameter defines what the number of returned bookmakers will be. If the number of actual bookmakers is above the limit value you can make subsequent requests by increasing the offset value.

The bookmakers name or id can be used to filter data from the odds endpoint.

query Parameters
name
string
Example: name=Stake.com
limit
number [ 0 .. 100 ]
Default: 20
Example: limit=20
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

football-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 information by specifying the bookmaker id path parameter.

Note: Used to check whether a bookmaker still exists or had its information updated.

path Parameters
id
required
number

Requested bookmaker id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Football.Odds

Get all odds

Prematch odds refresh interval: Multiple times a day

Live odds refresh interval: Once every 10 minutes

Note: Endpoint is not available in the Basic/Free plan.

Retrieve a list of match odds based on the requested query parameters. With oddsType query parameter you can specify whether you want prematch or live odds. If you do not set a specific value prematch odds will be returned.

At least one primary query parameter needs to be specified before you can retrieve the data (timezone, limit, offset, oddsType are considered secondary).

The most popular way of getting match odds is by specifying the matchId query parameter. You can also utilise the date parameter alongside the timezone to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.

As it stands, we currently offer the support for the following markets:

Market Description
Full Time Result The possible outcomes for the mentioned market are Home, Draw or Away.
Asian Handicap This is considered a complex market. It is split into multiple possible variants such as "Asian Handicap -1.25/+1.25", "Asian Handicap -1.5/+1.5" and so on. The possible outcome of a variant is either Home or Away.
Odd or Even The Odd or Even market defines whether the score of both teams will be either Odd or Even.
Total Goals This is considered a complex market. It is split into multiple possible variants such as "Total Goals 2", "Total Goals 3.5" and so on. The possible outcome of a variant is either Over or Under.
Both Teams to Score The market defines whether both teams will score or not. Outcomes can be either Yes or No.
Correct Score This is considered a complex market. It is split into multiple possible variants such as "Correct Score 2 : 0", "Correct Score 1 : 1" and so on. There is only a single possible outcome of the variant.
First Team to Score The market defines which team will be the first one to score a goal. Outcomes can be either Home, Away or None when no team scores a goal.
Total Cards This is considered a complex market. It is split into multiple possible variants such as "Total Cards 4", "Total Cards 5.25" and so on. The possible outcome of a variant is either Over or Under.
Clean Sheet The Clean Sheet market defines whether the home or away team will not concede any goals. Outcomes can be either Home or Away. If the game results in a 0 : 0 score, both outcomes are considered winning.
Total Corners This is considered a complex market. It is split into multiple possible variants such as "Total Corners 11.5", "Total Corners 12.5" and so on. The possible outcome of a variant is either Over or Under.

There are two other important query parameters. The limit parameter defines what the number of returned match odds will be. If the number of actual match odds is above the limit value you can make subsequent requests by increasing the offset value.

Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.

Below is an example of what can be achieved with bookmaker odds on a match basis:

Odds example

query Parameters
oddsType
string
Example: oddsType=prematch

Defines whether live or prematch odds will be returned.

leagueId
number
leagueName
string
timezone
string
Default: "Etc/UTC"
Example: timezone=Europe/London

Valid timezone identifier.
bookmakerId
number
Example: bookmakerId=1
limit
number [ 0 .. 5 ]
Default: 5
Example: limit=5
offset
number >= 0
Default: 0
Example: offset=0
matchId
number
bookmakerName
string
Example: bookmakerName=Stake.com
date
string

Date that follows the YYYY-MM-DD format.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

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

Football.Standings

Get standings

Refresh interval: Up to an hour after a match for the associated league and season is finished

Retrieve standings data for a specific league, conference or division.

Endpoint requires both leagueId and season query parameters to be specified before you can fetch the data.

Below is an example on how you could render league associated standings

Standings example

query Parameters
leagueId
required
number
Example: leagueId=33973
season
required
number
Example: season=2023
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "league": { }
}

Football.Last Five Games

Get last five finished games for a specific team id

Refresh interval: Immediately once a game is considered finished

Retrieve a list of the last five finished games for a specific team. If a game was not finished (e.g. was cancelled or postponed) it will not be returned.

Specify teamId query parameter to retrieve the data. Endpoint is used to create a form section between two teams that are playing a match. Below is an example of what can be achieved:

Last five games example

query Parameters
teamId
required
number
Example: teamId=5700782
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Head 2 Head

Get head 2 head games

Retrieve a list of the last ten head 2 head games between two teams. Compare the two teams to find out who is stronger based on their past match results.

Specify teamIdOne and teamIdTwo query parameters to retrieve the data. The order of team ids does not matter.

Below is an example of what you can achieve with the data:

H2H example

query Parameters
teamIdOne
required
number
Example: teamIdOne=314803
teamIdTwo
required
number
Example: teamIdTwo=5700782
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Lineups

Get linups by match id

Lineups will become available 30 minutes before the game starts or, at the latest, 15 minutes after kickoff.

Refresh interval: Once every 10 minutes

Retrieve home and away team lineups for a specific match.

Understanding the returned data structure is crucial for accurate rendering. The formation and initialLineup fields are closely related. The first row will always include the team's goalkeeper, while subsequent rows will have the number of entries specified by the formation field.

Below is an example of what you can aim to achieve with the lineup endpoint:

Football lineups example

path Parameters
matchId
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
{
  • "homeTeam": {
    },
  • "awayTeam": {
    }
}

Football.Statistics

Get match statistics by match id

Refresh interval: Once every 5 minutes

Retrieve match statistics data by specifying the matchId as the path parameter.

Below is an example of what you can aim to achieve with the statistics endpoint:

Football statistics example

path Parameters
matchId
required
number

Requested statistics for given match id
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[ ]

Football.Live Events

Get live events by match id

Refresh interval: Once a minute

Retrieve a list of live events for a match by specifying matchId as the path parameter.

Currently supported live events:

Type Description
Goal A player strikes the ball into the opposing team's goal.
Own Goal A player strikes or deflects the ball into their own team's goal.
Penalty A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area.
Missed Penalty The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper.
Yellow Card A player is cautioned by the referee for unsporting behavior or foul play.
Red Card A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card.
Substitution A player is replaced by another player from the bench during a stoppage in play.
VAR Goal Confirmed The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand.
VAR Goal Cancelled The VAR review determines that a goal should be disallowed due to an infringement or violation.
VAR Penalty The VAR review results in a penalty being awarded to a team.
VAR Penalty Cancelled The VAR review results in a previously awarded penalty being overturned.
VAR Goal Cancelled - Offside The VAR review determines that a goal should be disallowed due to an offside infringement.

The above list may be updated with additional entries in the future.

Below is an example of what you can aim to achieve with the live events endpoint:

Football live events example

path Parameters
id
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Football.Players

Get all players

Refresh interval: 15 minutes

Route returns only general player information. For additional player details check the players/{playerId} and players/{playerId}/statistics routes.

Retrieve a list of players based on the requested query parameters.

Returned results will be paginated. The limit parameter defines what the number of returned players will be. If the number of actual players is above the limit value you can make subsequent requests by increasing the offset value.

query Parameters
name
string
Example: name=Ivan Perišić
limit
number [ 0 .. 1000 ]
Default: 1000
Example: limit=1000
offset
number >= 0
Default: 0
Example: offset=0
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

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

Get player summary by player id

Refresh interval: Once a day

Retrieve detailed player summary for specified playerId.

Detailed player summary consists of the following information:

Type Description
Profile Provides a structured summary of a football player's personal and professional profile. It includes key details such as current club affiliation, contract timelines, physical attributes (height, preferred foot), biographical data (name, birth date, birthplace, citizenship), and playing positions. The data reflects both the player's current career status and positional versatility, offering a higher level overview which is useful for scouting, analysis, or profile display.
Rumours Rumours field provides an overview of a football player's transfer rumours. It distinguishes between current and historical speculation. Each entry includes the date the rumour emerged and, when available, a transfer probability indicating the estimated likelihood of the move. This data helps track the player's visibility and perceived value in the transfer market over time.
Related news Contains a list of news articles related to a football player, offering a historical record of media coverage. Each entry includes the article's title, publication date, and a link to the full content. The topics span various aspects of the player's career and broader football developments, including transfer moves, international appearances, squad analysis, and club strategies. This data helps illustrate the player's visibility in the media and contextualizes their role within the football landscape over time.
Transfers Outlines the complete transfer history of a football player, detailing their movement between clubs over the course of their career. Each entry includes the destination and origin clubs, the type of transfer (such as transfer, loan, or end of loan), the season in which the move occurred, the player's market value at the time, and the transfer fee when applicable. Transfer history provides us with a comprehensive view of the players mobility, market trajectory, and contractual developments across multiple leagues and stages of their career.
Market value Presents a chronological record of a football players market value over time. Each entry includes the recorded date, market value, players club at the time, age, and currency. This data allows for analysis of value trends throughout the players career, reflecting factors such as performance, injuries, transfers, and broader market conditions. It is useful for scouting, valuation modelling, and historical comparisons.

Below is an example of what you can aim to achieve with the player summary endpoint:

Player summary example

path Parameters
id
required
number

Requested player id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get player statistics by player id

Refresh interval: Once a day

Retrieve detailed player statistics for specified playerId.

Detailed player statistics is split into perClub and perCompetition aggregation. The following statistics are available:

Type Description
Goals Number of goals scored by the player.
Assists Number of assists provided by the player.
Own goals Number of goals accidentally scored against the player's own team.
Red cards Number of direct red cards received.
Clean sheets Number of matches where no goals were conceded (mostly relevant for goalkeepers).
Games played Total number of matches the player appeared in.
Yellow cards Number of yellow cards received.
Goals conceded Number of goals the team conceded while the player was on the pitch (mainly for goalkeepers).
Minutes played Total number of minutes the player was on the field.
Substituted in Number of times the player came on as a substitute.
Substituted out Number of times the player was substituted off.
Penalties scored Number of penalty goals scored.
Second yellow cards Number of second yellow cards leading to a red card.

Additionally, the competitions are split into multiple categories:

Type Description
National league A country's main domestic competition where clubs play each other over a season (e.g., Premier League, La Liga).
National cup A domestic knockout tournament open to clubs from different divisions (e.g., FA Cup, Copa del Rey).
International cup A tournament involving clubs from multiple countries (e.g., UEFA Champions League, Copa Libertadores).

Player stats example

path Parameters
id
required
number

Requested player id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Football.Match Box Score

Retrieve box scores for specified match id.

Refresh interval: Once every 5 minutes

Retrieve detailed per-player box score match statistics data by specifying the matchId as the path parameter.

The player box score statistics contain the general team information as well as a list of players and their respective stats. Each player has high level metadata information:

Data Description
id Unique identifier for the player.
Match rating Match performance rating (e.g., "8.00").
Shirt number Player's shirt/jersey number.
Position Playing position (e.g., "Goalkeeper", "Defender").
Is a captain Indicates if the player was the team captain.
Minutes played Total minutes played in the match.
Is a substitute Indicates if the player started as a substitute.
Offside Number of offsides committed.
Statistics Detailed performance metrics.
Name Commonly known name of the player.
Full name Player's full registered name.
Logo URL to the player's image/logo, if available.

Besides the general metadata, each player has the following granular match performance statistics:

Statistic Description
Goals scored Number of goals the player scored in the match.
Goals saved Number of opponent shots saved (goalkeeper stat).
Goals conceded Goals allowed by the player's team while they were the goalkeeper.
Assists Passes that directly led to a goal.
Total dribbles Total dribble attempts made.
Successful dribbles Dribble attempts that successfully beat an opponent.
Failed dribbles Dribble attempts that were unsuccessful.
Dribble success rate Percentage of dribbles that were successful.
Fouls received Times the player was fouled by opponents.
Fouls commited Fouls committed by the player.
Total tackles Total tackles attempted.
Total interceptions Number of times the player intercepted an opponent's pass.
Shots on target Shots directed at goal that required a save or resulted in a goal.
Shots off target Shots that missed the goal completely.
Shots total Total shots attempted (on and off target).
Shots accuracy Percentage of shots that were on target.
Penalties scored Penalty kicks successfully converted into goals.
Penalties missed Penalty kicks that failed to score.
Total penalties Total penalty kicks taken.
Penalty accuracy Percentage of penalties scored.
Passing accuracy Percentage of completed passes.
Successful passes Passes that successfully reached a teammate.
Failed passes Passes that failed to reach a teammate.
Total passes Total passes attempted.
Key passes Passes that directly created a goal-scoring opportunity.
Red cards Number of red cards received.
Yellow cards Number of yellow cards received.
Second yellow cards Number of second yellow cards leading to a red card.
Total duels Number of 1v1 challenges contested.
Won duels Number of duels won.
Lost duels Number of duels lost.
Duel success rate Percentage of duels won.
Expected assists (xA) The estimated number of assists the player should have, based on chance quality.
Expected goals (xG) The estimated number of goals the player should have scored, based on chance quality.
Expected goals on target (xGOT) The expected number of goals based on the placement and quality of shots on target.
Expected goals on target conceded (xGOT Conceded) The expected number of goals a goalkeeper should have conceded based on shots faced.
Expected goals prevented (xGP) Difference between expected goals on target conceded and actual goals conceded (goalkeeper stat).

Below is an example of what you can aim to achieve with the player box score endpoint:

Football player box score example

path Parameters
matchId
required
number

Requested match id.
header Parameters
x-rapidapi-host
required
string

football-highlights-api.p.rapidapi.com
x-rapidapi-key
required
string

Rapid API Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]