Competition Details

Competition Details

get

Endpoint Description

This API endpoint retrieves detailed information about a specific football competition based on the provided tournament identifier (:tid).

HTTP Method

GET

Endpoint

https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid

Request Parameters

  • :tid (Path Parameter): The unique identifier for the tournament you want to retrieve information for. This should be replaced with the actual tournament ID.

Response Fields

  • status: Indicates the success of the request.

  • statusCode: A numerical code representing the status of the response.

  • message: Additional information about the response.

  • response: Contains detailed information about the competition, including:

    • name: Name of the competition.

    • category: Details about the category of the competition.

    • titleHolder: Information about the current title holder.

    • mostTitlesTeams: Teams with the most titles in the competition.

    • seasons: List of seasons associated with the competition.

    • featuredMatch: Details of featured matches within the competition.

This endpoint provides comprehensive details about a specific football competition, including its structure, title holders, historical data, and current season information.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}
200

OK

get

Endpoint Description

This endpoint retrieves featured matches for a specific tournament in the football API. It allows users to access detailed information about ongoing or upcoming matches within a specified tournament.

Request

  • Method: GET

  • URL: https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/featured

Path Parameters

  • :tid (required): The unique identifier for the tournament. This parameter specifies which tournament's featured matches are being requested.

Expected Response

The response will return a JSON object containing 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 request status (if any).

  • response: An array of featured match objects, each containing:

    • tournamentId: The ID of the tournament.

    • id: The unique ID of the match.

    • startTimestamp: The start time of the match in Unix timestamp format.

    • detailId: An identifier for detailed match information.

    • season: An object containing:

      • name: The name of the season.

      • year: The year of the season.

      • id: The ID of the season.

    • roundInfo: An object providing details about the round:

      • round: The round number.

      • name: The name of the round.

    • status: An object with match status details:

      • code: The status code.

      • description: A textual description of the status.

      • type: The type of status.

    • homeTeam: An object containing details about the home team, including:

      • name: The name of the team.

      • shortName: The abbreviated name of the team.

      • gender: The gender category of the team.

      • nameCode: The code used for the team's name.

      • disabled: A boolean indicating if the team is disabled.

      • national: A boolean indicating if the team is a national team.

      • type: The type of team (e.g., club, national).

      • id: The unique ID of the team.

      • country: An object containing country details.

      • subTeams: An array of sub-teams, if applicable.

    • homeScore: An object containing aggregated score information for the home team.

    • awayTeam: Similar structure as homeTeam, but for the away team.

    • awayScore: An object containing aggregated score information for the away team.

    • time: An object with timing information for the match.

    • tournament: An object containing tournament details, including:

      • id: The ID of the tournament.

      • name: The name of the tournament.

      • category: An object with category details.

      • details: An object with additional tournament details.

Additional Notes

  • Ensure that the :tid parameter is correctly replaced with a valid tournament ID to receive the appropriate data.

  • The response may include multiple featured matches, depending on the tournament and its scheduling.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/featured
200

OK

Competition Season Info

get

Endpoint Description

This endpoint retrieves detailed information about a specific football competition for a given season. It allows users to access various statistics related to the competition, including team performance metrics.

Request

  • Method: GET

  • URL: https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/info

Path Parameters

  • :tid (string): The unique identifier for the tournament.

  • :sid (string): The unique identifier for the season.

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 related to the request status.

  • response (object): Contains detailed statistics for the competition:

    • goals (integer): Total number of goals scored.

    • homeTeamWins (integer): Total number of wins by home teams.

    • awayTeamWins (integer): Total number of wins by away teams.

    • draws (integer): Total number of drawn matches.

    • yellowCards (integer): Total number of yellow cards issued.

    • redCards (integer): Total number of red cards issued.

    • newcomersUpperDivision (array): List of newcomers in the upper division.

    • newcomersLowerDivision (array): List of newcomers in the lower division.

    • newcomersOther (array): List of newcomers in other divisions.

    • numberOfCompetitors (integer): Total number of competitors in the competition.

    • id (integer): Unique identifier for the competition.

    • hostCountries (array): List of countries hosting the competition.

This structure allows clients to easily interpret the competition's performance and statistics for the specified season.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/info
200

OK

Competition Season Matches

get

Endpoint Description

This endpoint retrieves a list of matches for a specific tournament and season in the football API. It provides detailed information about each match, including team details, scores, and tournament information.

Request

HTTP Method: GET Endpoint: https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/matches

Path Parameters

  • :tid (Tournament ID): The unique identifier for the tournament.

  • :sid (Season ID): The unique identifier for the season within the tournament.

Response

The response will return a JSON object containing the following structure:

  • status (boolean): Indicates the success of the request.

  • statusCode (integer): A code representing the status of the request.

  • message (string): A message providing additional information about the request.

  • response (array): An array of match objects, each containing:

    • tournamentId (integer): The ID of the tournament.

    • id (integer): The unique identifier for the match.

    • startTimestamp (integer): The start time of the match in timestamp format.

    • detailId (integer): An identifier for match details.

    • season (object): Contains season information including:

      • name (string): The name of the season.

      • year (string): The year of the season.

      • seasonCoverageInfo (object): Additional coverage information for the season.

      • id (integer): The unique identifier for the season.

    • roundInfo (object): Information about the round of the match including:

      • round (integer): The round number.

      • name (string): The name of the round.

    • status (object): Current status of the match including:

      • code (integer): Status code.

      • description (string): Description of the status.

      • type (string): Type of status.

    • homeTeam (object): Details of the home team including:

      • name, shortName, gender, nameCode, disabled, national, type, id, country (object), subTeams (array).

    • homeScore (object): Current score details for the home team including:

      • current, display, period1, period2, normaltime (all integers).

    • awayTeam (object): Details of the away team (same structure as homeTeam).

    • awayScore (object): Current score details for the away team (same structure as homeScore).

    • time (object): Information about the current period start timestamp.

    • tournament (object): Information about the tournament including:

      • id, name, category (object), details (object).

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/matches
200

OK

Competition Season Standings

get

Endpoint Description

This endpoint retrieves the standings for a specific tournament and season in football. It provides detailed information about the teams participating in the tournament, including their performance metrics.

Request

  • Method: GET

  • URL: https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/standings

Path Parameters

  • :tid (Tournament ID): The unique identifier for the tournament whose standings are being requested.

  • :sid (Season ID): The unique identifier for the season of the tournament.

Response

The response is a JSON object containing the following structure:

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

  • response (array): An array containing the standings for the specified tournament and season, structured as follows:

    • id (integer): The unique identifier for the standings entry.

    • type (string): The type of standings.

    • name (string): The name of the standings.

    • standings (array): An array of team standings, with each entry containing:

      • team (object): Information about the team, including:

        • name (string): The full name of the team.

        • shortName (string): The abbreviated name of the team.

        • gender (string): The gender category of the team.

        • nameCode (string): A code representing the team name.

        • disabled (boolean): Indicates if the team is disabled.

        • national (boolean): Indicates if the team is a national team.

        • type (integer): The type of team.

        • id (integer): The unique identifier for the team.

        • country (object): Information about the team's country, including:

          • alpha2 (string): The 2-letter country code.

          • alpha3 (string): The 3-letter country code.

          • name (string): The name of the country.

      • descriptions (array): Additional descriptions related to the team's standings.

      • promotion (object): Information about promotion, including:

        • text (string): Text related to promotion.

        • id (integer): The identifier for the promotion.

      • position (integer): The position of the team in the standings.

      • matches (integer): The number of matches played.

      • wins (integer): The number of wins.

      • scoresFor (integer): The total scores for the team.

      • scoresAgainst (integer): The total scores against the team.

      • id (integer): The unique identifier for the standings entry.

      • losses (integer): The number of losses.

      • draws (integer): The number of draws.

      • points (integer): The total points accumulated.

      • scoreDiffFormatted (string): A formatted string representing the score difference.

    • tournament (object): Information about the tournament, including:

      • id (integer): The unique identifier for the tournament.

      • name (string): The name of the tournament.

      • category (object): Information about the category of the tournament, including:

        • name (string): The name of the category.

        • id (integer): The unique identifier for the category.

        • country (object): Information about the country associated with the category.

        • flag (string): The flag associated with the category.

      • details (object): Additional details about the tournament, including:

        • name (string): The name of the tournament details.

        • category (object): The category information.

        • hasPerformanceGraphFeature (boolean): Indicates if the tournament has a performance graph feature.

        • id (integer): The unique identifier for the tournament details.

        • country (object): Information about the country associated with the tournament.

        • displayInverseHomeAwayTeams (boolean): Indicates if home and away teams should be displayed inversely.

    • updatedAtTimestamp (integer): The timestamp of the last update for the standings.

This endpoint is essential for retrieving current standings and performance metrics for teams in a specified tournament and season.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/standings
200

OK

Competition Season Top Players

get

Get Top Players by Competition and Season

This endpoint retrieves a list of top players for a specific football competition and season.

Request Method

GET

Endpoint

https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/top-players

Path Parameters

  • :tid (string): The unique identifier for the football competition.

  • :sid (string): The unique identifier for the season of the competition.

Expected Response Format

On a successful request, the API will return a JSON object containing the top players for the specified competition and season. The response will include details such as player names, positions, and performance statistics.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/top-players
200

OK

Competition Season Top Teams

get

Get Top Teams in a Specific Competition Season

This endpoint retrieves a list of top teams for a specified competition and season. It is useful for obtaining insights into the performance of teams within a particular league or tournament.

Request Method

GET

Endpoint

https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/top-teams

Path Parameters

  • :tid (string): The unique identifier for the competition (e.g., league or tournament).

  • :sid (string): The unique identifier for the season within the specified competition.

Expected Response Format

The response will be in JSON format and will typically include:

  • A list of top teams, each containing:

    • teamId: The unique identifier for the team.

    • teamName: The name of the team.

    • points: The total points accumulated by the team in the specified season.

    • matchesPlayed: The total number of matches played by the team.

Additional Notes

  • Ensure that the values for :tid and :sid are valid to receive accurate results.

  • This endpoint is particularly useful for sports analysts, fans, and developers looking to integrate team performance data into their applications.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/top-teams
200

OK

Competition Season Rounds

get

Get Competition Rounds

This endpoint retrieves the rounds of a specific season for a given competition in football.

Request

  • Method: GET

  • Endpoint: https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/rounds

Path Parameters

  • :tid (string): The unique identifier for the competition.

  • :sid (string): The unique identifier for the season.

Response Format

The response will be in JSON format and includes the following fields:

  • status (boolean): Indicates if the request was successful.

  • statusCode (integer): The status code of the response.

  • message (string): A message providing additional information about the request.

  • response (array): An array of objects containing details about each round, where each object includes:

    • round (integer): The round number.

    • name (string): The name of the round.

    • prefix (string): A prefix associated with the round.

    • current (boolean): Indicates if this is the current round.

This endpoint is useful for obtaining the structure of competition rounds within a specified season.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/rounds
200

OK

Competition Season Rounds Matches

get

Endpoint Description

This API endpoint retrieves the matches for a specific round of a tournament in a given season. It provides detailed information about each match, including team details, scores, and tournament information.

HTTP Method

GET

Endpoint

https://apiv3.sportsapi360.com/football/api/v1/competitions/:tid/season/:sid/rounds/matches

URL Parameters

  • :tid (Tournament ID): The unique identifier for the tournament.

  • :sid (Season ID): The unique identifier for the season.

Expected Response Format

The response will be a JSON object containing the following structure:

  • status (boolean): Indicates the success of the request.

  • statusCode (integer): A code representing the status of the response.

  • message (string): A message providing additional context about the response.

  • response (array): An array of match details for the specified round, each containing:

    • round (integer): The round number.

    • name (string): The name of the round.

    • matches (array): An array of match objects, each with:

      • tournamentId (integer): The ID of the tournament.

      • id (integer): The unique identifier for the match.

      • startTimestamp (integer): The timestamp when the match starts.

      • detailId (integer): The ID for detailed match information.

      • season (object): Contains season details including:

        • name (string): The name of the season.

        • year (integer): The year of the season.

        • seasonCoverageInfo (object): Additional coverage information.

        • id (integer): The ID of the season.

      • roundInfo (object): Information about the round including:

        • round (integer): The round number.

        • name (string): The name of the round.

      • status (object): Current status of the match including:

        • code (integer): Status code.

        • description (string): Description of the status.

        • type (string): Type of status.

      • homeTeam (object): Details about the home team, including:

        • name (string): Team name.

        • shortName (string): Short name of the team.

        • gender (string): Gender category of the team.

        • disabled (boolean): Indicates if the team is disabled.

        • national (boolean): Indicates if the team is national.

        • country (object): Country details of the team.

      • homeScore (object): Current score details for the home team.

      • awayTeam (object): Details about the away team (similar structure to homeTeam).

      • awayScore (object): Current score details for the away team.

      • time (object): Information about the current period of the match.

      • tournament (object): Details about the tournament including:

        • id (integer): Tournament ID.

        • name (string): Name of the tournament.

        • category (object): Category details of the tournament.

Additional Notes

  • Ensure to replace :tid and :sid with the appropriate tournament and season IDs when making the request.

  • The response will provide comprehensive details for each match, which can be useful for applications displaying match schedules or statistics.

Authorizations
HTTPRequired
Path parameters
tidintegerRequiredExample: 7
sidintegerRequiredExample: 61644
Header parameters
x-api-keystringOptional
Responses
chevron-right
200

OK

text/plain
Responsestring
get
/football/api/v1/competitions/{tid}/season/{sid}/rounds/matches
200

OK

Last updated