This endpoint retrieves detailed information about a specific football match based on the provided match ID.
Request Parameters
id (path parameter): The unique identifier of the match you wish to retrieve. This parameter is required.
Response Structure
The response will contain the following fields:
matchId: The unique identifier for the match.
homeTeam: The name of the home team.
awayTeam: The name of the away team.
score: The current score of the match, including goals scored by both teams.
status: The current status of the match (e.g., scheduled, ongoing, finished).
date: The date and time when the match is scheduled to take place.
Use this endpoint to get the latest details about a specific football match by providing the match ID.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/{id}
200
OK
Match Statistics
get
Get Match Statistics
This endpoint retrieves detailed statistics for a specific football match identified by its unique id. The statistics include various groups of data that provide insights into the match performance.
Request Parameters
id (path parameter): The unique identifier for the match whose statistics are being requested.
Response Structure
On a successful request, the response will include the following structure:
status (boolean): Indicates whether the request was successful.
statusCode (integer): A code representing the status of the request.
message (string): A message providing additional information about the request status.
response (object): Contains the main data of the response.
period (string): Indicates the period of the match for which statistics are provided.
groups (array): A collection of statistic groups.
groupName (string): The name of the statistic group.
statisticsItems (array): A list of individual statistics items.
name (string): The name of the statistic.
home (string): The home team's statistic value.
away (string): The away team's statistic value.
compareCode (integer): A code used for comparison purposes.
statisticsType (string): The type of statistic being represented.
valueType (string): The type of value (e.g., numerical, percentage).
homeValue (integer): The numerical value for the home team.
awayValue (integer): The numerical value for the away team.
renderType (integer): Indicates how the statistic should be rendered.
key (string): A unique key for the statistic.
Notes
Ensure that the id parameter is valid and corresponds to an existing match to receive accurate statistics.
The response may vary based on the match data available at the time of the request.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/statistics/{id}
200
OK
Match Lineups
get
Endpoint Description
This endpoint retrieves the lineups for a specific football match identified by the :id parameter. It provides detailed information about the players and their statistics for both the home and away teams.
confirmed (boolean): Indicates if the lineups are confirmed.
home (object): Information about the home team:
players (array): List of players in the home team, each containing:
player (object): Player details including:
name (string): Player's name.
shortName (string): Player's short name.
position (string): Player's position on the field.
jerseyNumber (string): Jersey number.
height (integer): Player's height.
id (integer): Unique player identifier.
country (object): Player's country information.
marketValueCurrency (string): Currency for market value.
dateOfBirthTimestamp (integer): Player's date of birth as a timestamp.
proposedMarketValueRaw (object): Proposed market value details.
teamId (integer): Identifier for the team.
shirtNumber (integer): Shirt number.
substitute (boolean): Indicates if the player is a substitute.
statistics (object): Player statistics including:
totalPass (integer): Total passes made.
accuratePass (integer): Accurate passes made.
totalLongBalls (integer): Total long balls played.
accurateLongBalls (integer): Accurate long balls played.
goodHighClaim (integer): Good high claims.
savedShotsFromInsideTheBox (integer): Shots saved from inside the box.
saves (integer): Total saves made.
minutesPlayed (integer): Minutes played.
touches (integer): Total touches.
rating (float): Player rating.
possessionLostCtrl (integer): Possessions lost under control.
ratingVersions (object): Different versions of player ratings.
goalsPrevented (integer): Goals prevented by the player.
supportStaff (array): List of support staff for the home team.
formation (string): Team formation.
playerColor (object): Color details for players.
goalkeeperColor (object): Color details for the goalkeeper.
away (object): Similar structure as the home team but for the away team.
Notes
Ensure that the id parameter is valid to receive the correct lineups.
The response may vary based on the match status and whether the lineups are confirmed.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/lineups/{id}
200
OK
Match Incidents
get
Get Match Incidents
This endpoint retrieves incidents related to a specific football match identified by its unique id. It provides detailed information about various incidents that occurred during the match.
id (string): The unique identifier of the match for which incidents are being requested.
Response
The response will return a JSON object containing the following fields:
status (boolean): Indicates whether the request was successful.
statusCode (integer): The status code of the response.
message (string): A message providing additional information about the request status.
response (array): An array of incident objects, each containing:
incidentType (string): The type of incident (e.g., foul, goal).
incidentClass (string): The classification of the incident.
reason (string): The reason for the incident.
text (string): Additional descriptive text about the incident.
homeScore (integer): The score of the home team at the time of the incident.
awayScore (integer): The score of the away team at the time of the incident.
time (integer): The time in minutes when the incident occurred.
length (nullable): The duration of the incident, if applicable.
addedTime (integer): The amount of added time for the incident.
reversedPeriodTime (integer): The time in the reversed period if applicable.
playerName (nullable): The name of the player involved in the incident.
player (nullable): An identifier for the player involved in the incident.
isHome (nullable): Indicates if the incident involved the home team.
confirmed (nullable): Indicates if the incident has been confirmed.
assist1 (nullable): The first assisting player, if applicable.
assist2 (nullable): The second assisting player, if applicable.
playerIn (nullable): The player who came in, if applicable.
playerOut (nullable): The player who went out, if applicable.
injury (nullable): Indicates if the incident was related to an injury.
Notes
Ensure that the id parameter is valid and corresponds to an existing match to receive accurate incident data.
The response may contain multiple incidents, depending on the match events.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/incidents/{id}
200
OK
Match Graphs
get
Get Match Graph Data
This endpoint retrieves graph data for a specific football match identified by its unique id. It provides insights into various metrics related to the match over time.
id (required): The unique identifier for the football match whose graph data is to be retrieved.
Response
The response is a JSON object containing the following structure:
status (boolean): Indicates whether the request was successful.
statusCode (integer): A code representing the status of the response.
message (string): A message providing additional information about the response.
response (object): Contains the graph data:
graphPoints (array): An array of objects representing data points on the graph. Each object contains:
minute (integer): The minute of the match when the data point was recorded.
value (integer): The value associated with the data point.
periodTime (integer): The total time for the match period in seconds.
overtimeLength (integer): The length of any overtime played in seconds.
periodCount (integer): The number of periods in the match.
This endpoint is useful for applications that need to visualize match statistics over time, allowing users to analyze the performance and key moments of the game.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/graphs/{id}
200
OK
Match Shotmap
get
Endpoint Description
This endpoint retrieves the shot map data for a specific match in football based on the provided match ID. The shot map includes detailed information about various shots taken during the match, including player details, shot types, and coordinates.
id (required): The unique identifier of the match for which the shot map is requested.
Response Structure
The response will return a JSON object with the following structure:
status: A boolean indicating the success of the request.
statusCode: An integer representing the status code of the response.
message: A string providing additional information about the response.
response: An array of shot data objects, each containing:
player: An object with details about the player:
name: The name of the player.
shortName: The abbreviated name of the player.
position: The position of the player on the field.
jerseyNumber: The jersey number of the player.
id: The unique identifier of the player.
isHome: A boolean indicating if the player is part of the home team.
shotType: A string describing the type of shot taken.
situation: A string representing the situation during which the shot was taken.
playerCoordinates: An object containing the coordinates (x, y, z) of the player at the time of the shot.
bodyPart: A string indicating which body part was used for the shot.
goalMouthLocation: A string describing the location of the goal mouth.
goalMouthCoordinates: An object containing the coordinates (x, y, z) of the goal mouth.
blockCoordinates: An object containing the coordinates (x, y, z) where the shot was blocked, if applicable.
xg: A float representing the expected goals from the shot.
xgot: A float representing the expected goals on target from the shot.
id: The unique identifier of the shot.
time: An integer representing the time of the shot in the match.
timeSeconds: An integer representing the time of the shot in seconds.
draw: An object containing the coordinates for drawing the shot:
start: The starting coordinates (x, y) of the shot.
block: The coordinates (x, y) where the shot was blocked.
end: The ending coordinates (x, y) of the shot.
goal: The coordinates (x, y) of the goal.
reversedPeriodTime: An integer representing the reversed period time.
reversedPeriodTimeSeconds: An integer representing the reversed period time in seconds.
periodTimeSeconds: An integer representing the period time in seconds.
incidentType: A string describing the type of incident related to the shot.
This endpoint is essential for analyzing match performance and player statistics based on shot data.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/shotmap/{id}
200
OK
Match Shotmap Player
get
Endpoint Description
This endpoint retrieves detailed information about a specific player's shot during a football match. It provides insights into the player's actions, shot characteristics, and relevant coordinates on the field.
This endpoint retrieves head-to-head statistics between two football teams based on the provided match ID. It is useful for analyzing the performance of teams against each other in terms of wins, draws, and losses.
id (path parameter): The unique identifier of the match manager. This parameter is required to specify which manager's details are being requested.
Expected Response Format
The response will be in JSON format and will contain the following fields:
status: A boolean indicating the success of the request.
statusCode: A numerical code representing the status of the request.
message: A string that may contain additional information about the request.
response: An object containing details of the match managers:
homeManager: An object with details about the home manager:
name: The name of the home manager.
shortName: The short name of the home manager.
id: The unique identifier of the home manager.
awayManager: An object with details about the away manager:
name: The name of the away manager.
shortName: The short name of the away manager.
id: The unique identifier of the away manager.
Notes
Ensure that the id parameter is valid and corresponds to an existing match manager in the system.
The response will return a 200 status code upon successful retrieval of the manager's details. In case of an invalid id, a 404 status code will be returned.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/managers/{id}
200
OK
Match Best Players
get
Get Best Players for a Match
This endpoint retrieves the best players from both home and away teams for a specific match identified by the provided id. It also includes the player of the match in the response.
id (required): The unique identifier of the match for which the best players are being requested.
Response
The response will be a JSON object containing the following fields:
status (boolean): Indicates the success of the request.
statusCode (integer): A code representing the status of the response.
message (string): A message providing additional information about the response.
response (object): Contains details about the best players:
bestHomeTeamPlayers (array): A list of players from the home team, each represented by:
value (string): The value associated with the player.
label (string): The label for the player.
player (object): Contains player details:
name (string): The full name of the player.
shortName (string): The abbreviated name of the player.
position (string): The playing position of the player.
jerseyNumber (integer): The jersey number of the player.
height (integer): The height of the player in centimeters.
id (integer): The unique identifier of the player.
marketValueCurrency (string): The currency of the player's market value.
dateOfBirthTimestamp (integer): The timestamp of the player's date of birth.
proposedMarketValueRaw (object): Contains:
value (integer): The proposed market value of the player.
currency (string): The currency of the proposed market value.
bestAwayTeamPlayers (array): A list of players from the away team with the same structure as bestHomeTeamPlayers.
playerOfTheMatch (object): The player recognized as the player of the match, structured similarly to the players in the lists above.
This endpoint provides a comprehensive overview of the top-performing players in a match, facilitating insights into player performance.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/best-players/{id}
200
OK
Match Featured Player
get
Endpoint Description
This endpoint retrieves featured player information for a specific football match identified by the id parameter. It provides details about the best players from both home and away teams, as well as the player of the match.
id: The unique identifier for the match (required).
Response Format
The response will be in JSON format and includes the following structure:
status: A boolean indicating the success of the request.
statusCode: An integer representing the status code of the response.
message: A string that may contain additional information about the response.
response: An object containing:
bestHomeTeamPlayers: An array of objects representing the best players from the home team. Each object includes:
value: A string representing the player's value.
label: A string representing the player's label.
player: An object with player details including:
name: The player's name.
shortName: The player's short name.
position: The player's position on the field.
jerseyNumber: The player's jersey number.
height: The player's height.
id: The player's unique identifier.
marketValueCurrency: The currency of the player's market value.
dateOfBirthTimestamp: The player's date of birth in timestamp format.
proposedMarketValueRaw: An object containing:
value: The proposed market value.
currency: The currency of the proposed market value.
bestAwayTeamPlayers: Similar structure as bestHomeTeamPlayers for the away team.
playerOfTheMatch: An object representing the player of the match, with the same structure as the players in the best players arrays.
Authorizations
HTTPRequired
Path parameters
idintegerRequiredExample: 14131866
Header parameters
x-api-keystringOptional
Responses
200
OK
text/plain
Responsestring
get
/football/api/v1/match/featured-player/{id}
200
OK
Match Commentary
get
Get Match Commentary
This endpoint retrieves live commentary for a specific football match identified by its unique id. It allows users to access real-time updates and insights during the match.
