{"openapi":"3.0.0","paths":{"/football/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAllCountries","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"France","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Football.Countries"]}},"/football/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getCountryByCountryCode","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Football.Countries"]}},"/football/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Superettan","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"SE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Sweden","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Football.Leagues"]}},"/football/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Football.Leagues"]}},"/football/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Skövde AIK","type":"string"}},{"required":false,"name":"type","in":"query","schema":{"example":"club","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Football.Teams"]}},"/football/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_teamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Football.Teams"]}},"/football/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Football.Teams"]}},"/football/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Half time | Half time pause between first and second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and extra time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after extra time | Match has been concluded in extra time. |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| In progress | Match is considered in play but the coverage information is minimal. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Football matches example](https://highlightly.net/assets/img/documentation/football/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Superettan","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":97798,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":5700782,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":1907875,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Skövde AIK","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Vasteras SK FK","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"SE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Sweden","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Football.Matches"]}},"/football/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain 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:\n\n| Type | Description |\n| ----------- | ----------- |\n| Goal | A player strikes the ball into the opposing team's goal. |\n| Own Goal | A player strikes or deflects the ball into their own team's goal. |\n| Penalty | A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area. |\n| Missed Penalty | The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper. |\n| Yellow Card | A player is cautioned by the referee for unsporting behavior or foul play. |\n| Red Card | A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card. |\n| Substitution | A player is replaced by another player from the bench during a stoppage in play. |\n| VAR Goal Confirmed | The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand. |\n| VAR Goal Cancelled | The VAR review determines that a goal should be disallowed due to an infringement or violation. |\n| VAR Penalty | The VAR review results in a penalty being awarded to a team. |\n| VAR Penalty Cancelled | The VAR review results in a previously awarded penalty being overturned. |\n| VAR Goal Cancelled - Offside | The VAR review determines that a goal should be disallowed due to an offside infringement. |\n\nThe above list may be updated with additional entries in the future.\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Football.Matches"]}},"/football/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `goal-clip` | A single goal clip. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `press-conference` | Official press conferences and media availability. |\n| `behind-the-scenes` | Training sessions, tunnel cams, inside-access content. |\n| `live-coverage` | Raw live streams (warm-ups, watch-alongs), as opposed to edited recaps. |\n| `discussion-analysis` | Studio shows, punditry and tactical analysis. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/football/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/football-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"TR","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Turkey","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Süper Lig","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":173537,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-08-11","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":914490490,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":850082,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":856039,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Trabzonspor","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Antalyaspor","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Football.Highlights"]}},"/football/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Football.Highlights"]}},"/football/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Football.Highlights"]}},"/football/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"FootballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Football.Bookmakers"]}},"/football/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"FootballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Football.Bookmakers"]}},"/football/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| 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`.|\n| Odd or Even | The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| 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`. |\n| Both Teams to Score | The market defines whether both teams will score or not. Outcomes can be either `Yes` or `No`. |\n| 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. |\n| 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. |\n| 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`. |\n| 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. |\n| 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`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-hda.png)","operationId":"FootballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":1,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Stake.com","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Football.Odds"]}},"/football/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/football/standings.png)","operationId":"FootballStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":33973,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2023,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Football.Standings"]}},"/football/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"FootballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":5700782,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Football.Last Five Games"]}},"/football/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/football/h2h.png)","operationId":"FootballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":314803,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":5700782,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Football.Head 2 Head"]}},"/football/lineups/{matchId}":{"get":{"description":"> Lineups are requested from 40 minutes before kickoff until 120 minutes after.\n\n> Refresh interval: Once every 15 minutes\n\nRetrieve home and away team lineups for a specific match.\n\nUnderstanding 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.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n![Football lineups example](https://highlightly.net/assets/img/documentation/football/lineups.png)\n","operationId":"FootballLineupsController_getLineups","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballLineupsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get linups by match id","tags":["Football.Lineups"]}},"/football/statistics/{matchId}":{"get":{"description":"> Refresh interval: Once every 5 minutes\n\nRetrieve match statistics data by specifying the `matchId` as the path parameter.\n\nBelow is an example of what you can aim to achieve with the statistics endpoint:\n\n![Football statistics example](https://highlightly.net/assets/img/documentation/football/statistics.png)","operationId":"FootballStatisticsController_getStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested statistics for given match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"404":{"description":"Match statistics not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match statistics by match id","tags":["Football.Statistics"]}},"/football/events/{id}":{"get":{"description":"> Refresh interval: Once a minute\n\nRetrieve a list of live events for a match by specifying the match `id` path parameter.\n\nCurrently supported live events:\n\n| Type | Description |\n| ----------- | ----------- |\n| Goal | A player strikes the ball into the opposing team's goal. |\n| Own Goal | A player strikes or deflects the ball into their own team's goal. |\n| Penalty | A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area. |\n| Missed Penalty | The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper. |\n| Yellow Card | A player is cautioned by the referee for unsporting behavior or foul play. |\n| Red Card | A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card. |\n| Substitution | A player is replaced by another player from the bench during a stoppage in play. |\n| VAR Goal Confirmed | The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand. |\n| VAR Goal Cancelled | The VAR review determines that a goal should be disallowed due to an infringement or violation. |\n| VAR Penalty | The VAR review results in a penalty being awarded to a team. |\n| VAR Penalty Cancelled | The VAR review results in a previously awarded penalty being overturned. |\n| VAR Goal Cancelled - Offside | The VAR review determines that a goal should be disallowed due to an offside infringement. |\n\nThe above list may be updated with additional entries in the future.\n\nBelow is an example of what you can aim to achieve with the live events endpoint:\n\n![Football live events example](https://highlightly.net/assets/img/documentation/football/live-events.png)","operationId":"FootballLiveEventsController_getLiveEvents","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballLiveEventDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get live events by match id","tags":["Football.Live Events"]}},"/football/players":{"get":{"description":"> Refresh interval: 15 minutes\n\n> Route returns only general player information. For additional player details check the `players/{playerId}` and `players/{playerId}/statistics` routes. \n\nRetrieve a list of players based on the requested query parameters. \n\nReturned 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.","operationId":"PlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Ivan Perišić","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FootballPlayerPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["Football.Players"]}},"/football/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description |\n| ------------ | ----------- |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n\nBelow is an example of what you can aim to achieve with the player summary endpoint:\n\n![Player summary example](https://highlightly.net/assets/img/documentation/football/player-details.png)","operationId":"PlayersController_getPlayerSummaryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["Football.Players"]}},"/football/players/{id}/statistics":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player statistics by specifying the player `id` path parameter.\n\nDetailed player statistics is split into `perClub` and `perCompetition` aggregation. The following statistics are available:\n\n| Type | Description |\n|--------------------|-----------------------------------------------------------------------------|\n| Goals | Number of goals scored by the player. |\n| Assists | Number of assists provided by the player. |\n| Own goals | Number of goals accidentally scored against the player's own team. |\n| Red cards | Number of direct red cards received. |\n| Clean sheets | Number of matches where no goals were conceded (mostly relevant for goalkeepers). |\n| Games played | Total number of matches the player appeared in. |\n| Yellow cards | Number of yellow cards received. |\n| Goals conceded | Number of goals the team conceded while the player was on the pitch (mainly for goalkeepers). |\n| Minutes played | Total number of minutes the player was on the field. |\n| Substituted in | Number of times the player came on as a substitute. |\n| Substituted out | Number of times the player was substituted off. |\n| Penalties scored | Number of penalty goals scored. |\n| Second yellow cards | Number of second yellow cards leading to a red card. |\n\nAdditionally, the competitions are split into multiple categories:\n\n| Type | Description |\n|------------------|-----------------------------------------------------------------------------|\n| National league | A country's main domestic competition where clubs play each other over a season (e.g., Premier League, La Liga). |\n| National cup | A domestic knockout tournament open to clubs from different divisions (e.g., FA Cup, Copa del Rey). |\n| International cup| A tournament involving clubs from multiple countries (e.g., UEFA Champions League, Copa Libertadores). |\n\n![Player stats example](https://highlightly.net/assets/img/documentation/football/player-stats.png)","operationId":"PlayersController_getPlayerStatisticsById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player statistics by player id","tags":["Football.Players"]}},"/football/box-score/{matchId}":{"get":{"description":"> Refresh interval: Once every 5 minutes\n\nRetrieve detailed per-player box score match statistics data by specifying the `matchId` as the path parameter.\n\nThe 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:\n\n| Data | Description |\n| --------------| --------------------------------------------------------------- |\n| id | Unique identifier for the player. |\n| Match rating | Match performance rating (e.g., \"8.00\"). |\n| Shirt number | Player's shirt/jersey number. |\n| Position | Playing position (e.g., \"Goalkeeper\", \"Defender\"). |\n| Is a captain | Indicates if the player was the team captain. |\n| Minutes played | Total minutes played in the match. |\n| Is a substitute | Indicates if the player started as a substitute. |\n| Offside | Number of offsides committed. |\n| Statistics | Detailed performance metrics. |\n| Name | Commonly known name of the player. |\n| Full name | Player's full registered name. |\n| Logo | URL to the player's image/logo, if available. |\n\nBesides the general metadata, each player has the following granular match performance statistics:\n\n| Statistic | Description |\n| -------------------- | ------------------------------------------------------------------ |\n| Goals scored | Number of goals the player scored in the match. |\n| Goals saved | Number of opponent shots saved (goalkeeper stat). |\n| Goals conceded | Goals allowed by the player's team while they were the goalkeeper. |\n| Assists | Passes that directly led to a goal. |\n| Total dribbles | Total dribble attempts made. |\n| Successful dribbles | Dribble attempts that successfully beat an opponent. |\n| Failed dribbles | Dribble attempts that were unsuccessful. |\n| Dribble success rate | Percentage of dribbles that were successful. |\n| Fouls received | Times the player was fouled by opponents. |\n| Fouls commited | Fouls committed by the player. |\n| Total tackles | Total tackles attempted. |\n| Total interceptions | Number of times the player intercepted an opponent's pass. |\n| Shots on target | Shots directed at goal that required a save or resulted in a goal. |\n| Shots off target | Shots that missed the goal completely. |\n| Shots total | Total shots attempted (on and off target). |\n| Shots accuracy | Percentage of shots that were on target. |\n| Penalties scored | Penalty kicks successfully converted into goals. |\n| Penalties missed | Penalty kicks that failed to score. |\n| Total penalties | Total penalty kicks taken. |\n| Penalty accuracy | Percentage of penalties scored. |\n| Passing accuracy | Percentage of completed passes. |\n| Successful passes | Passes that successfully reached a teammate. |\n| Failed passes | Passes that failed to reach a teammate. |\n| Total passes | Total passes attempted. |\n| Key passes | Passes that directly created a goal-scoring opportunity. |\n| Red cards | Number of red cards received. |\n| Yellow cards | Number of yellow cards received. |\n| Second yellow cards | Number of second yellow cards leading to a red card. |\n| Total duels | Number of 1v1 challenges contested. |\n| Won duels | Number of duels won. |\n| Lost duels | Number of duels lost. |\n| Duel success rate | Percentage of duels won. |\n| Expected assists (xA) | The estimated number of assists the player should have, based on chance quality. |\n| Expected goals (xG) | The estimated number of goals the player should have scored, based on chance quality. |\n| Expected goals on target (xGOT) | The expected number of goals based on the placement and quality of shots on target. |\n| Expected goals on target conceded (xGOT Conceded) | The expected number of goals a goalkeeper should have conceded based on shots faced. |\n| Expected goals prevented (xGP) | Difference between expected goals on target conceded and actual goals conceded (goalkeeper stat). |\n\nBelow is an example of what you can aim to achieve with the player box score endpoint:\n\n![Football player box score example](https://highlightly.net/assets/img/documentation/football/player-box-score.png)","operationId":"FootballPlayerBoxScoreController_getPlayerBoxScores","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FootballPlayerMatchStatisticsResponse"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Retrieve box scores for specified match id.","tags":["Football.Match Box Score"]}},"/american-football/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Bengals","type":"string"}},{"required":false,"name":"displayName","in":"query","schema":{"example":"Cincinnati Bengals","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"CIN","type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NFL","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["American Football.Teams"]}},"/american-football/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmfTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["American Football.Teams"]}},"/american-football/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["American Football.Teams"]}},"/american-football/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| Finished | Match has been concluded. |\n| Scheduled | Match has not been started yet. |\n| End period | Break time between periods. |\n| Half time | Half time pause between second and third quarter. |\n| In progress | Game is currently in progress. |\n| Unknown | Unknown match coverage or state. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![American football matches example](https://highlightly.net/assets/img/documentation/american-football/matches.png)","operationId":"MatchController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NFL","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-08-23","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":92730,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":92731,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Bengals","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Colts","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"CIN","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"IND","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Cincinnati Bengals","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Indianapolis Colts","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["American Football.Matches"]}},"/american-football/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue`, weather `forecast`, `matchStatistics` for each team, `injuries`, `events` and `predictions`.\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["American Football.Matches"]}},"/american-football/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `touchdown-pass` | Passing touchdown. |\n| `touchdown-rush` | Rushing touchdown. |\n| `touchdown-reception` | Receiving touchdown (receiver featured). |\n| `touchdown` | Touchdown (mechanism not specified). |\n| `interception` | Interception (no return score). |\n| `interception-return-td` | Pick-six: interception returned for a touchdown. |\n| `fumble` | Fumble or strip-sack (no return score). |\n| `fumble-recovery-td` | Fumble recovered and returned for a touchdown. |\n| `sack` | Quarterback sack. |\n| `field-goal` | Field-goal attempt. |\n| `safety` | A safety (two-point defensive score). |\n| `special-teams-play` | Punts, kickoffs, returns and other special-teams plays. |\n| `special-teams-td` | Kick or punt return touchdown. |\n| `two-point-conversion` | Two-point conversion attempt. |\n| `penalty` | Flags, penalties and ejections. |\n| `big-play` | Long gains, key conversions and other significant non-scoring plays. |\n| `defensive-play` | Stops, blocked kicks, pass break-ups and other defensive plays. |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/american-football/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/nfl-ncaa-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NCAA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-08-31","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":49130,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":92884,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":92885,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Boilermakers","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Sycamores","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"PUR","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"INST","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Purdue Boilermakers","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Indiana State Sycamores","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["American Football.Highlights"]}},"/american-football/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["American Football.Highlights"]}},"/american-football/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["American Football.Highlights"]}},"/american-football/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g-american-football.png)","operationId":"AmericanFootballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":92730,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["American Football.Last Five Games"]}},"/american-football/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/american-football/h2h.png)","operationId":"AmericanFootballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":92730,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":92731,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["American Football.Head 2 Head"]}},"/american-football/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"AmericanFootballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["American Football.Bookmakers"]}},"/american-football/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"AmericanFootballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["American Football.Bookmakers"]}},"/american-football/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Away` or `Draw`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Totals | This is considered a complex market. It is split into multiple possible variants such as *\"Totals 25\"*, *\"Totals 25.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even | The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Spread | This is considered a complex market. It is split into multiple possible variants such as *\"Spread -28.5/+28.5\"*, *\"Spread -21.25/+21.25 \"* and so on. The possible outcome of a variant is either `Home` or `Away`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"AmericanFootballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NFL","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":21454,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Stake.com","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["American Football.Odds"]}},"/american-football/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n \n Retrieve standings data for a specific league, conference or division.\n \n There are numerous ways on how to fetch the data. You can utilise either `abbreviation` or `leagueName`:\n\n | League Name | Abbreviation |\n | ----------- | ----------- |\n | American Athletic Conference |\tAAC |\n | Atlantic Coast Conference |\tACC |\n | Big 12 Conference |\tBIG12 |\n | Big Ten Conference | BIG10 |\n | American Football Conference | AFC |\n | National Football Conference | NFC |\n | Conference USA | USA |\n | Mid-American Conference |\tMIDAM |\n | Mountain West Conference | MWEST |\n | Pac-12 Conference |\tPAC12 |\n | Sun Belt - West |\tBELTW |\n | FBS Independents | IND |\n | Southeastern Conference |\tSEC |\n | Sun Belt - East\t| BELTE |\n | National Football Conference\t| NFC |\n | American Football Conference\t| AFC |\n\nAdditionally you can specify the `year` parameter to narrow down the the standings for that season.\n\nThere are two other important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned standings will be. If the number of actual standings is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nBelow is an example on how you could render league associated standings\n \n![Standings example](https://highlightly.net/assets/img/documentation/american-football/standings.png)","operationId":"AmericanFootballStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueType","in":"query","schema":{"example":"NFL","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":10,"default":10,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"National Football Conference","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"NFC","type":"string"}},{"required":false,"name":"year","in":"query","schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballStandingsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["American Football.Standings"]}},"/american-football/lineups/{matchId}":{"get":{"description":"> Lineups should be queried up to a few hours before the game starts.\n\nRetrieve home and away team lineups for a specific match.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n![American Football lineups example](https://highlightly.net/assets/img/documentation/american-football/lineups.png)\n","operationId":"AmericanFootballLineupsController_getLineups","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballLineupsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get linups by match id","tags":["American Football.Lineups"]}},"/american-football/players":{"get":{"description":"> Refresh interval: 15 minutes\n\n> Route returns only general player information. For additional player details check the `players/{playerId}` and `players/{playerId}/statistics` routes. \n\nRetrieve a list of players based on the requested query parameters. \n\nReturned 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.","operationId":"AmericanFootballPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Tom Brady","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmericanFootballPlayerPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["American Football.Players"]}},"/american-football/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description |\n| ------------ | ----------- |\n| Profile | Provides a structured summary of a player's personal and professional profile. It includes key details such as current team affiliation, physical attributes (height, weight), 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. |\n","operationId":"AmericanFootballPlayersController_getPlayerSummaryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["American Football.Players"]}},"/american-football/players/{id}/statistics":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player statistics by specifying the player `id` path parameter.\n\nDetailed player statistics are aggregated on a `perSeason` level. Each season has the following available coverage:\n\n| Type | Description |\n|--------------------|-----------------------------------------------------------------------------|\n| Entire | Combines both regular season and post-season statistics. Pre-season data is not included. |\n| Season | Includes only regular season statistics. |\n\nRecorded stats are dependant on the player position. In total, the following stats are available:\n\n| Type | Description |\n|------|--------------|\n| General | Overall player or team statistics that summarize performance across multiple aspects (e.g., games played, total yards, touchdowns). |\n| Defense | Statistics related to defensive performance, such as tackles, sacks, interceptions, and forced fumbles. |\n| Returning| Data for return plays on special teams, including punt returns, kickoff returns, and associated yards or touchdowns. |\n| Passing | Passing-related statistics, typically for quarterbacks which inlcude attempts, completions, yards, touchdowns, and interceptions. |\n| Rushing | Rushing statistics, measuring ground plays such as attempts, yards gained, and rushing touchdowns. |\n| Receiving | Statistics for pass catchers such as receptions, receiving yards, average yards per catch, and receiving touchdowns. |\n| Scoring | Scoring-related data, including touchdowns, field goals, extra points, and total points contributed by the player or team. |\n| Punting | Information about punting performance such as number of punts, total yards, average distance, and punts inside the 20-yard line. |\n| Kicking | Kicking statistics, covering field goals and extra point attempts, makes, and success rates. |\n\nNote: As mentioned earlier, statistics are associated with specific player positions. This means the results you receive will vary depending on the player's position.\n\n![American Football Player stats example](https://highlightly.net/assets/img/documentation/american-football/player-stats.png)","operationId":"AmericanFootballPlayersController_getPlayerStatisticsById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player statistics by player id","tags":["American Football.Players"]}},"/american-football/box-score/{matchId}":{"get":{"description":"> Refresh interval: Every minute\n\nRetrieve detailed per-player **American Football box score statistics** by specifying the `matchId` as the path parameter.\n\nThe response is an array with two elements: \n`[homeTeam, awayTeam]`\n\nEach team object contains general team information and a list of player box scores.\n\n---\n\n## Team Structure\n\nEach team (home or away) has the following shape:\n\n| Field | Description |\n|-----------|-------------|\n| id | Unique identifier for the team. |\n| name | Team name. |\n| logo | URL to the team logo, if available. |\n| boxScores | List of per-player box score records for the team. |\n\n---\n\n## Player Box Score\n\nEach item in `boxScores` represents a single player’s performance in the match.\n\n### Player Metadata\n\n| Field | Description |\n|------|-------------|\n| id | Unique identifier for the player. |\n| name | Player’s display name. |\n| jersey | Player’s jersey number, if available. |\n\n---\n\n## Player Statistics\n\nPlayer performance data is provided as a list of statistic records. \nEach record belongs to a **group** (category) and contains a **name/value** pair.\n\n| Field | Description |\n|------|-------------|\n| group | Logical category of the statistic (e.g. `Passing`, `Rushing`, `Defense`). |\n| name | Name of the statistic (e.g. `Total Passing Yards`, `Total Passing Touchdowns`). |\n| value | Value of the statistic. Can be a number, string, or null if not applicable. |\n\n---\n\n## Common Statistic Groups\n\nThe following are example statistic groups you may encounter. \nActual availability depends on player position and match data.\n\n### Passing\n- Total Passes\n- Total Successful Passes\n- Total Passing Yards\n- Yards Per Pass Attempt\n- Total Passing Touchdowns\n- Total Passing Interceptions\n- Total Sacks\n- Total Sack Yards Lost\n- Passing Quarterback Rating\n\n### Rushing\n- Total Rushing Attempts\n- Total Rushing Yards\n- Total Yards Per Rush\n- Total Rushing Touchdowns\n- Long Rushing\n\n### Receiving\n- Total Receptions\n- Total Receiving Yards\n- Yards Per Reception\n- Total Receiving Touchdowns\n- Total Long Receptions\n- Total Receiving Targets\n\n### General\n- Total Fumbles\n- Total Lost Fumbles\n- Total Recovered Fumbles\n- Total Interceptions\n- Yards Interception\n- Total Touchdown Interceptions\n\n### Defense\n- Total Defensive Tackles\n- Total Defensive Solo Tackles\n- Total Defensive Sacks\n- Total Defensive Tackles For Loss\n- Total Defended Passes\n- Defensive Quarterback Rating\n- Total Defensive Touchdowns\n\n### Kicking\n- Total Kick Returns\n- Total Kick Return Yards\n- Yards Per Kick Return\n- Longest Kick Return\n- Total Kick Return Touchdowns\n- Attempted Field Goal Kicks\n- Successful Field Goals Kicks\n- Kicking Field Goal Percentage\n- Long Field Goals Kicks Made\n- Total Extra Kicking Points Made\n- Total Extra Kicking Point Attempts\n- Total Kicking Points\n\n### Punting\n- Total Punts\n- Total Punting Yards\n- Average Gross Punting Yards\n- Punting Touchbacks\n- Punts Inside 20 Yards\n- Longest Punt Yardage\n- Total Punt Returns\n- Total Punt Return Yards\n- Yards Per Punt Return\n- Longest Punt Return\n- Total Punt Return Touchdowns\n---\n\n","operationId":"AmericanFootballPlayerBoxScoreController_getPlayerBoxScores","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballPlayerBoxScoreMatchStatsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Retrieve player box scores for specified match id","tags":["American Football.Match Box Score"]}},"/basketball/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAllCountries","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Basketball.Countries"]}},"/basketball/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getCountryByCountryCode","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Basketball.Countries"]}},"/basketball/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First quarter | Match is considered in play and is in the first period. |\n| Second quarter | Match is considered in play and is in the second period. |\n| Third quarter | Match is considered in play and is in the third period. |\n| Fourth quarter | Match is considered in play and is in the fourth period. |\n| Over time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Regulation period between quarters or over time. |\n| Half time | Half time pause between second and third quarter. |\n| Finished | Match has been concluded. |\n| Finished after over time | Match has been concluded in over time. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Basketball matches example](https://highlightly.net/assets/img/documentation/basketball/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NBL","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":1635,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-10-01","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":7592,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":1635,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Adelaide","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne United","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Basketball.Matches"]}},"/basketball/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue`, match weather `forecast`, both teams `statistics` and the `news`.\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Basketball.Matches"]}},"/basketball/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `dunk` | Dunks and alley-oops. |\n| `three-pointer` | Three-point makes. |\n| `and-one` | Basket plus the foul (incl. four-point plays). |\n| `scoring-play` | Other made baskets (layups, jumpers, floaters, free throws). |\n| `block` | Blocked shots. |\n| `steal` | Steals and takeaways. |\n| `assist-play` | Assists and playmaking passes. |\n| `crossover-handles` | Crossovers, ankle-breakers and dribble moves. |\n| `buzzer-beater-game-winner` | Buzzer-beaters and game-winning shots. |\n| `big-performance` | Stat-line performances (career highs, double/triple-doubles). |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `press-conference` | Official press conferences and media availability. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/basketball/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/basketball-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NBL","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":1635,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-10-01","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":299340885,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":7592,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":1635,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Adelaide","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne United","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Basketball.Highlights"]}},"/basketball/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Basketball.Highlights"]}},"/basketball/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Basketball.Highlights"]}},"/basketball/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NBL","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Basketball.Leagues"]}},"/basketball/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Basketball.Leagues"]}},"/basketball/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Adelaide","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Basketball.Teams"]}},"/basketball/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Basketball.Teams"]}},"/basketball/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Basketball.Teams"]}},"/basketball/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"BasketballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Basketball.Bookmakers"]}},"/basketball/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"BasketballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Basketball.Bookmakers"]}},"/basketball/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| 3-Way Moneyline | The possible outcomes for the three-way moneyline market are `Home`, `Draw` or `Away`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Points | This is considered a complex market. It is split into multiple possible variants such as *\"Total Points 204.5\"*, *\"Total Points 209.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`. |\n| Odd or Even | The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Spread | This is considered a complex market. It is split into multiple possible variants such as *\"Spread -28.5/+28.5\"*, *\"Spread -21.25/+21.25 \"* and so on. The possible outcome of a variant is either `Home` or `Away`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-hda.png)","operationId":"BasketballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":75,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Powbet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Basketball.Odds"]}},"/basketball/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"BasketballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":1635,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Basketball.Last Five Games"]}},"/basketball/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/basketball/h2h.png)","operationId":"BasketballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":1635,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":7592,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Basketball.Head 2 Head"]}},"/basketball/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/basketball/standings.png)","operationId":"BasketballStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":2486,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2023,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasketballStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Basketball.Standings"]}},"/basketball/statistics/{matchId}":{"get":{"description":"> Refresh interval: Once every 5 minutes\n\nRetrieve match statistics data by specifying the `matchId` as the path parameter.\n\nBelow is an example of what you can aim to achieve with the statistics endpoint:\n\n![Basketball statistics example](https://highlightly.net/assets/img/documentation/basketball/statistics.png)","operationId":"BasketballStatisticsController_getStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested statistics for given match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"404":{"description":"Match statistics not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match statistics by match id","tags":["Basketball.Statistics"]}},"/hockey/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAllCountries","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Germany","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Hockey.Countries"]}},"/hockey/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getCountryByCountryCode","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Hockey.Countries"]}},"/hockey/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `goal` | A single goal clip. |\n| `power-play-goal` | Power-play goal. |\n| `shorthanded-goal` | Shorthanded goal. |\n| `overtime-shootout-goal` | Overtime or shootout goal. |\n| `hat-trick` | Hat-trick. |\n| `save` | Goaltender saves. |\n| `fight` | Fights and scraps. |\n| `hit-check` | Big hits and body checks. |\n| `assist-play` | Assists and playmaking passes. |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `press-conference` | Official press conferences and media availability. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/hockey/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/hockey-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"DEL","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":16953,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-10-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":291869956,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":223746,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":214385,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Frankfurt Lowen","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Kolner","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Hockey.Highlights"]}},"/hockey/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Hockey.Highlights"]}},"/hockey/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Hockey.Highlights"]}},"/hockey/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"DEL","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Hockey.Leagues"]}},"/hockey/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Hockey.Leagues"]}},"/hockey/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| 1st period | Match is in the first period of regular play. |\n| 2nd period | Match is in the second period of regular play. |\n| 3rd period | Match is in the third period of regular play. |\n| Over time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and over time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after over time | Match has been concluded in over time. |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Hockey matches example](https://highlightly.net/assets/img/documentation/hockey/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"DEL","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":16953,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-10-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":223746,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":214385,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Frankfurt Lowen","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Kolner","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Hockey.Matches"]}},"/hockey/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Hockey.Matches"]}},"/hockey/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Frankfurt Lowen","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Hockey.Teams"]}},"/hockey/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Hockey.Teams"]}},"/hockey/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Hockey.Teams"]}},"/hockey/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"HockeyBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Hockey.Bookmakers"]}},"/hockey/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"HockeyBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Hockey.Bookmakers"]}},"/hockey/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| 3-Way Moneyline| The possible outcomes for the three-way moneyline market are `Home`, `Draw` or `Away`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Goals | This is considered a complex market. It is split into multiple possible variants such as *\"Total Goals 8\"*, *\"Total Goals 8.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Both Teams to Score | The market defines whether both teams will score or not. Outcomes can be either `Yes` or `No`. |\n| 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. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-hda.png)","operationId":"HockeyOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":19,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"1Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Hockey.Odds"]}},"/hockey/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"HockeyLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":214385,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Hockey.Last Five Games"]}},"/hockey/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/hockey/h2h.png)","operationId":"HockeyHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":214385,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":223746,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HockeyMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Hockey.Head 2 Head"]}},"/hockey/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/hockey/standings.png)","operationId":"HockeyStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":130987,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2022,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HockeyStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Hockey.Standings"]}},"/rugby/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAll","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Europe","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Rugby.Countries"]}},"/rugby/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Rugby.Countries"]}},"/rugby/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `try-clip` | A single try. |\n| `tries-compilation` | Compilation of tries. |\n| `full-match-replay` | Complete match replay, unedited. |\n| `press-conference` | Official press conferences and media availability. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/rugby/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/rugby-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"EU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Europe","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Six Nations U20","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48440,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-03-08","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":36224450,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":384585,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":385436,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Italy U20","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Scotland U20","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Rugby.Highlights"]}},"/rugby/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Rugby.Highlights"]}},"/rugby/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Rugby.Highlights"]}},"/rugby/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2024,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Six Nations U20","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"EU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Europe","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Rugby.Leagues"]}},"/rugby/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Rugby.Leagues"]}},"/rugby/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause to let the players recover, resolve temporary issues, attend to injuries and so on. |\n| Half time | Half time pause between first and second half. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after extra time | Match has been concluded in extra time. |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Rugby matches example](https://highlightly.net/assets/img/documentation/rugby/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Six Nations U20","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48440,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-03-08","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":384585,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":385436,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Italy U20","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Scotland U20","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"EU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Europe","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Rugby.Matches"]}},"/rugby/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue`, match weather `forecast`, who the game's `referee` is and `lineups`.\n\nEvery player on the team, whether in the starting lineup or on the bench, is assigned a specific position type:\n\n| Position | Description |\n|--------------- |--------------------------------------------------|\n| Forward | Competes for possession in scrums and rucks. |\n| Back | Handles attacking and passing play. |\n| Full Back | Defends deep and returns kicks. |\n| Prop | Front-row player in the scrum. |\n| Unknown (null) | Position not specified or unclear. |\n \n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Rugby.Matches"]}},"/rugby/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Italy U20","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Rugby.Teams"]}},"/rugby/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyTeamStatsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Rugby.Teams"]}},"/rugby/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}}},"summary":"Get team by team id","tags":["Rugby.Teams"]}},"/rugby/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"RugbyBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Marathonbet","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Rugby.Bookmakers"]}},"/rugby/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"RugbyBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Rugby.Bookmakers"]}},"/rugby/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 65.5\"*, *\"Over/Under 63.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -26.5/+26.5\"*, *\"Asian Handicap -27.5/+27.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"RugbyOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":1,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Fezbet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Rugby.Odds"]}},"/rugby/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"RugbyLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":384585,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Rugby.Last Five Games"]}},"/rugby/head-2-head":{"get":{"description":"Retrieve a list of head 2 head games played for given team ids.","operationId":"RugbyHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":385436,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":384585,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head data for a specific set of teams.","tags":["Rugby.Head 2 Head"]}},"/rugby/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/rugby/standings.png)","operationId":"RugbyStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":69715,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2022,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RugbyStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Rugby.Standings"]}},"/handball/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAll","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Germany","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Handball.Countries"]}},"/handball/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Handball.Countries"]}},"/handball/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `full-match-replay` | Complete match replay, unedited. |\n| `live-coverage` | Raw live streams (warm-ups, watch-alongs), as opposed to edited recaps. |\n| `top-plays-compilation` | Best-of compilations (top plays, saves, rallies). |\n| `press-conference` | Official press conferences and media availability. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/handball/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/handball-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"1. Bundesliga Women","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":36526,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-12-27","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":127621850,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":302038,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":332674,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Bensheim-Auerbach W","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Solingen W","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Handball.Highlights"]}},"/handball/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Handball.Highlights"]}},"/handball/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Handball.Highlights"]}},"/handball/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"1. Bundesliga Women","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Handball.Leagues"]}},"/handball/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Handball.Leagues"]}},"/handball/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Half time | Half time pause between first and second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and extra time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after extra time | Match has been concluded in extra time. |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Handball matches example](https://highlightly.net/assets/img/documentation/handball/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Handball Bundesliga Frauen","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":36526,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-12-27","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":302038,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":332674,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Bensheim-Auerbach Women","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Solingen Women","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"DE","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Germany","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Handball.Matches"]}},"/handball/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Handball.Matches"]}},"/handball/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Solingen W","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Handball.Teams"]}},"/handball/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStats","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Handball.Teams"]}},"/handball/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Handball.Teams"]}},"/handball/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"HandballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Handball.Bookmakers"]}},"/handball/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"HandballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Handball.Bookmakers"]}},"/handball/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 62.5\"*, *\"Over/Under 57.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -0.5/+0.5\"*, *\"Asian Handicap -4.5/+4.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-hda.png)","operationId":"HandballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":3,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"22Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Handball.Odds"]}},"/handball/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"HandballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":302038,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Handball.Last Five Games"]}},"/handball/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/handball/h2h.png)","operationId":"HandballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":881569,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":892632,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HandballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Handball.Head 2 Head"]}},"/handball/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/handball/standings.png)","operationId":"HandballStandingsController_getOdds","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":171835,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandballStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Handball.Standings"]}},"/volleyball/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAll","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Italy","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Volleyball.Countries"]}},"/volleyball/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Volleyball.Countries"]}},"/volleyball/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `top-plays-compilation` | Best-of compilations (top plays, saves, rallies). |\n| `full-match-replay` | Complete match replay, unedited. |\n| `live-coverage` | Raw live streams (warm-ups, watch-alongs), as opposed to edited recaps. |\n| `press-conference` | Official press conferences and media availability. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/volleyball/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/volleyball-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"IT","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Italy","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"SuperLega","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":83331,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-12-30","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":126347903,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":630524,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":631375,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Trentino","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Cisterna","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Volleyball.Highlights"]}},"/volleyball/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Volleyball.Highlights"]}},"/volleyball/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Volleyball.Highlights"]}},"/volleyball/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"SuperLega","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"IT","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Italy","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Volleyball.Leagues"]}},"/volleyball/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Volleyball.Leagues"]}},"/volleyball/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First set | Match is considered in play and is in the first set. |\n| Second set | Match is considered in play and is in the second set. |\n| Third set | Match is considered in play and is in the third set. |\n| Fourth set | Match is considered in play and is in the fourth set. |\n| Fifth set | Match is considered in play and is in the fifth set. |\n| Finished | Match has been concluded. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| 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. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Volleyball matches example](https://highlightly.net/assets/img/documentation/volleyball/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"SuperLega","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":83331,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2023-12-30","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":630524,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":631375,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Trentino Volley","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Cisterna","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"IT","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Italy","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Volleyball.Matches"]}},"/volleyball/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Volleyball.Matches"]}},"/volleyball/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Trentino","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Volleyball.Teams"]}},"/volleyball/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Volleyball.Teams"]}},"/volleyball/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Volleyball.Teams"]}},"/volleyball/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"VolleyballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Volleyball.Bookmakers"]}},"/volleyball/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"VolleyballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Volleyball.Bookmakers"]}},"/volleyball/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Match Winner | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Sets | This is considered a complex market. It is split into multiple possible variants such as *\"Total Sets 3.5\"*, *\"Total Sets 4.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Total Points | This is considered a complex market. It is split into multiple possible variants such as *\"Total Points 172.5\"*, *\"Total Points 174.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Correct Score | This is considered a complex market. It is split into multiple possible variants such as *\"Correct Score 3 : 0\"*, *\"Correct Score 3 : 1\"* and so on. There is only a single possible outcome of the variant. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"VolleyballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":2,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"22Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Volleyball.Odds"]}},"/volleyball/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"VolleyballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":630524,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Volleyball.Last Five Games"]}},"/volleyball/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/volleyball/h2h.png)","operationId":"VolleyballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":630524,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":631375,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Volleyball.Head 2 Head"]}},"/volleyball/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/volleyball/standings.png)","operationId":"VolleyballStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":150560,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2020,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolleyballStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Volleyball.Standings"]}},"/cricket/countries":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of countries that are supported by the API.\n\nBy utilising the `name` query parameter you can check whether a specific country exists or simply retrieve the associated data.\n\nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.\n\nBelow is an example of supported countries and their associated logos:\n![Countries example](https://highlightly.net/assets/img/documentation/countries.png)","operationId":"CountriesController_getAllCountries","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Cricket.Countries"]}},"/cricket/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getCountryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketCountryQueryParamDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Cricket.Countries"]}},"/cricket/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `innings-highlights` | Highlights of a single innings. |\n| `full-match-replay` | Complete match replay, unedited. |\n| `live-coverage` | Raw live streams (warm-ups, watch-alongs), as opposed to edited recaps. |\n| `batting-highlight` | Centuries, fifties and batting performances. |\n| `bowling-highlight` | Wickets, spells and bowling performances. |\n| `six-boundary` | Sixes and boundary compilations. |\n| `catch-fielding` | Catches, run-outs and fielding plays. |\n| `toss` | The coin toss. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/cricket/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/cricket-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48513362,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-01-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":48514657,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":17838627,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":17838662,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Melbourne Renegades","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"MR","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Cricket.Highlights"]}},"/cricket/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Cricket.Highlights"]}},"/cricket/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Cricket.Highlights"]}},"/cricket/leagues":{"get":{"description":"\n> Refresh interval: Multiple times a day\n \nRetrieve a list of leagues.\n\nBy 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. \n\nThere 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.\n\nThe league information and their associated seasons can be used to request data from other endpoints such as `standings`.\n","operationId":"LeaguesController_getLeagues","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Cricket.Leagues"]}},"/cricket/leagues/{id}":{"get":{"description":"Retrieve league information by specifying the league id path parameter.\n\n> Note: Used to check whether a league still exists or had its information updated.","operationId":"LeaguesController_getLeagueById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Cricket.Leagues"]}},"/cricket/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Finished | Match has been concluded. |\n| Unknown | The status of the match is not known. |\n| No live coverage | There is no live coverage for the match. |\n| In play | The match is currently in progress. |\n| Stumps | The end of a day's play in a multi-day match (e.g. Test match). |\n| Lunch | The break taken during lunch time in a match. |\n| Innings break | The interval between the end of one innings and the start of the next. |\n| Drinks | A short break for players to have drinks. |\n| Timeout | A strategic break taken during the match. |\n| Tea | The break taken during tea time in a match, typically in Test matches. |\n| Scheduled | The match is planned and scheduled to be played. |\n| Match delayed | The match start or continuation is delayed, often due to weather or other interruptions. |\n| Cancelled | The match has been cancelled and will not be played. |\n| 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. |\n| Abandoned | \tThe match has started but is stopped and will not continue, typically due to weather or other uncontrollable circumstances. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Cricket matches example](https://highlightly.net/assets/img/documentation/cricket/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48513362,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-01-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":17838627,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":17838662,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Melbourne Renegades","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"MR","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Cricket.Matches"]}},"/cricket/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will include additional details such as venue information, weather forecast, predictions, statistics, squad data, and top player performances (best batsmen, best bowlers, and in play data).\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Cricket.Matches"]}},"/cricket/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either the `name` or `abbreviation` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere 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.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Cricket.Teams"]}},"/cricket/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Cricket.Teams"]}},"/cricket/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"CricketBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"22Bet","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Cricket.Bookmakers"]}},"/cricket/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"CricketBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Cricket.Bookmakers"]}},"/cricket/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home` or `Away`. |\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 376.5 \"*, *\"Over/Under 378.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"CricketOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":3,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"22Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Cricket.Odds"]}},"/cricket/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"CricketLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":17838662,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Cricket.Last Five Games"]}},"/cricket/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/cricket/h2h.png)","operationId":"CricketHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":17838627,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":17838662,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Cricket.Head 2 Head"]}},"/cricket/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/cricket/standings.png)","operationId":"CricketStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":50036737,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Cricket.Standings"]}},"/cricket/players":{"get":{"description":"> Refresh interval: Once a day\n\n> This endpoint returns only general player information. For detailed career statistics use the dedicated player detail endpoints.\n\nRetrieve a list of cricket players based on the requested query parameters.\n\nReturned results are paginated. The `limit` parameter specifies the maximum number of players returned in a single response. If the total number of matching players exceeds the specified `limit`, additional results can be retrieved by increasing the `offset` parameter.\n\nEach player record contains basic profile information, including:\n\n| Field | Description |\n| ------- | ----------- |\n| ID | Unique identifier of the player. |\n| Long name | Full name of the player. |\n| Gender | Gender of the player. |\n| Date of birth | Player's date of birth represented as a Unix timestamp in milliseconds. |\n| Batting styles | Short-form batting style codes associated with the player (e.g. `rhb`, `lhb`). |\n| Bowling styles | Short-form bowling style codes associated with the player. |\n| Long batting styles | Human-readable descriptions of the player's batting styles. |\n| Long bowling styles | Human-readable descriptions of the player's bowling styles. |\n| Teams | List of teams the player has been associated with. Each team entry includes: `id`, `abbreviation`, `logo`, and `isCurrent` flag indicating whether the player is currently part of the team. |\n\nThe `teams` field structure:\n\n- **id**: Unique identifier of the team \n- **abbreviation**: Short code/name of the team (e.g. SL, RCB, MI) \n- **logo**: URL to the team's logo image (can be null) \n- **isCurrent**: Boolean indicating whether the player currently represents the team \n\nThis endpoint is useful for player discovery, search functionality, and obtaining basic player profile information before requesting more detailed player-specific data.","operationId":"CricketPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Virat Kohli","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"teamId","in":"query","schema":{"example":422,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePlayerInfoResponseMD"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["Cricket.Players"]}},"/cricket/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description |\n| -------- | ----------- |\n| Profile | Provides a structured summary of a cricket player's personal and professional profile. It includes key details such as full name, date of birth, batting style (e.g. right-hand bat), and bowling style (e.g. right-arm medium). The data offers a high-level overview of the player's identity and playing characteristics, useful for profile display, comparison, or scouting purposes. |\n| Summary | Contains a comprehensive year-by-year statistical breakdown of a cricket player's career across all international formats (Tests, ODIs, T20Is). For each format and season, the summary is divided into batting, bowling, and fielding sections. Batting statistics include matches, innings, runs, fours, sixes, fifties, hundreds, balls faced, ducks, not outs, high score, batting average, and strike rate. Bowling statistics include matches, innings, overs, runs conceded, maidens, wickets, four- and five-wicket hauls, bowling average, economy rate, and bowling strike rate. Fielding statistics include matches, innings, dismissals, catches, stumpings, catches as wicketkeeper, catches as fielder, max dismissals in an innings, and dismissals per innings. This data enables detailed performance analysis across formats and seasons, supporting trend identification, form evaluation, and historical comparisons throughout the player's career. |\n","operationId":"CricketPlayersController_getPlayerStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DetailedPlayerInfoResponseMD"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["Cricket.Players"]}},"/baseball/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `home-run` | Home run. |\n| `grand-slam` | Grand slam. |\n| `walk-off` | Walk-off game-winner. |\n| `hit-rbi` | Hits and RBI plays. |\n| `pitching-highlight` | Strikeouts, gems and other pitching performances. |\n| `defensive-highlight` | Diving catches, double plays, robbed home runs. |\n| `stolen-base` | Stolen bases and baserunning plays. |\n| `save-closer` | Closer shutting the game down. |\n| `error-miscue` | Errors, misplays and miscues. |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `spring-training` | Spring-training content. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/baseball/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/mlb-college-baseball-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NCAA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2022-06-10","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2022,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":343056,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":10291525,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":10291566,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Pirates","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Longhorns","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"ECU","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"TEX","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"East Carolina","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Texas","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Baseball.Highlights"]}},"/baseball/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Baseball.Highlights"]}},"/baseball/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Baseball.Highlights"]}},"/baseball/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Finished | Match has been concluded. |\n| 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. |\n| Scheduled | Match has not been started yet. |\n| Canceled | Game will not be played. |\n| 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. |\n| In Progress | Game is currently in progress. |\n| Half Time | Half time pause between first and second half. |\n| 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. |\n| Unknown | Unknown match coverage or state. |\n| Rain Delay | Match has been delayed due to bad weather conditions. Will either be resumed or suspended. |\n| Period End | Break time between periods. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Baseball matches example](https://highlightly.net/assets/img/documentation/baseball/matches.png)","operationId":"BaseballMatchController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"MLB","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-08-31","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":10291199,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":10291203,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Rangers","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Athletics","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"TEX","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"OAK","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Texas Rangers","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Oakland Athletics","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Baseball.Matches"]}},"/baseball/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue`, weather `forecast`, match `stats`, who the game's `referees` are, each team's `rosters`, and `plays`.\n\n> Note: Used to retrieve additional match information.\n","operationId":"BaseballMatchController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Baseball.Matches"]}},"/baseball/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n","operationId":"TeamController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"MLB","type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Rangers","type":"string"}},{"required":false,"name":"displayName","in":"query","schema":{"example":"Texas Rangers","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"TEX","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Baseball.Teams"]}},"/baseball/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamController_getTeamStats","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["Baseball.Teams"]}},"/baseball/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Baseball.Teams"]}},"/baseball/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n \n Retrieve standings data for a specific league, conference or division.\n \n There are numerous ways on how to fetch the data. You can utilise either `abbreviation` or `leagueName`:\n\n | League Name | Abbreviation |\n | ----------- | ----------- |\n | American League (MLB)\t| AL |\n | National League (MLB)\t| NL |\n | NCAA Division I (CBASE)\t| NCAA |\n\nAdditionally you can specify the `year` parameter to narrow down the the standings for that season.\n\nThere are two other important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned standings will be. If the number of actual standings is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nBelow is an example on how you could render league associated standings\n \n![Standings example](https://highlightly.net/assets/img/documentation/nhl/standings.png)","operationId":"BaseballStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueType","in":"query","schema":{"example":"MLB","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":10,"default":10,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"National League (MLB)","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"NL","type":"string"}},{"required":false,"name":"year","in":"query","schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballStandingsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Baseball.Standings"]}},"/baseball/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 7.5\"*, *\"Over/Under 9.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -0.5/+0.5\"*, *\"Asian Handicap -1.5/+1.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"BaseballOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"MLB","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":7122,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Stake.com","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Baseball.Odds"]}},"/baseball/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"BaseballBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Megapari Sport","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Baseball.Bookmakers"]}},"/baseball/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"BaseballBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Baseball.Bookmakers"]}},"/baseball/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g-baseball.png)","operationId":"BaseballLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":10291525,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Baseball.Last Five Games"]}},"/baseball/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/baseball/h2h.png)","operationId":"BaseballHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":10291175,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":10291176,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Baseball.Head 2 Head"]}},"/baseball/lineups/{matchId}":{"get":{"description":"> Lineups should be queried up to a few hours before the game starts.\n\nRetrieve home and away team lineups for a specific match.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n![Nba lineups example](https://highlightly.net/assets/img/documentation/baseball/lineups.png)\n","operationId":"BaseballLineupsController_getLineups","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballLineupsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get linups by match id","tags":["Baseball.Lineups"]}},"/baseball/box-scores/{id}":{"get":{"description":"> Refresh interval: Every minute\n\nRetrieve detailed per-player **MLB box score statistics** by specifying the match `id` path parameter.\n\nThe response is an array with two elements: \n`[homeTeam, awayTeam]`\n\nEach team object contains general team information and a list of player box scores, including both **batting** and **pitching** statistics.\n\n---\n\n## Team Structure\n\nEach team (home or away) has the following shape:\n\n| Field | Description |\n|-----------|-------------|\n| id | Unique identifier for the team. |\n| name | Team name. |\n| logo | Team logo identifier or URL, if available. |\n| boxScores | List of per-player box score records for the team. |\n\n---\n\n## Player Box Score\n\nEach item in `boxScores` represents a single player’s performance in the match.\n\n### Player Metadata\n\n| Field | Description |\n|------|-------------|\n| id | Unique identifier for the player. |\n| name | Player’s display name. |\n\n---\n\n## Player Statistics\n\nPlayer performance data is provided as a list of statistic records. \nEach record includes a statistic name, its category, and the recorded value.\n\n| Field | Description |\n|------|-------------|\n| name | Name of the statistic (e.g. `Total At-Bats`, `Innings Pitched`). |\n| group | Statistic category (`Batting` or `Pitching`). |\n| value | Numeric value of the statistic. |\n\n---\n\n## Batting Statistics Explained\n\n- **Total At-Bats (AB)** \n Number of official at-bats for the player.\n\n- **Total Runs Scored (R)** \n Number of times the player scored a run.\n\n- **Total Hits (H)** \n Total number of hits recorded by the player.\n\n- **Total Runs Batted In (RBI)** \n Number of runs driven in by the player’s offensive actions.\n\n- **Total Home Runs (HR)** \n Number of home runs hit.\n\n- **Total Walks (BB)** \n Number of bases on balls earned.\n\n- **Total Strikeouts (SO)** \n Number of times the player struck out while batting.\n\n- **Total Pitches Thrown (Batting)** \n Total pitches seen by the player while at bat.\n\n- **Batting Average (AVG)** \n Hits divided by at-bats.\n\n- **On-Base Percentage (OBP)** \n Frequency at which the player reaches base safely.\n\n- **Slugging Percentage (SLG)** \n Measure of batting power based on total bases per at-bat.\n\n---\n\n## Pitching Statistics Explained\n\n- **Innings Pitched (IP)** \n Total number of innings pitched.\n\n- **Hits Allowed (H)** \n Number of hits allowed by the pitcher.\n\n- **Runs Allowed (R)** \n Total runs given up.\n\n- **Total Earned Runs (ER)** \n Runs that scored without defensive errors.\n\n- **Total Walks Allowed (BB)** \n Number of batters walked.\n\n- **Total Strikeouts (SO)** \n Number of batters struck out.\n\n- **Home Runs Allowed (HR)** \n Number of home runs conceded.\n\n- **Earned Run Average (ERA)** \n Average number of earned runs allowed per nine innings.\n\n- **Total Pitches Thrown (Pitching)** \n Total number of pitches thrown by the pitcher.\n\n---\n\n## Notes\n\n- A player may appear with **batting stats**, **pitching stats**, or both.\n- Some players may have zero values if they did not record a statistic in that category.\n- Statistic availability may vary depending on player participation in the match.\n\n","operationId":"BaseballBoxScoresController_getBoxScores","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballPlayerBoxScoreMatchStatsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Retrieve player box score for specified match id","tags":["Baseball.Match Box Score"]}},"/baseball/players":{"get":{"description":"> Refresh interval: 15 minutes\n\n> Route returns only general player information. For additional player details check the `players/{playerId}` and `players/{playerId}/statistics` routes. \n\nRetrieve a list of players based on the requested query parameters. \n\nReturned 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.","operationId":"BaseballPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Reese Albert","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseballPlayerPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["Baseball.Players"]}},"/baseball/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description |\n| ------------ | ----------- |\n| Profile | Provides a structured summary of a player's personal and professional profile. It includes key details such as current team affiliation, physical attributes (height, weight), 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. |\n","operationId":"BaseballPlayersController_getPlayerSummaryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedPlayerSummaryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["Baseball.Players"]}},"/baseball/players/{id}/statistics":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player statistics by specifying the player `id` path parameter.\n\nDetailed player statistics are aggregated on a `perSeason` level. Each season has the following available coverage:\n\n| Type | Description |\n|--------------------|-----------------------------------------------------------------------------|\n| Entire | Combines both regular season and post-season statistics. Pre-season data is not included. |\n| Season | Includes only regular season statistics. |\n\nRecorded stats are dependant on the player position. In total, the following stats are available:\n\n| Type | Description |\n|------|--------------|\n| Pitching | Statistics that measure a pitcher's performance in preventing runs and controlling opposing hitters (innings pitched, strikeouts, walks, earned runs). |\n| Batting | Statistics that measure a player's offensive performance at the plate, including hitting ability, power and on-base success (hits, batting average, home runs, RBIs). |\n\nNote: As mentioned earlier, statistics are associated with specific player positions. This means the results you receive will vary depending on the player's position.\n\n![Baseball Player stats example](https://highlightly.net/assets/img/documentation/baseball/player-stats.png)","operationId":"BaseballPlayersController_getPlayerStatisticsById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedPlayerStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player statistics by player id","tags":["Baseball.Players"]}},"/baseball/statistics/{id}":{"get":{"description":"> Refresh interval: Every minute\n\nRetrieve aggregated **MLB team statistics** for a single match by specifying the match `id` path parameter.\n\nThe response is an array with two elements: \n`[teamA, teamB]`\n\nEach element represents a team and contains general team information along with aggregated statistics across **batting**, **pitching**, and **fielding**.\n\n---\n\n## Team Structure\n\nEach team object has the following shape:\n\n| Field | Description |\n|------|-------------|\n| id | Unique identifier for the team. |\n| name | Team name. |\n| logo | Team logo identifier or URL, if available. |\n| statistics | List of aggregated statistical records for the team. |\n\n---\n\n## Team Statistics\n\nEach item in `statistics` represents a single aggregated metric recorded during the match.\n\n### Statistic Record\n\n| Field | Description |\n|------|-------------|\n| name | Name of the statistic (e.g. `Total Hits`, `Earned Run Average`). |\n| group | Statistic category (`Batting`, `Pitching`, or `Fielding`). |\n| value | Numeric value of the statistic. |\n\n---\n\n## Batting Statistics\n\nBatting statistics summarize the team’s offensive performance.\n\n- **Total At Bats** \n Number of official team at-bats.\n\n- **Total Hits** \n Total number of hits recorded by the team.\n\n- **Total Runs** \n Total runs scored by the team.\n\n- **Total RBIs** \n Total runs driven in by the team’s offensive actions.\n\n- **Total Home Runs** \n Total home runs hit by the team.\n\n- **Total Walks** \n Total bases on balls earned.\n\n- **Total Strikeouts** \n Total strikeouts by batters.\n\n- **Batting Average (AVG)** \n Team hits divided by total at-bats.\n\n- **On-Base Percentage (OBP)** \n Frequency at which the team reaches base safely.\n\n- **Slugging Percentage (SLG)** \n Measure of team batting power based on total bases per at-bat.\n\n- **On-Base Plus Slugging (OPS)** \n Combined on-base and slugging percentage.\n\n---\n\n## Pitching Statistics\n\nPitching statistics summarize the team’s performance while pitching.\n\n- **Innings Pitched (IP)** \n Total innings pitched by the team.\n\n- **Hits Allowed (H)** \n Number of hits allowed by team pitchers.\n\n- **Runs Allowed (R)** \n Total runs conceded.\n\n- **Total Earned Runs (ER)** \n Runs that scored without defensive errors.\n\n- **Total Walks Allowed (BB)** \n Number of batters walked.\n\n- **Total Strikeouts (SO)** \n Number of batters struck out.\n\n- **Home Runs Allowed (HR)** \n Total home runs conceded.\n\n- **Earned Run Average (ERA)** \n Average number of earned runs allowed per nine innings.\n\n- **Total Pitches Thrown** \n Total number of pitches thrown by team pitchers.\n\n---\n\n## Fielding Statistics Explained\n\nFielding statistics summarize the team’s defensive performance.\n\n- **Total Putouts** \n Number of recorded outs by fielders.\n\n- **Total Assists** \n Number of assists recorded.\n\n- **Total Errors** \n Number of defensive errors committed.\n\n- **Total Chances** \n Total defensive chances.\n\n- **Fielding Percentage** \n Percentage of successful defensive plays.\n\n---\n\n## Notes\n\n- All statistics are **aggregated at the team level**.\n- Not all statistic categories or metrics are guaranteed to be present for every match.\n- Some values may be `0` depending on match flow and team participation.\n","operationId":"BaseballMatchStatisticsController_getStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMatchStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}}},"summary":"Returns detailed match statistics for given id","tags":["Baseball.Statistics"]}},"/nba/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"NbaBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["NBA, NCAAB.Bookmakers"]}},"/nba/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"NbaBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["NBA, NCAAB.Bookmakers"]}},"/nba/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/nba/h2h.png)","operationId":"Head2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":3,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":23,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["NBA, NCAAB.Head 2 Head"]}},"/nba/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `dunk` | Dunks and alley-oops. |\n| `three-pointer` | Three-point makes. |\n| `and-one` | Basket plus the foul (incl. four-point plays). |\n| `scoring-play` | Other made baskets (layups, jumpers, floaters, free throws). |\n| `block` | Blocked shots. |\n| `steal` | Steals and takeaways. |\n| `assist-play` | Assists and playmaking passes. |\n| `crossover-handles` | Crossovers, ankle-breakers and dribble moves. |\n| `buzzer-beater-game-winner` | Buzzer-beaters and game-winning shots. |\n| `big-performance` | Stat-line performances (career highs, double/triple-doubles). |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `press-conference` | Official press conferences and media availability. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/nba/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/nba-ncaab-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NCAA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-04-07","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":9853,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":11392,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":11190,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Huskies","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Crimson Tide","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"CONN","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"ALA","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"UConn Huskies","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Alabama Crimson Tide","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["NBA, NCAAB.Highlights"]}},"/nba/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["NBA, NCAAB.Highlights"]}},"/nba/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["NBA, NCAAB.Highlights"]}},"/nba/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g-nba.png)","operationId":"LastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":3,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["NBA, NCAAB.Last Five Games"]}},"/nba/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| Finished | Match has been concluded. |\n| Scheduled | Match has not been started yet. |\n| End period | Break time between periods. |\n| Half time | Half time pause between second and third quarter. |\n| In progress | Game is currently in progress. |\n| Unknown | Unknown match coverage or state. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Nba matches example](https://highlightly.net/assets/img/documentation/nba/matches.png)","operationId":"MatchController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NBA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-05-20","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":3,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":41,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Nuggets","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Timberwolves","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"DEN","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"MIN","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Denver Nuggets","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Minnesota Timberwolves","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["NBA, NCAAB.Matches"]}},"/nba/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue`, weather `forecast`, `matchStatistics` for each team, `events` and `predictions`.\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["NBA, NCAAB.Matches"]}},"/nba/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Away` or `Draw`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Totals | This is considered a complex market. It is split into multiple possible variants such as *\"Totals 25\"*, *\"Totals 25.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Spread | This is considered a complex market. It is split into multiple possible variants such as *\"Spread -28.5/+28.5\"*, *\"Spread -21.25/+21.25 \"* and so on. The possible outcome of a variant is either `Home` or `Away`. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"OddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NBA","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":284,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"Pinnacle","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["NBA, NCAAB.Odds"]}},"/nba/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n \n Retrieve standings data for a specific league, conference or division.\n \n There are numerous ways on how to fetch the data. You can utilise either `abbreviation` or `leagueName`:\n\n | League Name | Abbreviation |\n | ----------- | ----------- |\n| Eastern Conference | EAST |\n| Western Conference | WEST |\n| ASUN Conference | A-SUN |\n| America East Conference | AEAST |\n| American Athletic Conference | AAC |\n| Atlantic 10 Conference | ATL10 |\n| Atlantic Coast Conference | ACC |\n| Big 12 Conference | BIG12 |\n| Big East Conference | BIGE |\n| Big Sky Conference | BSKY |\n| Big South Conference | BSOU |\n| Big Ten Conference | BIG10 |\n| Big West Conference | BIGW |\n| Coastal Athletic Association | COL |\n| Conference USA | USA |\n| Horizon League | HOR |\n| Ivy League | IVY |\n| Metro Atlantic Athletic Conference | MAAC |\n| Mid-American Conference | MIDAM |\n| Mid-Eastern Athletic Conference | MEAC |\n| Missouri Valley Conference | MVC |\n| Mountain West Conference | MWEST |\n| Northeast Conference | NEAST |\n| Patriot League | PAT |\n| Division I Independents | IND |\n| Western Conference | WEST |\n| Eastern Conference | EAST |\n| Ohio Valley Conference | OVC |\n| Pac-12 Conference | PAC12 |\n| Southeastern Conference | SEC |\n| Southern Conference | SOUTH |\n| Southland Conference | LAND |\n| Southwestern Athletic Conference | SWAC |\n| Summit League | SUMM |\n| Sun Belt Conference | BELT |\n| West Coast Conference | WCC |\n| Western Athletic Conference | WAC |\n\nAdditionally you can specify the `year` parameter to narrow down the the standings for that season.\n\nThere are two other important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned standings will be. If the number of actual standings is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nBelow is an example on how you could render league associated standings\n \n![Standings example](https://highlightly.net/assets/img/documentation/nba/standings.png)","operationId":"NbaStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueType","in":"query","schema":{"example":"NCAA","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":10,"default":10,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"America East Conference","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"AEAST","type":"string"}},{"required":false,"name":"year","in":"query","schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaPaginatedStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["NBA, NCAAB.Standings"]}},"/nba/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Nuggets","type":"string"}},{"required":false,"name":"displayName","in":"query","schema":{"example":"Denver Nuggets","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"DEN","type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NBA","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["NBA, NCAAB.Teams"]}},"/nba/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["NBA, NCAAB.Teams"]}},"/nba/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["NBA, NCAAB.Teams"]}},"/nba/lineups/{matchId}":{"get":{"description":"> Lineups should be queried up to a few hours before the game starts.\n\nRetrieve home and away team lineups for a specific match.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n![Nba lineups example](https://highlightly.net/assets/img/documentation/nba/lineups.png)\n","operationId":"NbaLineupsController_getLineups","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaLineupsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get linups by match id","tags":["NBA, NCAAB.Lineups"]}},"/nba/players":{"get":{"description":"> Refresh interval: 15 minutes\n\n> Route returns only general player information. For additional player details check the `players/{playerId}` and `players/{playerId}/statistics` routes. \n\nRetrieve a list of players based on the requested query parameters. \n\nReturned 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.","operationId":"NbaPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Dwight Howard","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NbaNcaaPlayerPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["NBA, NCAAB.Players"]}},"/nba/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description | \n| ------------ | ----------- |\n| Profile | Provides a structured summary of a player's personal and professional profile. It includes key details such as current team affiliation, physical attributes (height, weight), 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. |\n","operationId":"NbaPlayersController_getPlayerSummaryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["NBA, NCAAB.Players"]}},"/nba/players/{id}/statistics":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player statistics by specifying the player `id` path parameter.\n\nDetailed player statistics are aggregated on a `perSeason` level. Each season has the following available coverage:\n\n| Type | Description |\n|--------------------|-----------------------------------------------------------------------------|\n| Entire | Combines both regular season and post-season statistics. Pre-season data is not included. |\n| Season | Includes only regular season statistics. |\n\nThe following stats are available:\n\n| Type | Description |\n|------|--------------|\n| General | Overall player metrics including minutes, games, fouls, rebounds, ratios (assist-to-turnover, steal-to-foul, etc.), player rating, and per-game or per-48-minute averages. |\n| Defense | Stats tracking defensive impact such as steals, blocks, defensive rebounds, and their per-game and per-48-minute rates. |\n| Offense | Metrics covering points, assists, field goals, 3-pointers, free throws, turnovers, efficiency ratings, and offensive rebound measures. |\n\n![NBA, NCAA Player stats example](https://highlightly.net/assets/img/documentation/nba/player-stats.png)","operationId":"NbaPlayersController_getPlayerStatisticsById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player statistics by player id","tags":["NBA, NCAAB.Players"]}},"/nba/box-score/{matchId}":{"get":{"description":"> Refresh interval: Every minute\n\nRetrieve detailed per-player **NBA/NCAAB box score statistics** by specifying the `matchId` as the path parameter.\n\nThe response is an array with two elements: \n`[homeTeam, awayTeam]`\n\nEach team object contains general team information and a list of player box scores.\n\n---\n\n## Team Structure\n\nEach team (home or away) has the following shape:\n\n| Field | Description |\n|-----------|-------------|\n| id | Unique identifier for the team. |\n| name | Team name. |\n| logo | URL to the team logo, if available. |\n| boxScores | List of per-player box score records for the team. |\n\n---\n\n## Player Box Score\n\nEach item in `boxScores` represents a single player’s performance in the match.\n\n### Player Metadata\n\n| Field | Description |\n|------|-------------|\n| id | Unique identifier for the player. |\n| name | Player’s display name. |\n| jersey | Player’s jersey number, if available. |\n\n---\n\n## Player Statistics\n\nPlayer performance data is provided as a list of statistic records. \nEach record contains a **name/value** pair.\n\n| Field | Description |\n|------|-------------|\n| name | Name of the statistic (e.g. `Total Points Scored`, `Total Assists`). |\n| value | Value of the statistic. Can be a number, string, or null if not applicable. |\n\n---\n\n## Common Statistics\n\nThe following are example statistics you may encounter. \n\n## NBA Statistics Explained\n\n- **Total Minutes Played** \n The total amount of time a player has been on the court, measured in minutes.\n\n- **Total Points Scored** \n The sum of all points a player has scored, including field goals and free throws.\n\n- **Successful Field Goals (FGM)** \n The number of shots successfully made from the field (2-point and 3-point shots combined).\n\n- **Total Field Goals (FGA)** \n The total number of shots attempted from the field, whether made or missed.\n\n- **Successful 3PT Field Goals (3PM)** \n The number of three-point shots successfully made.\n\n- **Total 3PT Field Goals (3PA)** \n The total number of three-point shots attempted.\n\n- **Successful Free Throws (FTM)** \n The number of free throws successfully made.\n\n- **Total Free Throws (FTA)** \n The total number of free throws attempted.\n\n- **Total Rebounds (REB)** \n The total number of rebounds collected, combining offensive and defensive rebounds.\n\n- **Total Assists (AST)** \n The number of passes that directly led to a teammate scoring a basket.\n\n- **Total Turnovers (TOV)** \n The number of times a player lost possession of the ball to the opposing team.\n\n- **Total Steals (STL)** \n The number of times a player legally took the ball away from an opponent.\n\n- **Total Blocks (BLK)** \n The number of times a player blocked an opponent’s shot attempt.\n\n- **Total Offensive Rebounds (OREB)** \n Rebounds collected by a player on their team’s offensive end after a missed shot.\n\n- **Total Defensive Rebounds (DREB)** \n Rebounds collected by a player on their team’s defensive end after an opponent’s missed shot.\n\n- **Total Fouls (PF)** \n The number of personal fouls committed by a player.\n\n- **Plus Minus (+/-)** \n The point differential (team points scored minus points allowed) while the player is on the court.\n\n","operationId":"NbaBoxScoreController_getBoxScore","parameters":[{"name":"matchId","required":true,"in":"path","description":"Requested match id","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NbaPlayerBoxScoreResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Retrieve box scores for specified match id","tags":["NBA, NCAAB.Match Box Score"]}},"/nhl/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere 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. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"NhlBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Stake.com","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["NHL, NCAAH.Bookmakers"]}},"/nhl/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"NhlBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["NHL, NCAAH.Bookmakers"]}},"/nhl/head-2-head":{"get":{"description":"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. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/nhl/h2h.png)","operationId":"NhlHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":1,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":2,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["NHL, NCAAH.Head 2 Head"]}},"/nhl/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> 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.\n\n 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. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n\nEach 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.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `goal` | A single goal clip. |\n| `power-play-goal` | Power-play goal. |\n| `shorthanded-goal` | Shorthanded goal. |\n| `overtime-shootout-goal` | Overtime or shootout goal. |\n| `hat-trick` | Hat-trick. |\n| `save` | Goaltender saves. |\n| `fight` | Fights and scraps. |\n| `hit-check` | Big hits and body checks. |\n| `assist-play` | Assists and playmaking passes. |\n| `injury` | A player injured on the play (carted/helped off, exits the game). |\n| `viral-moment` | Celebrations, mascots, milestones, tributes and other spectacle moments. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `press-conference` | Official press conferences and media availability. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/nhl/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere 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. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/nhl-ncaah-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NCAA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-02-10","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":10523,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":494,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":15011,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Engineers","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Big Red","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"RPI","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"COR","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Rensselaer Engineers","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Cornell Big Red","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["NHL, NCAAH.Highlights"]}},"/nhl/highlights/geo-restrictions/{id}":{"get":{"description":"> Refresh interval: Once an hour\n\n> Note: Endpoint is not available in the Basic/Free plan.\n\nGeo 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.\n\nEach highlight has a `state` property which defines how the geo restrictions are applied.\n\n| State | Description |\n| ----------- | ----------- |\n| No restricitons applied | Highlight has no restrictions applied and is available globally. | \n| Allowed countries restriction | Highlight is only available to users whose country code is found in the `allowedCountries` list. |\n| Blocked countries restriction | Highlight is blocked to all users whose country code is found in the `blockedCountries` list. |\n| Unknown restrictions | There is no guaranteed way to define all allowed or blocked countries. |\n\nAs 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. \n","operationId":"HighlightsController_getGeoRestrictions","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["NHL, NCAAH.Highlights"]}},"/nhl/highlights/{id}":{"get":{"description":"\nRetrieve highlight information by specifying the highlight id path parameter.\n\n> Note: Used to check whether a highlight still exists or had its information updated.\n","operationId":"HighlightsController_getHighlightById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["NHL, NCAAH.Highlights"]}},"/nhl/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve 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.\n\nSpecify `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:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g-nhl.png)","operationId":"NhlLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":1,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["NHL, NCAAH.Last Five Games"]}},"/nhl/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere 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. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| 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. |\n| 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. |\n| Cancelled | Game will not be played. |\n| 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. |\n| Finished | Match has been concluded. |\n| Scheduled | Match has not been started yet. |\n| End period | Break time between periods. |\n| Half time | Half time pause between second and third quarter. |\n| In progress | Game is currently in progress. |\n| Unknown | Unknown match coverage or state. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![NHL matches example](https://highlightly.net/assets/img/documentation/nhl/matches.png)","operationId":"MatchController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NCAA","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-02-10","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2024,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":494,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":15011,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Engineers","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Big Red","type":"string"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"RPI","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"COR","type":"string"}},{"required":false,"name":"homeTeamDisplayName","in":"query","schema":{"example":"Rensselaer Engineers","type":"string"}},{"required":false,"name":"awayTeamDisplayName","in":"query","schema":{"example":"Cornell Big Red","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["NHL, NCAAH.Matches"]}},"/nhl/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue`, weather `forecast`, `overallStatistics` for each team, who the game's `referees` are and `events`.\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["NHL, NCAAH.Matches"]}},"/nhl/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve 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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe 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.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| 3-Way Moneyline| The possible outcomes for the three-way moneyline market are `Home`, `Draw` or `Away`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Goals | This is considered a complex market. It is split into multiple possible variants such as *\"Total Goals 8\"*, *\"Total Goals 8.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Both Teams to Score | The market defines whether both teams will score or not. Outcomes can be either `Yes` or `No`. |\n| 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. |\n\nThere 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.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-hda.png)","operationId":"NhlOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"NHL","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":1,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"22Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["NHL, NCAAH.Odds"]}},"/nhl/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n \n Retrieve standings data for a specific league, conference or division.\n \n There are numerous ways on how to fetch the data. You can utilise either `abbreviation` or `leagueName`:\n\n | League Name | Abbreviation |\n | ----------- | ----------- |\n | Metro Atlantic Athletic Conference | MAAC | \n | Western Conference | WEST |\n | College Hockey America | CHA |\n | Eastern Conference | EAST |\n | East Coast Athletic Conference | ECAC |\n | Independent | IND |\n | Northeast 10 Conference |\tNE10 |\n | Western Collegiate Hockey Association |\tWCHA |\n | Central Collegiate Hockey Association |\tCCHA |\n | Hockey East |\tHE | \n\nAdditionally you can specify the `year` parameter to narrow down the the standings for that season.\n\nThere are two other important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned standings will be. If the number of actual standings is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nBelow is an example on how you could render league associated standings\n \n![Standings example](https://highlightly.net/assets/img/documentation/nhl/standings.png)","operationId":"NhlStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueType","in":"query","schema":{"example":"NHL","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":10,"default":10,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Western Conference","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"WEST","type":"string"}},{"required":false,"name":"year","in":"query","schema":{"example":2025,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["NHL, NCAAH.Standings"]}},"/nhl/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Big Red","type":"string"}},{"required":false,"name":"displayName","in":"query","schema":{"example":"Cornell Big Red","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"COR","type":"string"}},{"required":false,"name":"league","in":"query","schema":{"example":"NCAA","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["NHL, NCAAH.Teams"]}},"/nhl/teams/statistics/{id}":{"get":{"description":"\n> Refresh interval: Immediately once a match is finished.\n \nRetrieve 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.\n","operationId":"TeamsController_getTeamStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","name":"fromDate","in":"query","required":true,"schema":{"example":"2023-08-06","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlTeamStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team statistics","tags":["NHL, NCAAH.Teams"]}},"/nhl/teams/{id}":{"get":{"description":"Retrieve team information by specifying the team id path parameter.\n\n> Note: Used to check whether a team still exists or had its information updated.","operationId":"TeamsController_getTeamById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["NHL, NCAAH.Teams"]}},"/nhl/lineups/{matchId}":{"get":{"description":"> Lineups should be queried up to a few hours before the game starts.\n\nRetrieve home and away team lineups for a specific match.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n![Nba lineups example](https://highlightly.net/assets/img/documentation/nhl/lineups.png)\n","operationId":"NhlLineupsController_getLineups","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"matchId","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlLineupsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get linups by match id","tags":["NHL, NCAAH.Lineups"]}},"/nhl/players":{"get":{"description":"> Refresh interval: 15 minutes\n\n> Route returns only general player information. For additional player details check the `players/{playerId}` and `players/{playerId}/statistics` routes. \n\nRetrieve a list of players based on the requested query parameters. \n\nReturned 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.","operationId":"NhlPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Colin White","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NhlNcaaPlayerPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["NHL, NCAAH.Players"]}},"/nhl/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type | Description | \n| ------------ | ----------- |\n| Profile | Provides a structured summary of a player's personal and professional profile. It includes key details such as current team affiliation, physical attributes (height, weight), 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. |\n","operationId":"NhlPlayersController_getPlayerSummaryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["NHL, NCAAH.Players"]}},"/nhl/players/{id}/statistics":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player statistics by specifying the player `id` path parameter.\n\nDetailed player statistics are aggregated on a `perSeason` level. Each season has the following available coverage:\n\n| Type | Description |\n|--------------------|-----------------------------------------------------------------------------|\n| Entire | Combines both regular season and post-season statistics. Pre-season data is not included. |\n| Season | Includes only regular season statistics. |\n\nThe following stats are available:\n\n| Type | Description |\n|------|--------------|\n| General | Overall player metrics including minutes, games, fouls, shootouts, penalties and so on. |\n| Defense | Stats tracking defensive impact such as saves, hits, etc. |\n| Offense | Metrics covering goals, shots, shootouts, assists, faceoffs, etc. |\n| Penalties | A variety of penalty related metrics such as why the penalties occured and how many times a player scored or missed and so on. | \n\n![NHL, NCAA Player stats example](https://highlightly.net/assets/img/documentation/nhl/player-stats.png)","operationId":"NhlPlayersController_getPlayerStatisticsById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"sport-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerStatisticsResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player statistics by player id","tags":["NHL, NCAAH.Players"]}}},"info":{"title":"All Sports API Documentation","description":"The Highlightly All Sports API provides unified access to 9 sports in a single subscription — football (950+ leagues), NBA, NFL, NHL, MLB, cricket (900+ leagues), basketball (340+ leagues), hockey (170+ leagues), rugby, volleyball, handball. Live scores, video highlights, player stats, lineups, standings, momentum indicators, and match events through a single REST API.\n\n## Supported sports\n\n| Sport | Coverage |\n| ----------- | ----------- |\n| Football | 950+ leagues · 170+ countries |\n| Basketball | 340+ leagues worldwide |\n| Hockey | 170+ leagues · 30+ countries |\n| Cricket | 900+ leagues · 80+ countries |\n| Rugby | 100+ competitions |\n| Volleyball | 230+ leagues · 45+ countries |\n| Handball | 180+ leagues · 35+ countries |\n| NBA & NCAAB | NBA + 35+ NCAA Division I conferences |\n| NFL & NCAA | NFL + NCAA FBS |\n| NHL & NCAAH | NHL + 10+ NCAA Division I conferences |\n| MLB & NCAA | MLB + NCAA Division I |\n\n## Contact\n\nFor feature requests, questions, private plans or business inquiries you can contact us at [support@highlightly.net](mailto:support@highlightly.net).\n\nYou can also contact us via [RapidAPI](https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api) by starting a discussion or by sending us a private message.\n\n# Integration\n\nTo start using our API services you will first need to create an account via [Highlightly](https://highlightly.net/login) or [RapidAPI](https://rapidapi.com/auth/sign-up?referral=/highlightly-api-highlightly-api-default/api/sport-highlights-api/pricing/). \nBoth 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. \n\n> Accounts are **not** synced across platforms.\n\n> 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.\n\n## API usage\n\n> Highlightly API base url: `https://sports.highlightly.net`\n\n> RapidAPI API base url: `https://sport-highlights-api.p.rapidapi.com`\n\nEach API request will be considered valid only if the following headers are present:\n\n| Request Header | Value |\n| ----------- | ----------- |\n| `x-rapidapi-key` | *Your Highlightly or RapidAPI API Key* |\n| `x-rapidapi-host` | `sport-highlights-api.p.rapidapi.com` - only needed for usage through RapidAPI |\n\nThese headers are mandatory when requesting API data. They are not needed when requesting other resources such as logos or images.\n\nEach API response will contain additional headers. The following three are considered the most important for developers:\n\n| Response Header | Value |\n| ---------------- | ----------- |\n| `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. |\n| `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. |\n| `content-type` | Value will always be `application/json`. XML format is not supported. |\n\nIn the following sections we will guide you through all endpoints and functionalities the API has to offer.","version":"6.14.3","contact":{}},"tags":[{"name":"Sports API","description":""}],"servers":[{"url":"https://sports.highlightly.net"},{"url":"https://sport-highlights-api.p.rapidapi.com"}],"components":{"schemas":{"FootballCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"FR"},"name":{"type":"string","example":"France"},"logo":{"type":"string","example":"https://example.com/logos/country/FR.png"}},"required":["code","name","logo"]},"BadRequestDto":{"type":"object","properties":{"message":{"type":"string","example":"Descriptive bad request error message."},"statusCode":{"type":"number","example":400}},"required":["message","statusCode"]},"InternalServerErrorDto":{"type":"object","properties":{"message":{"type":"string","example":"Internal server error."},"statusCode":{"type":"number","example":500}},"required":["message","statusCode"]},"FootballSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2022}},"required":["season"]},"FootballLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":104},"logo":{"type":"string","example":"https://example.com/logos/league/104.png"},"name":{"type":"string","example":"UEFA Champions League"},"country":{"$ref":"#/components/schemas/FootballCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/FootballSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"PaginationResponseDto":{"type":"object","properties":{"totalCount":{"type":"number","description":"Available number of items, relevant to the provided query.","example":490},"offset":{"type":"number","example":20},"limit":{"type":"number","example":100}},"required":["totalCount","offset","limit"]},"PlanResponseDto":{"type":"object","properties":{"tier":{"type":"string","description":"Your current API subscription tier.","example":"BASIC"},"message":{"type":"string","description":"Explanation message regarding your current tier.","example":"Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"}},"required":["tier","message"]},"FootballLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":553},"logo":{"type":"string","example":"https://example.com/logos/team/553.png"},"name":{"type":"string","example":"Montpellier"},"type":{"type":"string","enum":["club","national"],"example":"club"}},"required":["id","name"]},"FootballTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballTeamGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a given league/season.","example":34},"wins":{"type":"number","description":"Number of games team has won during a given league/season.","example":20},"loses":{"type":"number","description":"Number of games team has lost during a given league/season.","example":5},"draws":{"type":"number","description":"Number of games team has drawn during a given league/season.","example":5}},"required":["played","wins","loses","draws"]},"FootballTeamGoalStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals team has scored.","example":57},"received":{"type":"number","description":"Number of goals team has received.","example":39}},"required":["scored","received"]},"FootballDetailedTeamStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game statistics associated with given league.","allOf":[{"$ref":"#/components/schemas/FootballTeamGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored and received.","allOf":[{"$ref":"#/components/schemas/FootballTeamGoalStatsResponseDto"}]}},"required":["games","goals"]},"FootballTeamStatisticsResponseDto":{"type":"object","properties":{"leagueId":{"type":"number","description":"Id of league to which team statistics are associated.","example":216087},"season":{"type":"number","description":"Season year to which team statistics are associated.","example":2023},"leagueName":{"type":"string","description":"Name of league to which team statistics are associated.","example":"Major League Soccer"},"total":{"description":"Goal and game statistics for given season/year.","allOf":[{"$ref":"#/components/schemas/FootballDetailedTeamStatsResponseDto"}]},"home":{"description":"Goal and game statistics team has played at home for given season/year.","allOf":[{"$ref":"#/components/schemas/FootballDetailedTeamStatsResponseDto"}]},"away":{"description":"Goal and game statistics team has played away for given season/year.","allOf":[{"$ref":"#/components/schemas/FootballDetailedTeamStatsResponseDto"}]}},"required":["leagueId","season","leagueName","total","home","away"]},"FootballMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":133},"season":{"type":"number","example":2023},"name":{"type":"string","example":"Ligue 1"},"logo":{"type":"string","example":"https://example.com/logos/league/133.png"}},"required":["id","season","name"]},"FootballMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"3 - 1","description":"Home - Away score up to penalties."},"penalties":{"type":"string","example":"6 - 4","description":"Home - Away team score after the penalties phase."}}},"FootballMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["To be announced","Not started","First half","Half time","Second half","Extra time","Break time","Penalties","Suspended","Interrupted","Finished","Finished after penalties","Finished after extra time","Postponed","Cancelled","Abandoned","Awarded","In progress","Unknown"],"example":"Second half","description":"State of the match."},"clock":{"type":"number","example":67,"description":"Current minute of the match."},"score":{"$ref":"#/components/schemas/FootballMatchScoreResponseDto"}},"required":["description","score"]},"FootballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":489389},"round":{"type":"string","example":"Regular Season - 32"},"date":{"type":"string","example":"2023-05-20T15:30:00.000Z"},"country":{"$ref":"#/components/schemas/FootballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/FootballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/FootballTeamResponseDto"},"league":{"$ref":"#/components/schemas/FootballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/FootballMatchStateResponseDto"}},"required":["id","round","date","country","awayTeam","homeTeam","league","state"]},"FootballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballShotsDto":{"type":"object","properties":{"playerName":{"type":"string","example":"Cody Gakpo"},"time":{"type":"string","example":"3'"},"outcome":{"type":"string","example":"Missed"},"goalTarget":{"type":"string","example":"High Right"}},"required":["playerName","time","outcome","goalTarget"]},"FootballTopPlayerStatisticsResponse":{"type":"object","properties":{"name":{"type":"string","example":"Shots On Target"},"value":{"type":"object","example":2}},"required":["name","value"]},"FootballTopPlayersResponse":{"type":"object","properties":{"position":{"type":"string","example":"Midfielder"},"name":{"type":"string","example":"Carlos Augusto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/FootballTopPlayerStatisticsResponse"}}},"required":["position","name","statistics"]},"FootballDetailedTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":553},"logo":{"type":"string","example":"https://example.com/logos/team/553.png"},"name":{"type":"string","example":"Montpellier"},"shots":{"type":"array","items":{"$ref":"#/components/schemas/FootballShotsDto"}},"topPlayers":{"type":"array","items":{"$ref":"#/components/schemas/FootballTopPlayersResponse"}}},"required":["id","name"]},"FootballLiveEventTeamDto":{"type":"object","properties":{"id":{"type":"number","example":13394673},"logo":{"type":"string","example":"https://example.com/logo/preview/66311.13394673"},"name":{"type":"string","example":"Tersana"}},"required":["id","name"]},"FootballLiveEventDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/FootballLiveEventTeamDto"},"time":{"type":"string","example":"45+1"},"type":{"type":"string","enum":["Goal","Own Goal","Penalty","Missed Penalty","Yellow Card","Red Card","Substitution","VAR Goal Confirmed","VAR Goal Cancelled","VAR Penalty","VAR Penalty Cancelled","VAR Goal Cancelled - Offside"],"example":"Goal"},"playerId":{"type":"number","example":63606907},"player":{"type":"string","example":"M. Mamdouh"},"assistingPlayerId":{"type":"number"},"assist":{"type":"string","example":"J. Johanson"},"substituted":{"type":"string"}},"required":["team","time","type"]},"FootballMatchStatisticsResponseItemDto":{"type":"object","properties":{"value":{"type":"number","example":0.62},"displayName":{"type":"string","example":"Shots accuracy"}},"required":["value","displayName"]},"FootballMatchStatisticsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/FootballTeamResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchStatisticsResponseItemDto"}}},"required":["team","statistics"]},"DetailedMatchRefereeResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Brace, Andrew"},"nationality":{"type":"string","example":"Ireland"}}},"DetailedMatchVenueResponseDto":{"type":"object","properties":{"city":{"type":"string","example":"Swansea"},"name":{"type":"string","example":"Liberty Stadium"},"country":{"type":"string","example":"Wales"},"capacity":{"type":"string","example":"20827"}}},"DetailedMatchForecastResponseDto":{"type":"object","properties":{"status":{"type":"string","example":"cloudy"},"temperature":{"type":"string","example":"11.97°C"}}},"PredictionProbabilitiesDto":{"type":"object","properties":{"home":{"type":"string","example":"30.22%"},"draw":{"type":"string","example":"0.00%"},"away":{"type":"string","example":"69.78%"}},"required":["home","away"]},"PredictionDto":{"type":"object","properties":{"type":{"type":"string","example":"prematch"},"modelType":{"type":"string","example":"three-way"},"generatedAt":{"type":"string","example":"2025-03-12T19:00:20.000Z"},"description":{"type":"string","example":"Team A is most likely to win the game against Team B.`"},"probabilities":{"$ref":"#/components/schemas/PredictionProbabilitiesDto"}},"required":["type","modelType","generatedAt","description","probabilities"]},"PredictionResponseDto":{"type":"object","properties":{"prematch":{"type":"array","items":{"$ref":"#/components/schemas/PredictionDto"}},"live":{"type":"array","items":{"$ref":"#/components/schemas/PredictionDto"}}},"required":["prematch","live"]},"NewsDto":{"type":"object","properties":{"url":{"type":"string","example":"https://football-italia.net/watch-milan-reijnders-scores-16th-goal-2024-25/?utm_source=365Scores&utm_medium=link&utm_campaign=Contact%2bus%2bat%2b365scores%2bfor%2bmore%2btraffic"},"image":{"type":"string","example":"https://icdn.football-italia.net/wp-content/uploads/2025/03/netherlands-v-spain-uefa-nations.jpg"},"title":{"type":"string","example":"Celebrating Fernando Torres: A Spanish Football Icon"},"datePublished":{"type":"string","example":"2025-03-20T19:29:02Z"}},"required":["url","image","title","datePublished"]},"FootballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1002433681},"round":{"type":"string","example":"Apertura - 9"},"date":{"type":"string","example":"\"2024-03-31T20:30:00.000Z"},"country":{"$ref":"#/components/schemas/FootballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/FootballDetailedTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/FootballDetailedTeamResponseDto"},"league":{"$ref":"#/components/schemas/FootballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/FootballMatchStateResponseDto"},"events":{"type":"array","items":{"$ref":"#/components/schemas/FootballLiveEventDto"}},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/FootballMatchStatisticsResponseDto"}},"referee":{"$ref":"#/components/schemas/DetailedMatchRefereeResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"},"news":{"type":"array","items":{"$ref":"#/components/schemas/NewsDto"}}},"required":["id","round","date","country","awayTeam","homeTeam","league","state","events","statistics"]},"FootballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"Ligue 1: Lyon vs Reims"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/29g9urg92387"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/213123safas132e"},"match":{"$ref":"#/components/schemas/FootballMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"FootballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RestrictionResponseDto":{"type":"object","properties":{"state":{"type":"string","enum":["No restricitons applied","Allowed countries restriction","Blocked countries restriction","Unknown restrictions"],"example":"Allowed countries restriction","description":"Specifies which restriction rule is applied to the requested highlight. If allowed restriction is applied, read from allowedCountries field. When blocked restriction is applied, countries from blockedCountries field are applied."},"allowedCountries":{"example":["IT"],"description":"ISO 3166 two letter country list of allowed countries when restriction rules is in allowed state.","type":"array","items":{"type":"string"}},"blockedCountries":{"example":[],"description":"ISO 3166 two letter country list of blocked countries. Rule list is valid when restriction rules is in blocked state.","type":"array","items":{"type":"string"}},"embeddable":{"type":"boolean","example":true,"description":"Boolean flag which indicates whether highlight provider allows embedding inside web applications."}},"required":["state","allowedCountries","blockedCountries","embeddable"]},"FootballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"FootballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":6.6},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"FootballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":1},"bookmakerName":{"type":"string","example":"Stake.com"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Full Time Result"},"values":{"type":"array","items":{"$ref":"#/components/schemas/FootballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"FootballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":884822928},"odds":{"type":"array","items":{"$ref":"#/components/schemas/FootballMarketResponseDto"}}},"required":["matchId","odds"]},"FootballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballStandingsStatsDto":{"type":"object","properties":{"wins":{"type":"number","example":11},"draws":{"type":"number","example":4},"games":{"type":"number","example":17},"loses":{"type":"number","example":5},"scoredGoals":{"type":"number","example":28},"receivedGoals":{"type":"number","example":27}},"required":["wins","draws","games","loses","scoredGoals","receivedGoals"]},"FootballStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":56950},"logo":{"type":"string","example":"https://example.com/logos/team/56950.png"},"name":{"type":"string","example":"Aston Villa"}},"required":["id","name"]},"FootballStandingsDto":{"type":"object","properties":{"away":{"$ref":"#/components/schemas/FootballStandingsStatsDto"},"home":{"$ref":"#/components/schemas/FootballStandingsStatsDto"},"team":{"$ref":"#/components/schemas/FootballStandingsTeamDto"},"total":{"$ref":"#/components/schemas/FootballStandingsStatsDto"},"points":{"type":"number","example":63},"position":{"type":"number","example":4}},"required":["team","total","points","position"]},"FootballStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Premier League - Regular Season"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/FootballStandingsDto"}}},"required":["name","standings"]},"FootballStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":33973},"logo":{"type":"string","example":"https://example.com/logos/league/33973.png"},"name":{"type":"string","example":"Premier League"},"season":{"type":"number","example":2023}},"required":["id","name","season"]},"FootballStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/FootballStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/FootballStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"FootballLineupsPlayerDto":{"type":"object","properties":{"id":{"type":"number","example":24948},"name":{"type":"string","example":"Lilian Raolisoa"},"number":{"type":"number","example":27},"position":{"type":"string","enum":["Goalkeeper","Defender","Midfielder","Forward"],"example":"Defender"}},"required":["name","number","position"]},"FootballLineupsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":66311},"logo":{"type":"string","example":"https://example.com/logo/preview/66311.png"},"formation":{"type":"string","example":"4-2-3-1"},"name":{"type":"string","example":"Angers"},"substitutes":{"type":"array","items":{"$ref":"#/components/schemas/FootballLineupsPlayerDto"}},"initialLineup":{"description":"2D grid of players representing their position on the board. The first entry will always be the goal keeper. Other entries will follow the team formation, e.g. formation 4-2-3-1 means that there will be 4 more arrays each containing the associated number of players in the correct order.","example":[[{"name":"Yahia Fofana","number":30,"position":"Goalkeeper"}],[{"name":"Florent Hanin","number":26,"position":"Defender"},{"name":"Jordan Lefort","number":21,"position":"Defender"},{"name":"Cédric Hountondji","number":22,"position":"Defender"},{"name":"Yan Valery","number":2,"position":"Defender"}],[{"name":"Himad Abdelli","number":10,"position":"Midfielder"},{"name":"Zinédine Ould Khaled","number":12,"position":"Midfielder"}],[{"name":"Justin-Noel Kalumba","number":17,"position":"Midfielder"},{"name":"Pierrick Capelle","number":15,"position":"Midfielder"},{"name":"Farid El Melali","number":28,"position":"Midfielder"}],[{"name":"Loïs Diony","number":9,"position":"Forward"}]],"type":"array","items":{"$ref":"#/components/schemas/FootballLineupsPlayerDto"}}},"required":["id","logo","formation","name","substitutes","initialLineup"]},"FootballLineupsResponseDto":{"type":"object","properties":{"homeTeam":{"$ref":"#/components/schemas/FootballLineupsTeamDto"},"awayTeam":{"$ref":"#/components/schemas/FootballLineupsTeamDto"}},"required":["homeTeam","awayTeam"]},"NotFoundDto":{"type":"object","properties":{"message":{"type":"string","example":"Not Found"},"statusCode":{"type":"number","example":404}},"required":["message","statusCode"]},"FootballPlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":33481},"name":{"type":"string","example":"Ivan Perišić"},"fullName":{"type":"string","example":"Ivan Perišić"},"logo":{"type":"string"}},"required":["id","name"]},"FootballPlayerPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FootballPlayerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FootballDetailedPlayerSummaryPositionDto":{"type":"object","properties":{"main":{"type":"string","example":"Right Winger"},"secondary":{"type":"string","example":"Left Midfield, Left Winger"}}},"FootballDetailedPlayerSummaryClubDto":{"type":"object","properties":{"current":{"type":"string","example":"PSV Eindhoven"},"joinedAt":{"type":"string","example":"Sep 18, 2024"},"contractExpiry":{"type":"string","example":"Jun 30, 2027"},"latestContractExtension":{"type":"string","example":"Jun 27, 2025"}}},"FootballDetailedPlayerSummaryProfileDto":{"type":"object","properties":{"fullName":{"type":"string","example":"Ivan Perišić"},"birthDate":{"type":"string","example":"Feb 2, 1989"},"deathDate":{"type":"string"},"birthPlace":{"type":"string","example":"Split"},"citizenship":{"type":"string","example":"Croatia"},"foot":{"type":"string","example":"both"},"height":{"type":"string","example":"1,86 m"},"position":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryPositionDto"},"club":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryClubDto"}},"required":["position","club"]},"FootballDetailedPlayerSummaryRumourDto":{"type":"object","properties":{"club":{"type":"string","example":"FC Barcelona"},"rumourDate":{"type":"string","example":"Jun 11, 2025"},"transferProbability":{"type":"string","example":"84.96%"}},"required":["club","rumourDate","transferProbability"]},"FootballDetailedPlayerSummaryRumoursDto":{"type":"object","properties":{"current":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryRumourDto"}},"historical":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryRumourDto"}}},"required":["current","historical"]},"FootballDetailedPlayerSummaryRelatedNewsDto":{"type":"object","properties":{"url":{"type":"string","example":"https://www.transfermarkt.com/third-youngest-squad-in-the-pl-postecoglou-aiming-for-top-four-with-new-look-spurs-side/view/news/441066"},"date":{"type":"string","example":"Jul 23, 2024"},"title":{"type":"string","example":"Third youngest squad in the PL - Postecoglou aiming for top four with new-look Spurs side"}},"required":["url","date","title"]},"FootballDetailedPlayerSummaryTransfersDto":{"type":"object","properties":{"to":{"type":"string","example":"Bayern Munich"},"fee":{"type":"string","example":"€5.0M"},"from":{"type":"string","example":"Inter"},"type":{"type":"string","enum":["transfer","loan","end of loan","retired"],"example":"loan"},"season":{"type":"string","example":"19/20"},"marketValue":{"type":"string","example":"€30.0M"},"transferDate":{"type":"string","example":"Aug 13, 2019"}},"required":["to","from","type","season","transferDate"]},"FootballDetailedPlayerMarketValuesDto":{"type":"object","properties":{"recordedDate":{"type":"string","example":"Dec 22, 2023"},"club":{"type":"string","example":"FC Barcelona"},"value":{"type":"number","example":60000000},"age":{"type":"number","example":16},"currency":{"type":"string","example":"€"}},"required":["recordedDate","club","value","age","currency"]},"FootballDetailedPlayerInjuriesDto":{"type":"object","properties":{"reason":{"type":"string","example":"Muscle injury"},"season":{"type":"string","example":"2022"},"fromDate":{"type":"string","example":"27.04.2022"},"toDate":{"type":"string","example":"20.05.2022"},"missedGames":{"type":"number","example":3},"absentDurationInDays":{"type":"number","example":24}},"required":["reason","season","fromDate","missedGames"]},"FootballDetailedPlayerSummaryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":33481},"name":{"type":"string","example":"Ivan Perišić"},"fullName":{"type":"string","example":"Ivan Perišić"},"logo":{"type":"string"},"profile":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryProfileDto"},"rumours":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryRumoursDto"},"relatedNews":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryRelatedNewsDto"}},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerSummaryTransfersDto"}},"marketValue":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerMarketValuesDto"}},"injuries":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerInjuriesDto"}}},"required":["id","name","rumours","relatedNews","transfers","marketValue","injuries"]},"FootballDetailedPlayerStatisticsPerCompetitionDto":{"type":"object","properties":{"club":{"type":"string","example":"PSV Eindhoven"},"type":{"type":"string","example":"national league","enum":["national league","national cup","international cup"]},"league":{"type":"string","example":"Eredivisie"},"season":{"type":"string","example":"2025"},"goals":{"type":"number","example":9},"assists":{"type":"number","example":9},"ownGoals":{"type":"number","example":0},"redCards":{"type":"number","example":0},"cleanSheets":{"type":"number","example":0},"gamesPlayed":{"type":"number","example":4},"yellowCards":{"type":"number","example":27},"goalsConceded":{"type":"number","example":0},"minutesPlayed":{"type":"number","example":1804},"substitutedIn":{"type":"number","example":6},"substitutedOut":{"type":"number","example":13},"penaltiesScored":{"type":"number","example":0},"secondYellowCards":{"type":"number","example":0}},"required":["club","type","league","season","goals","assists","ownGoals","redCards","cleanSheets","gamesPlayed","yellowCards","goalsConceded","minutesPlayed","substitutedIn","substitutedOut","penaltiesScored","secondYellowCards"]},"FootballDetailedPlayerStatisticsPerClubDto":{"type":"object","properties":{"club":{"type":"string","example":"Inter Milan"},"goals":{"type":"number","example":55},"assists":{"type":"number","example":50},"ownGoals":{"type":"number","example":2},"redCards":{"type":"number","example":1},"cleanSheets":{"type":"number","example":0},"gamesPlayed":{"type":"number","example":254},"yellowCards":{"type":"number","example":27},"goalsConceded":{"type":"number","example":0},"minutesPlayed":{"type":"number","example":18940},"substitutedIn":{"type":"number","example":44},"substitutedOut":{"type":"number","example":79},"penaltiesScored":{"type":"number","example":4},"secondYellowCards":{"type":"number","example":0}},"required":["club","goals","assists","ownGoals","redCards","cleanSheets","gamesPlayed","yellowCards","goalsConceded","minutesPlayed","substitutedIn","substitutedOut","penaltiesScored","secondYellowCards"]},"FootballDetailedPlayerStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":33481},"name":{"type":"string","example":"Ivan Perišić"},"fullName":{"type":"string","example":"Ivan Perišić"},"logo":{"type":"string"},"perCompetition":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerStatisticsPerCompetitionDto"}},"perClub":{"type":"array","items":{"$ref":"#/components/schemas/FootballDetailedPlayerStatisticsPerClubDto"}}},"required":["id","name","perCompetition","perClub"]},"FootballTeamBoxScoreResponseDto":{"type":"object","properties":{"id":{"type":"number","example":34824},"logo":{"type":"string","example":"https://highlightly.net/soccer/images/teams/34824.png"},"name":{"type":"string","example":"Liverpool"}},"required":["id","logo","name"]},"PlayerBoxScoreStatisticsDto":{"type":"object","properties":{"goalsScored":{"type":"number","example":0},"goalsSaved":{"type":"number","example":0},"goalsConceded":{"type":"number","example":0},"assists":{"type":"number","example":0},"dribblesTotal":{"type":"number","example":3},"dribblesSuccessful":{"type":"number","example":2},"dribblesFailed":{"type":"number","example":1},"dribbleSuccessRate":{"type":"string","example":"66.67 %"},"fouledByOthers":{"type":"number","example":0},"fouledOthers":{"type":"number","example":1},"tacklesTotal":{"type":"number","example":7},"interceptionsTotal":{"type":"number","example":1},"duelsTotal":{"type":"number","example":19},"duelsWon":{"type":"number","example":10},"duelsLost":{"type":"number","example":9},"duelSuccessRate":{"type":"string","example":"52.63 %"},"cardsRed":{"type":"number","example":0},"cardsYellow":{"type":"number","example":0},"cardsSecondYellow":{"type":"number","example":0},"passesAccuracy":{"type":"string","example":"78.57 %"},"passesSuccessful":{"type":"number","example":22},"passesFailed":{"type":"number","example":0},"passesTotal":{"type":"number","example":28},"passesKey":{"type":"number","example":3},"penaltiesScored":{"type":"number","example":0},"penaltiesMissed":{"type":"number","example":0},"penaltiesTotal":{"type":"number","example":0},"penaltiesAccuracy":{"type":"string","example":"0.00 %"},"shotsOnTarget":{"type":"number","example":1},"shotsOffTarget":{"type":"number","example":0},"shotsTotal":{"type":"number","example":1},"shotsAccuracy":{"type":"string","example":"100.00 %"},"expectedGoals":{"type":"number","example":0.12},"expectedAssists":{"type":"number","example":0.25},"expectedGoalsOnTarget":{"type":"number","example":0.16},"expectedGoalsOnTargetConceded":{"type":"number","example":0},"expectedGoalsPrevented":{"type":"number","example":0}},"required":["goalsScored","goalsSaved","goalsConceded","assists","dribblesTotal","dribblesSuccessful","dribblesFailed","dribbleSuccessRate","fouledByOthers","fouledOthers","tacklesTotal","interceptionsTotal","duelsTotal","duelsWon","duelsLost","duelSuccessRate","cardsRed","cardsYellow","cardsSecondYellow","passesAccuracy","passesSuccessful","passesFailed","passesTotal","passesKey","penaltiesScored","penaltiesMissed","penaltiesTotal","penaltiesAccuracy","shotsOnTarget","shotsOffTarget","shotsTotal","shotsAccuracy"]},"FootballPlayerBoxScore":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"fullName":{"type":"string"},"logo":{"type":"string"},"matchRating":{"type":"string","example":"6.90"},"shirtNumber":{"type":"number","example":2},"isCaptain":{"type":"boolean","example":false},"position":{"type":"string","enum":["Goalkeeper","Defender","Midfielder","Forward"],"example":"Defender"},"minutesPlayed":{"type":"number","example":90},"isSubstitute":{"type":"boolean","example":false},"offsides":{"type":"number","example":0},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/PlayerBoxScoreStatisticsDto"}}},"required":["id","name","isCaptain","minutesPlayed","isSubstitute","offsides","statistics"]},"FootballPlayerMatchStatisticsResponse":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/FootballTeamBoxScoreResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/FootballPlayerBoxScore"}}},"required":["team","players"]},"AmericanFootballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"logo":{"type":"string","example":"https://example.com/logos/team/111.png"},"name":{"type":"string","example":"Saints"},"displayName":{"type":"string","example":"New Orleans Saints"},"abbreviation":{"type":"string","example":"NO"},"league":{"type":"string","example":"NFL"}},"required":["id","displayName","abbreviation","league"]},"AmfTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league round.","example":67},"wins":{"type":"number","description":"Number of games team has won during a specific league round.","example":24},"loses":{"type":"number","description":"Number of games team has lost during a specific league round.","example":43}},"required":["played","wins","loses"]},"AmfTeamTotalPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":1369,"description":"Number of points team has scored during a specific league round."},"received":{"type":"number","example":1619,"description":"Number of points team has received during a specific league round."}},"required":["scored","received"]},"AmfTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round.","allOf":[{"$ref":"#/components/schemas/AmfTeamTotalGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored, and received during a specific league round.","allOf":[{"$ref":"#/components/schemas/AmfTeamTotalPointsStatsResponseDto"}]}},"required":["games","points"]},"AmfTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":33},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":13},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":20}},"required":["played","wins","loses"]},"AmfTeamHomePointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored whilst playing as home team during a specific league round.","example":694},"received":{"type":"number","description":"Number of points team has received whilst playing as home team during a specific league round.","example":713}},"required":["scored","received"]},"AmfTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/AmfTeamHomeGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received, during a specific league round, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/AmfTeamHomePointsStatsResponseDto"}]}},"required":["games","points"]},"AmfTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":34},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":11},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":23}},"required":["played","wins","loses"]},"AmfTeamAwayPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league round.","example":675},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league round.","example":906}},"required":["scored","received"]},"AmfTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/AmfTeamAwayGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/AmfTeamAwayPointsStatsResponseDto"}]}},"required":["games","points"]},"AmfTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league round.","allOf":[{"$ref":"#/components/schemas/AmfTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league round, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/AmfTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league round, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/AmfTeamAwayStatsResponseDto"}]},"leagueName":{"type":"string","example":"NFL","description":"League name to which team statistics are associated."},"round":{"type":"string","example":"regular-season","description":"Round to which team statistics are associated."}},"required":["total","home","away","leagueName","round"]},"AmericanFootballMatchTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"logo":{"type":"string","example":"https://example.com/logos/team/111.png"},"name":{"type":"string","example":"Saints"},"displayName":{"type":"string","example":"New Orleans Saints"},"abbreviation":{"type":"string","example":"NO"}},"required":["id","displayName","abbreviation"]},"AmericanFootballMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"21 - 7","description":"Home - Away score for the match."},"firstPeriod":{"type":"string","example":"0 - 0","description":"Home - Away score in 1st period."},"secondPeriod":{"type":"string","example":"7 - 7","description":"Home - Away score in 2nd period."},"thirdPeriod":{"type":"string","example":"7 - 0","description":"Home - Away score in 3rd period."},"fourthPeriod":{"type":"string","example":"7 - 0","description":"Home - Away score in 4th period."},"firstOvertimePeriod":{"type":"string","example":"7 - 0","description":"Home - Away score in the first overtime period."},"secondOvertimePeriod":{"type":"string","example":"7 - 0","description":"Home - Away score in the second overtime period."}}},"AmericanFootballMatchStateResponseDto":{"type":"object","properties":{"period":{"type":"number","description":"Current in play period.","example":2},"clock":{"type":"number","description":"Current minute of the in play period.","example":8},"description":{"type":"string","enum":["Suspended","Postponed","Cancelled","Abandoned","Finished","In progress","End period","Half time","Unknown","Scheduled"],"example":"In progress","description":"Current status/description of the match."},"score":{"$ref":"#/components/schemas/AmericanFootballMatchScoreResponseDto"},"report":{"type":"string","example":"Final","description":"Additional description of the match state."}},"required":["description","score"]},"AmericanFootballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"round":{"type":"string","example":"Regular Season - 32"},"date":{"type":"string","example":"2023-05-20T15:30:00.000Z"},"league":{"type":"string","example":"NFL"},"season":{"type":"number","example":2023},"awayTeam":{"$ref":"#/components/schemas/AmericanFootballMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/AmericanFootballMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/AmericanFootballMatchStateResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"AmericanFootballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballMatchVenueResponseDto":{"type":"object","properties":{"city":{"type":"string","example":"Baltimore"},"name":{"type":"string","example":"M&T Bank Stadium"},"state":{"type":"string","example":"MD"}},"required":["city","name","state"]},"StatisticsItem":{"type":"object","properties":{"name":{"type":"string","example":"Rushing Attempts"},"value":{"type":"number","example":34}},"required":["name","value"]},"TeamStatisticsResponseDto":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/StatisticsItem"}}},"required":["statistics"]},"AmericanFootballMatchStatsResponseDto":{"type":"object","properties":{"homeTeam":{"$ref":"#/components/schemas/TeamStatisticsResponseDto"},"awayTeam":{"$ref":"#/components/schemas/TeamStatisticsResponseDto"}},"required":["homeTeam","awayTeam"]},"AmericanFootballTeamDataResponseDto":{"type":"object","properties":{"id":{"type":"number","example":35},"logo":{"type":"string","example":"https://highlightly.net/american-football/images/teams/35.png"},"name":{"type":"string","example":"Saints"},"league":{"type":"string","example":"NFL"},"displayName":{"type":"string","example":"New Orleans Saints"},"abbreviation":{"type":"string","example":"NO"}},"required":["id","logo","name","league","displayName","abbreviation"]},"AmericanFootballInjuryItemPlayerDto":{"type":"object","properties":{"name":{"type":"string","example":"Alvin Kamara"},"jersey":{"type":"number","example":41},"position":{"type":"string","example":"Running Back"}},"required":["name"]},"AmericanFootballInjuryDataItem":{"type":"object","properties":{"status":{"type":"string","example":"Questionable"},"player":{"$ref":"#/components/schemas/AmericanFootballInjuryItemPlayerDto"}},"required":["status","player"]},"AmericanFootballInjuriesResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/AmericanFootballTeamDataResponseDto"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballInjuryDataItem"}}},"required":["team","data"]},"AmericanFootballEventStartEndPeriodResponseDto":{"type":"object","properties":{"clock":{"type":"string","example":"11:43"},"period":{"type":"string","example":"1st quarter"},"yardLine":{"type":"number","example":40}},"required":["clock","period","yardLine"]},"AmericanFootballDownDistanceResponseDto":{"type":"object","properties":{"down":{"type":"number","example":3,"nullable":true,"description":"Current down, 1 through 4. Null on non-scrimmage plays such as kickoffs, timeouts and period markers."},"distance":{"type":"number","example":7,"nullable":true,"description":"Yards required for a first down. Null wherever down is null. Goal-to-go when equal to yardsToEndzone."},"yardLine":{"type":"number","example":71,"nullable":true},"yardsToEndzone":{"type":"number","example":29,"nullable":true},"possessionText":{"type":"string","example":"DET 29","nullable":true}}},"AmericanFootballPlayDetailResponseDto":{"type":"object","properties":{"start":{"nullable":true,"description":"Situation at the snap.","allOf":[{"$ref":"#/components/schemas/AmericanFootballDownDistanceResponseDto"}]},"end":{"nullable":true,"description":"Situation after the play resolves. For a live view of the current game state, read this from the most recent play.","allOf":[{"$ref":"#/components/schemas/AmericanFootballDownDistanceResponseDto"}]},"text":{"type":"string","example":"C.Brown up the middle to CIN 31 for 5 yards (D.White).","description":"Narrative play text. Matches the corresponding entry in the drive plays array."},"type":{"type":"string","example":"Pass Reception","nullable":true,"description":"Play classification, for example Rush, Pass Reception, Kickoff, Penalty, Official Timeout."},"period":{"type":"number","example":1,"nullable":true},"clock":{"type":"string","example":"14:53","nullable":true},"isPenalty":{"type":"boolean","example":false}},"required":["text","isPenalty"]},"AmericanFootballEventResponseDto":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/AmericanFootballEventStartEndPeriodResponseDto"},"team":{"$ref":"#/components/schemas/AmericanFootballTeamDataResponseDto"},"plays":{"type":"array","items":{"type":"string"}},"playDetails":{"description":"Structured counterpart to plays, in the same order and of the same length. Carries down and distance, which the plays strings do not.","type":"array","items":{"$ref":"#/components/schemas/AmericanFootballPlayDetailResponseDto"}},"start":{"$ref":"#/components/schemas/AmericanFootballEventStartEndPeriodResponseDto"},"result":{"type":"string","example":"Punt"},"description":{"type":"string","example":"5 plays, 6 yards, 3:17"},"isScoringPlay":{"type":"boolean","example":false}},"required":["end","team","plays","playDetails","start","result","description","isScoringPlay"]},"AmericanFootballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"round":{"type":"string","example":"Regular Season - 32"},"date":{"type":"string","example":"2023-05-20T15:30:00.000Z"},"league":{"type":"string","example":"NFL"},"season":{"type":"number","example":2023},"awayTeam":{"$ref":"#/components/schemas/AmericanFootballMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/AmericanFootballMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/AmericanFootballMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/AmericanFootballMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"matchStatistics":{"$ref":"#/components/schemas/AmericanFootballMatchStatsResponseDto"},"injuries":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballInjuriesResponseDto"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballEventResponseDto"}},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"AmericanFootballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"NFL: New Orleans Saints vs Kansas City Chiefs"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/v23r23fds2cff"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/v23r23fds2cff"},"match":{"$ref":"#/components/schemas/AmericanFootballMatchResponseDto"},"channel":{"type":"string","example":"NFL","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"AmericanFootballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":53},"name":{"type":"string","example":"Megapari Sport"}},"required":["id","name"]},"AmericanFootballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":2.8},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"AmericanFootballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":53},"bookmakerName":{"type":"string","example":"Megapari Sport"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Odd or Even"},"values":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"AmericanFootballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":394},"odds":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballMarketResponseDto"}}},"required":["matchId","odds"]},"AmericanFootballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballStandingsTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":3},"logo":{"type":"string","example":"https://highlightly.net/american-football/images/teams/3.png"},"name":{"type":"string","example":"Broncos"},"displayName":{"type":"string","example":"Denver Broncos"},"abbreviation":{"type":"string","example":"DEN"}},"required":["id","logo","name","displayName","abbreviation"]},"AmericanFootballStatsValueResponseDto":{"type":"object","properties":{"value":{"type":"string","example":"+4"},"displayName":{"type":"string","example":"Differential"}},"required":["value","displayName"]},"AmericanFootballTeamStatsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/AmericanFootballStandingsTeamResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballStatsValueResponseDto"}}},"required":["team","statistics"]},"AmericanFootballStandingsDataResponseDto":{"type":"object","properties":{"leagueName":{"type":"string","example":"American Football Conference"},"abbreviation":{"type":"string","example":"AFC"},"year":{"type":"number","example":2024},"leagueType":{"type":"string","example":"NFL"},"seasonType":{"type":"string","example":"Preseason"},"startDate":{"type":"string","example":"2024-08-01T07:00:00.000Z"},"endDate":{"type":"string","example":"2024-09-05T06:59:00.000Z"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballTeamStatsResponseDto"}}},"required":["leagueName","abbreviation","year","leagueType","seasonType","startDate","endDate","data"]},"AmericanFootballStandingsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballStandingsDataResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballLineupsPlayerDto":{"type":"object","properties":{"id":{"type":"number","example":45642302},"jersey":{"type":"number","example":11},"player":{"type":"string","example":"Logan Woodside"},"position":{"type":"string","example":"Quarterback"},"positionAbbreviation":{"type":"string","example":"QB"},"isStarter":{"type":"boolean","example":true}},"required":["id","player","position","positionAbbreviation"]},"AmericanFootballLineupsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/AmericanFootballTeamResponseDto"},"lineup":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballLineupsPlayerDto"}}},"required":["team","lineup"]},"AmericanFootballLineupsResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/AmericanFootballLineupsDto"},"away":{"$ref":"#/components/schemas/AmericanFootballLineupsDto"}},"required":["home","away"]},"AmericanFootballPlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36017},"fullName":{"type":"string","example":"Tom Brady"},"logo":{"type":"string"}},"required":["id"]},"AmericanFootballPlayerPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballPlayerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"AmericanFootballDetailedPlayerSummaryPositionDto":{"type":"object","properties":{"main":{"type":"string","example":"Quarterback"},"abbreviation":{"type":"string","example":"QB"}}},"AmericanFootballDetailedPlayerSummaryDraftDto":{"type":"object","properties":{"round":{"type":"number","example":6},"year":{"type":"number","example":2000},"pick":{"type":"number","example":199}}},"AmericanFootballDetailedPlayerSummaryTeamDto":{"type":"object","properties":{"id":{"type":"number","example":92734},"logo":{"type":"string","example":"https://highlightly.net/american-football/images/teams/92734.png"},"name":{"type":"string","example":"Buccaneers"},"league":{"type":"string","example":"NFL"},"displayName":{"type":"string","example":"Tampa Bay Buccaneers"},"abbreviation":{"type":"string","example":"TB"}},"required":["id","name","league","displayName","abbreviation"]},"AmericanFootballDetailedPlayerSummaryProfileDto":{"type":"object","properties":{"fullName":{"type":"string","example":"Tom Brady"},"birthPlace":{"type":"string","example":"San Mateo, CA, USA"},"birthDate":{"type":"string","description":"DD.MM.YYYY format","example":"03.08.1977"},"height":{"type":"string","example":"6' 4\""},"jersey":{"type":"string","example":"12"},"weight":{"type":"string","example":"225 lbs"},"isActive":{"type":"boolean","example":false},"position":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryPositionDto"},"draft":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryDraftDto"},"team":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryTeamDto"}},"required":["position","draft","team"]},"AmericanFootballDetailedPlayerSummaryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36017},"fullName":{"type":"string","example":"Tom Brady"},"logo":{"type":"string"},"profile":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryProfileDto"}},"required":["id"]},"AmericanFootballStatEntry":{"type":"object","properties":{"name":{"type":"string","example":"Total Rushing Yardage"},"value":{"type":"number","example":4693},"category":{"type":"string","enum":["General","Defense","Returning","Passing","Rushing","Receiving","Scoring","Punting","Kicking"],"example":"Rushing"}},"required":["name","value","category"]},"AmericanFootballDetailedPlayerStatisticsPerSeasonDto":{"type":"object","properties":{"stats":{"description":"Relevant stats for player position.","type":"array","items":{"$ref":"#/components/schemas/AmericanFootballStatEntry"}},"teams":{"description":"Teams for which the player played in a given season.","type":"array","items":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerSummaryTeamDto"}},"league":{"type":"string","example":"NFL"},"season":{"type":"number","example":2022},"seasonBreakdown":{"type":"string","enum":["Entire","Season"],"example":"Entire","description":"Represents the coverage for the stored statistics. Pre-season is never included."}},"required":["stats","teams","league","season","seasonBreakdown"]},"AmericanFootballDetailedPlayerStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36017},"fullName":{"type":"string","example":"Tom Brady"},"logo":{"type":"string"},"perSeason":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballDetailedPlayerStatisticsPerSeasonDto"}}},"required":["id","perSeason"]},"AmericanFootballBoxScorePlayerItemResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58746872},"name":{"type":"string","example":"Lamar Jackson"},"jersey":{"type":"number","example":8}},"required":["id","name"]},"AmericanFootballBoxScoreStatItemResponseDto":{"type":"object","properties":{"group":{"type":"string","example":"Passing"},"name":{"type":"string","example":"Total Successful Passes"},"value":{"type":"number","example":7}},"required":["group","name","value"]},"AmericanFootballBoxScoreItemResponseDto":{"type":"object","properties":{"player":{"$ref":"#/components/schemas/AmericanFootballBoxScorePlayerItemResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballBoxScoreStatItemResponseDto"}}},"required":["player","statistics"]},"AmericanFootballPlayerBoxScoreTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":92743},"name":{"type":"string","example":"Baltimore Ravens"},"logo":{"type":"string","example":"https://highlightly.net/american-football/images/teams/92743.png"},"boxScores":{"type":"array","items":{"$ref":"#/components/schemas/AmericanFootballBoxScoreItemResponseDto"}}},"required":["id","name","boxScores"]},"AmericanFootballPlayerBoxScoreMatchStatsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/AmericanFootballPlayerBoxScoreTeamResponseDto"}},"required":["team"]},"BasketballCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"AU"},"name":{"type":"string","example":"Australia"},"logo":{"type":"string","example":"https://example.com/logos/country/AU.png"}},"required":["code","name","logo"]},"BasketballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":7592},"logo":{"type":"string","example":"https://example.com/logos/team/7592.png"},"name":{"type":"string","example":"Adelaide"}},"required":["id","name"]},"BasketballMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1635},"season":{"type":"number","example":2023},"name":{"type":"string","example":"NBL"},"logo":{"type":"string","example":"https://example.com/logos/league/1635.png"}},"required":["id","season","name"]},"BasketballMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"105 - 104","description":"Home - Away score for the match. Includes overtime as well."},"q1":{"type":"string","example":"22 - 15","description":"Home - Away score in 1st quarter."},"q2":{"type":"string","example":"17 - 33","description":"Home - Away score in 2nd quarter."},"q3":{"type":"string","example":"11 - 27","description":"Home - Away score in 3rd quarter."},"q4":{"type":"string","example":"33 - 14","description":"Home - Away score in 4th quarter."},"overTime":{"type":"string","example":"22 - 15","description":"Home - Away score in overtime."}}},"BasketballMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Not started","First quarter","Second quarter","Third quarter","Fourth quarter","Over time","Break time","Half time","Finished","Finished after over time","Postponed","Cancelled","Suspended","Awarded","Abandoned","Unknown","To be announced"],"example":"Finished","description":"State of the match."},"clock":{"type":"number","example":9,"description":"Current minute of the current period."},"score":{"$ref":"#/components/schemas/BasketballMatchScoreResponseDto"}},"required":["description","score"]},"BasketballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":489389},"week":{"type":"string","example":"1"},"stage":{"type":"string","example":"Final"},"date":{"type":"string","example":"2023-10-01T03:00:00.000Z"},"country":{"$ref":"#/components/schemas/BasketballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/BasketballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/BasketballTeamResponseDto"},"league":{"$ref":"#/components/schemas/BasketballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/BasketballMatchStateResponseDto"}},"required":["id","stage","date","country","awayTeam","homeTeam","league","state"]},"BasketballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballMatchStatisticsResponseItemDto":{"type":"object","properties":{"value":{"type":"number","example":30},"displayName":{"type":"string","example":"Field Goals"}},"required":["value","displayName"]},"BasketballMatchStatisticsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/BasketballTeamResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchStatisticsResponseItemDto"}}},"required":["team","statistics"]},"BasketballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":318831338},"week":{"type":"string","example":"50"},"stage":{"type":"string","example":"Final"},"date":{"type":"string","example":"2024-03-31T11:35:00.000Z"},"country":{"$ref":"#/components/schemas/BasketballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/BasketballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/BasketballTeamResponseDto"},"league":{"$ref":"#/components/schemas/BasketballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/BasketballMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMatchStatisticsResponseDto"}},"news":{"type":"array","items":{"$ref":"#/components/schemas/NewsDto"}}},"required":["id","stage","date","country","awayTeam","homeTeam","league","state","statistics"]},"BasketballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":28},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/28.png"},"title":{"type":"string","example":"NBL: Adelaide vs Melbourne United"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/213123safas132e"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/213123safas132e"},"match":{"$ref":"#/components/schemas/BasketballMatchResponseDto"},"channel":{"type":"string","example":"NBA","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"BasketballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"BasketballLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1635},"logo":{"type":"string","example":"https://example.com/logos/league/1635.png"},"name":{"type":"string","example":"NBL"},"country":{"$ref":"#/components/schemas/BasketballCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/BasketballSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"BasketballLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league-season.","example":42},"wins":{"type":"number","description":"Number of games team has won during a specific league-season.","example":36},"loses":{"type":"number","description":"Number of games team has lost during a specific league-season.","example":6}},"required":["played","wins","loses"]},"BasketballTeamTotalPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":3722,"description":"Number of points team has scored during a specific league-season."},"received":{"type":"number","example":3328,"description":"Number of points team has received during a specific league-season."}},"required":["scored","received"]},"BasketballTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season.","allOf":[{"$ref":"#/components/schemas/BasketballTeamTotalGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored, and received during a specific league-season.","allOf":[{"$ref":"#/components/schemas/BasketballTeamTotalPointsStatsResponseDto"}]}},"required":["games","points"]},"BasketballTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league-season.","example":22},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league-season.","example":20},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league-season.","example":2}},"required":["played","wins","loses"]},"BasketballTeamHomePointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored whilst playing as home team during a specific league-season.","example":2015},"received":{"type":"number","description":"Number of points team has received whilst playing as home team during a specific league-season.","example":1733}},"required":["scored","received"]},"BasketballTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/BasketballTeamHomeGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received, during a specific league-season, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/BasketballTeamHomePointsStatsResponseDto"}]}},"required":["games","points"]},"BasketballTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as away team during a specific league-season.","example":20},"wins":{"type":"number","description":"Number of games team has won as away team during a specific league-season.","example":16},"loses":{"type":"number","description":"Number of games team has lost as away team during a specific league-season.","example":4}},"required":["played","wins","loses"]},"BasketballTeamAwayPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league-season.","example":1707},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league-season.","example":1595}},"required":["scored","received"]},"BasketballTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/BasketballTeamAwayGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/BasketballTeamAwayPointsStatsResponseDto"}]}},"required":["games","points"]},"BasketballTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league-season.","allOf":[{"$ref":"#/components/schemas/BasketballTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/BasketballTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/BasketballTeamAwayStatsResponseDto"}]},"leagueId":{"type":"number","example":100351,"description":"League id to which team statistics are associated."},"leagueName":{"type":"string","example":"ACB","description":"League name to which team statistics are associated."},"season":{"type":"number","example":2023,"description":"Season year to which team statistics are associated."}},"required":["total","home","away","leagueId","leagueName","season"]},"BasketballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"BasketballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.75},"value":{"type":"string","example":"Over"}},"required":["odd","value"]},"BasketballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":75},"bookmakerName":{"type":"string","example":"Powbet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Total Points 161.5"},"values":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"BasketballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":298649022},"odds":{"type":"array","items":{"$ref":"#/components/schemas/BasketballMarketResponseDto"}}},"required":["matchId","odds"]},"BasketballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BasketballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BasketballStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":14400},"logo":{"type":"string","example":"https://example.com/logos/team/14400.png"},"name":{"type":"string","example":"Monaco"}},"required":["id","name"]},"BasketballStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/BasketballStandingsTeamDto"},"wins":{"type":"number","example":28},"loses":{"type":"number","example":4},"position":{"type":"number","example":1},"gamesPlayed":{"type":"number","example":32},"scoredPoints":{"type":"number","example":2759},"receivedPoints":{"type":"number","example":2383}},"required":["team","wins","loses","position","gamesPlayed","scoredPoints","receivedPoints"]},"BasketballStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Regular Season"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/BasketballStandingsDto"}}},"required":["name","standings"]},"BasketballStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":2486},"logo":{"type":"string","example":"https://example.com/logos/league/2486.png"},"name":{"type":"string","example":"LNB"},"season":{"type":"number","example":2023}},"required":["id","name","season"]},"BasketballStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/BasketballStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/BasketballStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"HockeyCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"DE"},"name":{"type":"string","example":"Germany"},"logo":{"type":"string","example":"https://example.com/logos/country/DE.png"}},"required":["code","name","logo"]},"HockeyTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":223746},"logo":{"type":"string","example":"https://example.com/logos/team/223746.png"},"name":{"type":"string","example":"Frankfurt Lowen"}},"required":["id","name"]},"HockeyMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":16953},"season":{"type":"number","example":2023},"name":{"type":"string","example":"DEL"},"logo":{"type":"string","example":"https://example.com/logos/league/16953.png"}},"required":["id","season","name"]},"HockeyMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"4 - 4","description":"Home - Away score for the match."},"overTime":{"type":"string","example":"6 - 4","description":"Home - Away score in overtime."},"penalties":{"type":"string","example":"17 - 33","description":"Home - Away score in penalties."},"firstPeriod":{"type":"string","example":"2 - 0","description":"Home - Away score in 1st period."},"secondPeriod":{"type":"string","example":"2 - 1","description":"Home - Away score in 2nd period."},"thirdPeriod":{"type":"string","example":"5 - 2","description":"Home - Away score in 3rd period."}}},"HockeyMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Not started","1st period","2nd period","3rd period","Over time","Penalties","Break time","Awarded","Postponed","Cancelled","Interrupted","Abandoned","Finished","To be announced","Finished after penalties","Finished after over time","Unknown"],"example":"1st period","description":"Current state of the game."},"score":{"$ref":"#/components/schemas/HockeyMatchScoreResponseDto"}},"required":["description","score"]},"HockeyMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":291869956},"week":{"type":"string","example":"1"},"date":{"type":"string","example":"2023-10-13T17:30:00.000Z"},"country":{"$ref":"#/components/schemas/HockeyCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/HockeyTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/HockeyTeamResponseDto"},"league":{"$ref":"#/components/schemas/HockeyMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/HockeyMatchStateResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"HockeyHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":16},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/16.png"},"title":{"type":"string","example":"DEL: Frankfurt Lowen vs Kolner"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/13efe2g4t542"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/13efe2g4t542"},"match":{"$ref":"#/components/schemas/HockeyMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"HockeyHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeySeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"HockeyLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":16953},"logo":{"type":"string","example":"https://example.com/logos/league/16953.png"},"name":{"type":"string","example":"DEL"},"country":{"$ref":"#/components/schemas/HockeyCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/HockeySeasonResponseDto"}}},"required":["id","name","country","seasons"]},"HockeyLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeyMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeyDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":308606573},"week":{"type":"string","example":"Quarter-finals"},"date":{"type":"string","example":"2024-03-30T15:00:00.000Z"},"country":{"$ref":"#/components/schemas/HockeyCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/HockeyTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/HockeyTeamResponseDto"},"league":{"$ref":"#/components/schemas/HockeyMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/HockeyMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"referee":{"$ref":"#/components/schemas/DetailedMatchRefereeResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"HockeyTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeyTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league-season.","example":114},"wins":{"type":"number","description":"Number of games team has won during a specific league-season.","example":72},"loses":{"type":"number","description":"Number of games team has lost during a specific league-season.","example":42}},"required":["played","wins","loses"]},"HockeyTeamTotalGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":366,"description":"Number of goals team has scored during a specific league-season."},"received":{"type":"number","example":283,"description":"Number of goals team has received during a specific league-season."}},"required":["scored","received"]},"HockeyTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HockeyTeamTotalGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored, and received during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HockeyTeamTotalGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HockeyTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league-season.","example":58},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league-season.","example":38},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league-season.","example":20}},"required":["played","wins","loses"]},"HockeyTeamHomeGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals team has scored whilst playing as home team during a specific league-season.","example":186},"received":{"type":"number","description":"Number of goals team has received whilst playing as home team during a specific league-season.","example":141}},"required":["scored","received"]},"HockeyTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/HockeyTeamHomeGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored and received, during a specific league-season, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/HockeyTeamHomeGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HockeyTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as away team during a specific league-season.","example":56},"wins":{"type":"number","description":"Number of games team has won as away team during a specific league-season.","example":34},"loses":{"type":"number","description":"Number of games team has lost as away team during a specific league-season.","example":22}},"required":["played","wins","loses"]},"HockeyTeamAwayGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals team has scored as away team, during a specific league-season.","example":180},"received":{"type":"number","description":"Number of goals team has received as away team, during a specific league-season.","example":142}},"required":["scored","received"]},"HockeyTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HockeyTeamAwayGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored and received as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HockeyTeamAwayGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HockeyTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league-season.","allOf":[{"$ref":"#/components/schemas/HockeyTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/HockeyTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/HockeyTeamAwayStatsResponseDto"}]},"leagueId":{"type":"number","example":49291,"description":"League id to which team statistics are associated."},"leagueName":{"type":"string","example":"NHL","description":"League name to which team statistics are associated."},"season":{"type":"number","example":2023,"description":"Season year to which team statistics are associated."}},"required":["total","home","away","leagueId","leagueName","season"]},"HockeyBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"HockeyBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeyMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":2.2},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"HockeyMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":19},"bookmakerName":{"type":"string","example":"1Bet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"3-Way Moneyline"},"values":{"type":"array","items":{"$ref":"#/components/schemas/HockeyMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"HockeyOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":295119925},"odds":{"type":"array","items":{"$ref":"#/components/schemas/HockeyMarketResponseDto"}}},"required":["matchId","odds"]},"HockeyOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HockeyOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HockeyStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":1330897},"logo":{"type":"string","example":"https://example.com/logos/team/1330897.png"},"name":{"type":"string","example":"Finland U20"}},"required":["id","name"]},"HockeyStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/HockeyStandingsTeamDto"},"position":{"type":"number","example":1},"wins":{"type":"number","example":3},"gamesPlayed":{"type":"number","example":3},"loses":{"type":"number","example":0},"scoredGoals":{"type":"number","example":11},"winsOvertime":{"type":"number","example":0},"losesOvertime":{"type":"number","example":0},"receivedGoals":{"type":"number","example":2}},"required":["team","position","wins","gamesPlayed","loses","scoredGoals","winsOvertime","losesOvertime","receivedGoals"]},"HockeyStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Group A"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/HockeyStandingsDto"}}},"required":["name","standings"]},"HockeyStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":130987},"logo":{"type":"string","example":"https://example.com/logos/league/130987.png"},"name":{"type":"string","example":"WCH U20"},"season":{"type":"number","example":2022}},"required":["id","name","season"]},"HockeyStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/HockeyStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/HockeyStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"RugbyCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"EU"},"name":{"type":"string","example":"Europe"},"logo":{"type":"string","example":"https://example.com/logos/country/EU.png"}},"required":["code","name","logo"]},"RugbyTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":384585},"logo":{"type":"string","example":"https://example.com/logos/team/90990.png"},"name":{"type":"string","example":"Italy U20"}},"required":["id","name"]},"RugbyMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":48440},"season":{"type":"number","example":2024},"name":{"type":"string","example":"Six Nations U20"},"logo":{"type":"string","example":"https://example.com/logos/league/48440.png"}},"required":["id","season","name"]},"RugbyMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Not started","First half","Half time","Second half","Extra time","Break time","Penalties","Suspended","Interrupted","Finished","Finished after extra time","Postponed","Cancelled","Abandoned","Awarded","Unknown","To be announced"],"example":"Finished","description":"State of the match."},"score":{"type":"string","example":"47 - 14","description":"Home - Away match score."}},"required":["description"]},"RugbyMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36224450},"week":{"type":"string","example":"4"},"date":{"type":"string","example":"2024-03-08T19:15:00.000Z"},"country":{"$ref":"#/components/schemas/RugbyCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/RugbyTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/RugbyTeamResponseDto"},"league":{"$ref":"#/components/schemas/RugbyMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/RugbyMatchStateResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"RugbyHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/28.png"},"title":{"type":"string","example":"HIGHLIGHTS | Italy v Scotland | Under-20 Six Nations Championship 2024"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/213123safas132e"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/13efe2g4t542"},"match":{"$ref":"#/components/schemas/RugbyMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"RugbyHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbySeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2024}},"required":["season"]},"RugbyLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":48440},"logo":{"type":"string","example":"https://example.com/logos/league/48440.png"},"name":{"type":"string","example":"Six Nations U20"},"country":{"$ref":"#/components/schemas/RugbyCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/RugbySeasonResponseDto"}}},"required":["id","name","country","seasons"]},"RugbyLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbyMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbyMatchLineupPlayerDto":{"type":"object","properties":{"name":{"type":"string","example":"Andrew Porter"},"shortName":{"type":"string","example":"A. Porter"},"countryName":{"type":"string","example":"Ireland"},"birth":{"type":"string","example":"1996-01-16T00:00:00.000Z"},"height":{"type":"string","example":"183 cm"},"position":{"type":"string","enum":["Full Back","Back","Forward","Prop"],"example":"Forward"},"shirtNumber":{"type":"number","example":1}},"required":["name","shortName","shirtNumber"]},"RugbyMatchLineupsDto":{"type":"object","properties":{"initialLineup":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMatchLineupPlayerDto"}},"substitutions":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMatchLineupPlayerDto"}}},"required":["initialLineup","substitutions"]},"RugbyMatchLineupsResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/RugbyMatchLineupsDto"},"away":{"$ref":"#/components/schemas/RugbyMatchLineupsDto"}},"required":["home","away"]},"RugbyDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36125734},"week":{"type":"string","example":"14"},"date":{"type":"string","example":"2024-03-30T15:00:00.000Z"},"country":{"$ref":"#/components/schemas/RugbyCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/RugbyTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/RugbyTeamResponseDto"},"league":{"$ref":"#/components/schemas/RugbyMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/RugbyMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"referee":{"$ref":"#/components/schemas/DetailedMatchRefereeResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"},"lineups":{"$ref":"#/components/schemas/RugbyMatchLineupsResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"RugbyTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbyTotalGamesResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played within given league-season.","example":16},"wins":{"type":"number","description":"Number of games team has won within associated league-season.","example":11},"loses":{"type":"number","description":"Number of games team has lost within associated league-season.","example":5},"draws":{"type":"number","description":"Number of games team has drawn within associated league-season.","example":0}},"required":["played","wins","loses","draws"]},"RugbyTotalPointsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":463,"description":"Number of total points a team has scored."},"received":{"type":"number","example":344,"description":"Number of total points a team has received."}},"required":["scored","received"]},"RugbyTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Total number of games team has won, drawn, or lost","allOf":[{"$ref":"#/components/schemas/RugbyTotalGamesResponseDto"}]},"points":{"description":"Total number of points team has scored and received.","allOf":[{"$ref":"#/components/schemas/RugbyTotalPointsResponseDto"}]}},"required":["games","points"]},"RugbyHomeGamesResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played within given league-season.","example":8},"wins":{"type":"number","description":"Number of games team has won within associated league-season.","example":5},"loses":{"type":"number","description":"Number of games team has lost within associated league-season.","example":0},"draws":{"type":"number","description":"Number of games team has drawn within associated league-season.","example":3}},"required":["played","wins","loses","draws"]},"RugbyHomePointsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":229,"description":"Total number of points team has scored whilst playing at home during a specific league-season."},"received":{"type":"number","example":172,"description":"Total number of points team has received whilst playing at home during a specific league-season."}},"required":["scored","received"]},"RugbyHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Total number of games team has played, won, and lost at home, during a specific league-season","allOf":[{"$ref":"#/components/schemas/RugbyHomeGamesResponseDto"}]},"points":{"description":"Total number of points team has scored and received at home, during a specific league-season","allOf":[{"$ref":"#/components/schemas/RugbyHomePointsResponseDto"}]}},"required":["games","points"]},"RugbyAwayGamesResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Total number of games team has played as away team during a specific league-season.","example":8},"wins":{"type":"number","description":"Total number of games team has won as away team during a specific league-season.","example":5},"draws":{"type":"number","description":"Total number of games team has drawn as away team during a specific league-season.","example":0},"loses":{"type":"number","description":"Total number of games team has lost as away team during a specific league-season.","example":3}},"required":["played","wins","draws","loses"]},"RugbyAwayPointsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":234,"description":"Total number of points team has scored as away team during a specific league-season."},"received":{"type":"number","example":172,"description":"Total number of points team has received as away team during a specific league-season."}},"required":["scored","received"]},"RugbyAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Total number of games team has played, won, and lost during a specific league-season whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/RugbyAwayGamesResponseDto"}]},"points":{"description":"Total number of points team has scored and received during a specific league-season whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/RugbyAwayPointsResponseDto"}]}},"required":["games","points"]},"RugbyTeamStatsResponseDto":{"type":"object","properties":{"total":{"description":"Games and points statistics for the whole league-season.","allOf":[{"$ref":"#/components/schemas/RugbyTotalStatsResponseDto"}]},"home":{"description":"Total number of games and points the team has scored and received during a specific league-season whilst playing as the home team.","allOf":[{"$ref":"#/components/schemas/RugbyHomeStatsResponseDto"}]},"away":{"description":"Total number of games and points team has scored and received during a specific league-season whilst playing as the away team.","allOf":[{"$ref":"#/components/schemas/RugbyAwayStatsResponseDto"}]},"leagueId":{"type":"number","description":"League id corresponding to summarized statistics.","example":38228},"leagueName":{"type":"string","description":"League name corresponding to summarized statistics.","example":"Major League Rugby"},"season":{"type":"number","description":"Season year associated to team statistics.","example":"Major League Rugby"}},"required":["total","home","away","leagueId","leagueName","season"]},"RugbyBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":5},"name":{"type":"string","example":"Marathonbet"}},"required":["id","name"]},"RugbyBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbyMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.92},"value":{"type":"string","example":"Over"}},"required":["odd","value"]},"RugbyMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":1},"bookmakerName":{"type":"string","example":"Bets10"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Over/Under 58.5"},"values":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"RugbyOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":34909655},"odds":{"type":"array","items":{"$ref":"#/components/schemas/RugbyMarketResponseDto"}}},"required":["matchId","odds"]},"RugbyOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RugbyOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"RugbyStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":361608},"logo":{"type":"string","example":"https://example.com/logos/team/361608.png"},"name":{"type":"string","example":"Germany 7s"}},"required":["id","name"]},"RugbyStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/RugbyStandingsTeamDto"},"wins":{"type":"number","example":3},"loses":{"type":"number","example":0},"draws":{"type":"number","example":0},"position":{"type":"number","example":1},"points":{"type":"number","example":9},"gamesPlayed":{"type":"number","example":18},"scoredPoints":{"type":"number","example":53},"receivedPoints":{"type":"number","example":10}},"required":["team","wins","loses","draws","position","points","gamesPlayed","scoredPoints","receivedPoints"]},"RugbyStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Group A"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/RugbyStandingsDto"}}},"required":["name","standings"]},"RugbyStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":69715},"logo":{"type":"string","example":"https://example.com/logos/league/69715.png"},"name":{"type":"string","example":"Sevens Europe Series - Portugal"},"season":{"type":"number","example":2022}},"required":["id","name","season"]},"RugbyStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/RugbyStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/RugbyStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"HandballCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"DE"},"name":{"type":"string","example":"Germany"},"logo":{"type":"string","example":"https://example.com/logos/country/DE.png"}},"required":["code","name","logo"]},"HandballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":332674},"logo":{"type":"string","example":"https://example.com/logos/team/332674.png"},"name":{"type":"string","example":"Solingen W"}},"required":["id","name"]},"HandballMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36526},"season":{"type":"number","example":2023},"name":{"type":"string","example":"1. Bundesliga Women"},"logo":{"type":"string","example":"https://example.com/logos/league/36526.png"}},"required":["id","season","name"]},"HandballMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"26 - 26","description":"Home - Away match score."},"firstHalf":{"type":"string","example":"13 - 15","description":"Home - Away match score in the first half."},"secondHalf":{"type":"string","example":"13 - 11","description":"Home - Away match score in the second half."}}},"HandballMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Not started","First half","Half time","Second half","Extra time","Break time","Penalties","Suspended","Interrupted","Finished","Postponed","Cancelled","Abandoned","Awarded","Unknown","To be announced","Finished after penalties","Finished after extra time"],"example":"Finished","description":"State of the match."},"score":{"$ref":"#/components/schemas/HandballMatchScoreResponseDto"}},"required":["description","score"]},"HandballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":126347903},"week":{"type":"object","example":"9"},"date":{"type":"string","example":"2023-12-27T18:30:00.000Z"},"country":{"$ref":"#/components/schemas/HandballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/HandballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/HandballTeamResponseDto"},"league":{"$ref":"#/components/schemas/HandballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/HandballMatchStateResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"HandballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"1. Bundesliga Women: Bensheim-Auerbach W vs Solingen W"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/13efe2g4t542"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/13efe2g4t542"},"match":{"$ref":"#/components/schemas/HandballMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"HandballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"HandballLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36526},"logo":{"type":"string","example":"https://example.com/logos/league/36526.png"},"name":{"type":"string","example":"1. Bundesliga Women"},"country":{"$ref":"#/components/schemas/HandballCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/HandballSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"HandballLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":127484839},"week":{"type":"object","example":"21"},"date":{"type":"string","example":"2024-04-06T16:00:00.000Z"},"country":{"$ref":"#/components/schemas/HandballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/HandballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/HandballTeamResponseDto"},"league":{"$ref":"#/components/schemas/HandballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/HandballMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"HandballTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league-season.","example":30},"wins":{"type":"number","description":"Number of games team has won during a specific league-season.","example":20},"loses":{"type":"number","description":"Number of games team has lost during a specific league-season.","example":7},"draws":{"type":"number","description":"Number of games team has played a draw during a specific league-season.","example":3}},"required":["played","wins","loses","draws"]},"HandballTeamTotalGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":935,"description":"Number of goals team has scored during a specific league-season."},"received":{"type":"number","example":815,"description":"Number of goals team has received during a specific league-season."}},"required":["scored","received"]},"HandballTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HandballTeamTotalGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored, and received during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HandballTeamTotalGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HandballTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league-season.","example":15},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league-season.","example":12},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league-season.","example":1},"draws":{"type":"number","description":"Number of games team has played a draw as home team during a specific league-season.","example":1}},"required":["played","wins","loses","draws"]},"HandballTeamHomeGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals team has scored whilst playing as home team during a specific league-season.","example":500},"received":{"type":"number","description":"Number of goals team has received whilst playing as home team during a specific league-season.","example":399}},"required":["scored","received"]},"HandballTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/HandballTeamHomeGameStatsResponseDto"}]},"goals":{"description":"Number of points team has scored and received, during a specific league-season, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/HandballTeamHomeGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HandballTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league-season.","example":15},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league-season.","example":8},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league-season.","example":6},"draws":{"type":"number","description":"Number of games team has played a draw as home team during a specific league-season.","example":1}},"required":["played","wins","loses","draws"]},"HandballTeamAwayGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league-season.","example":435},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league-season.","example":416}},"required":["scored","received"]},"HandballTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HandballTeamAwayGameStatsResponseDto"}]},"goals":{"description":"Number of goals team has scored and received as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/HandballTeamAwayGoalsStatsResponseDto"}]}},"required":["games","goals"]},"HandballTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league-season.","allOf":[{"$ref":"#/components/schemas/HandballTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/HandballTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/HandballTeamAwayStatsResponseDto"}]},"leagueId":{"type":"number","example":88437,"description":"League id to which team statistics are associated."},"leagueName":{"type":"string","example":"Liga ASOBAL","description":"League name to which team statistics are associated."},"season":{"type":"number","example":2023,"description":"Season year to which team statistics are associated."}},"required":["total","home","away","leagueId","leagueName","season"]},"HandballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"HandballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.7},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"HandballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":3},"bookmakerName":{"type":"string","example":"22Bet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Full Time Result"},"values":{"type":"array","items":{"$ref":"#/components/schemas/HandballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"HandballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":123121762},"odds":{"type":"array","items":{"$ref":"#/components/schemas/HandballMarketResponseDto"}}},"required":["matchId","odds"]},"HandballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HandballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"HandballStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":2266146},"logo":{"type":"string","example":"https://example.com/logos/team/2266146.png"},"name":{"type":"string","example":"France"}},"required":["id","name"]},"HandballStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/HandballStandingsTeamDto"},"position":{"type":"number","example":1},"wins":{"type":"number","example":3},"draws":{"type":"number","example":1},"gamesPlayed":{"type":"number","example":4},"loses":{"type":"number","example":0},"scoredGoals":{"type":"number","example":111},"receivedGoals":{"type":"number","example":109}},"required":["team","position","wins","draws","gamesPlayed","loses","scoredGoals","receivedGoals"]},"HandballStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Regular Season"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/HandballStandingsDto"}}},"required":["name","standings"]},"HandballStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":171835},"logo":{"type":"string","example":"https://example.com/logos/league/171835.png"},"name":{"type":"string","example":"Golden League - France"},"season":{"type":"number","example":2024}},"required":["id","name","season"]},"HandballStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/HandballStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/HandballStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"VolleyballCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"IT"},"name":{"type":"string","example":"Italy"},"logo":{"type":"string","example":"https://example.com/logos/country/IT.png"}},"required":["code","name","logo"]},"VolleyballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":630524},"logo":{"type":"string","example":"https://example.com/logos/team/630524.png"},"name":{"type":"string","example":"Trentino"}},"required":["id","name"]},"VolleyballMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":83331},"season":{"type":"number","example":2023},"name":{"type":"string","example":"SuperLega"},"logo":{"type":"string","example":"https://example.com/logos/league/83331.png"}},"required":["id","season","name"]},"VolleyballMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"3 - 1","description":"Home - Away score for the match."},"firstSet":{"type":"string","example":"19 - 25","description":"Home - Away score for the first set."},"secondSet":{"type":"string","example":"25 - 12","description":"Home - Away score for the second set."},"thirdSet":{"type":"string","example":"22 - 17","description":"Home - Away score for the third set."},"fourthSet":{"type":"string","example":"22 - 17","description":"Home - Away score for the fourth set."},"fifthSet":{"type":"string","example":"25 - 19","description":"Home - Away score for the fifth set."}}},"VolleyballMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Not started","First set","Second set","Third set","Fourth set","Fifth set","Awarded","Postponed","Cancelled","Interrupted","Abandoned","Finished","Unknown","To be announced"],"example":"Second set","description":"State of the match."},"score":{"$ref":"#/components/schemas/VolleyballMatchScoreResponseDto"}},"required":["description","score"]},"VolleyballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":126347903},"week":{"type":"string","example":"12"},"date":{"type":"string","example":"2023-12-30T17:00:00.000Z"},"country":{"$ref":"#/components/schemas/VolleyballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"},"league":{"$ref":"#/components/schemas/VolleyballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/VolleyballMatchStateResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"VolleyballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"SuperLega: Trentino vs Cisterna"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/13efe2g4t542"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/13efe2g4t542"},"match":{"$ref":"#/components/schemas/VolleyballMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"VolleyballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"VolleyballLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":83331},"logo":{"type":"string","example":"https://example.com/logos/league/83331.png"},"name":{"type":"string","example":"SuperLega"},"country":{"$ref":"#/components/schemas/VolleyballCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"VolleyballLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":139134178},"week":{"type":"string","example":"Semi-finals"},"date":{"type":"string","example":"2024-04-06T14:30:00.000Z"},"country":{"$ref":"#/components/schemas/VolleyballCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"},"league":{"$ref":"#/components/schemas/VolleyballMatchLeagueResponseDto"},"state":{"$ref":"#/components/schemas/VolleyballMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","date","country","awayTeam","homeTeam","league","state"]},"VolleyballTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league-season.","example":31},"wins":{"type":"number","description":"Number of games team has won during a specific league-season.","example":13},"loses":{"type":"number","description":"Number of games team has lost during a specific league-season.","example":18}},"required":["played","wins","loses"]},"VolleyballTeamTotalPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":47,"description":"Number of points team has scored during a specific league-season."},"received":{"type":"number","example":13,"description":"Number of points team has received during a specific league-season."}},"required":["scored","received"]},"VolleyballTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamTotalGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored, and received during a specific league-season.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamTotalPointsStatsResponseDto"}]}},"required":["games","points"]},"VolleyballTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league-season.","example":14},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league-season.","example":8},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league-season.","example":6}},"required":["played","wins","loses"]},"VolleyballTeamHomePointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored whilst playing as home team during a specific league-season.","example":26},"received":{"type":"number","description":"Number of points team has received whilst playing as home team during a specific league-season.","example":28}},"required":["scored","received"]},"VolleyballTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamHomeGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received, during a specific league-season, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamHomePointsStatsResponseDto"}]}},"required":["games","points"]},"VolleyballTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as away team during a specific league-season.","example":17},"wins":{"type":"number","description":"Number of games team has won as away team during a specific league-season.","example":5},"loses":{"type":"number","description":"Number of games team has lost as away team during a specific league-season.","example":12}},"required":["played","wins","loses"]},"VolleyballTeamAwayPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league-season.","example":21},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league-season.","example":45}},"required":["scored","received"]},"VolleyballTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamAwayGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received as away team, during a specific league-season.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamAwayPointsStatsResponseDto"}]}},"required":["games","points"]},"VolleyballTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league-season.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league-season, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/VolleyballTeamAwayStatsResponseDto"}]},"leagueId":{"type":"number","example":83331,"description":"League id to which team statistics are associated."},"leagueName":{"type":"string","example":"SuperLega","description":"League name to which team statistics are associated."},"season":{"type":"number","example":2023,"description":"Season year to which team statistics are associated."}},"required":["total","home","away","leagueId","leagueName","season"]},"VolleyballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"VolleyballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":3.39},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"VolleyballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":2},"bookmakerName":{"type":"string","example":"22Bet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Match Winner"},"values":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"VolleyballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":138243181},"odds":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballMarketResponseDto"}}},"required":["matchId","odds"]},"VolleyballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VolleyballStandingsTeamDto":{"type":"object","properties":{"id":{"type":"number","example":1148783},"logo":{"type":"string","example":"https://example.com/logos/team/1148783.png"},"name":{"type":"string","example":"Barkom"}},"required":["id","name"]},"VolleyballStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/VolleyballStandingsTeamDto"},"wins":{"type":"number","example":17},"loses":{"type":"number","example":1},"points":{"type":"number","example":51},"position":{"type":"number","example":1},"gamesPlayed":{"type":"number","example":18},"scoredPoints":{"type":"number","example":53},"receivedPoints":{"type":"number","example":10}},"required":["team","wins","loses","points","position","gamesPlayed","scoredPoints","receivedPoints"]},"VolleyballStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Regular Season"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballStandingsDto"}}},"required":["name","standings"]},"VolleyballStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"number","example":150560},"logo":{"type":"string","example":"https://example.com/logos/league/150560.png"},"name":{"type":"string","example":"Superleague"},"season":{"type":"number","example":2020}},"required":["id","name","season"]},"VolleyballStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/VolleyballStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/VolleyballStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"CricketCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"AU"},"name":{"type":"string","example":"Australia"},"logo":{"type":"string","example":"https://example.com/logos/country/AU.png"}},"required":["code","name","logo"]},"CricketCountryQueryParamDto":{"type":"object","properties":{"name":{"type":"string","example":"Australia"}}},"CricketTeamResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"17838627"},"logo":{"type":"string","example":"https://example.com/logos/team/17838627.png"},"name":{"type":"string","example":"Melbourne Stars"},"abbreviation":{"type":"string","example":"MS"}},"required":["id","name","abbreviation"]},"CricketMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48513362"},"season":{"type":"number","example":2023},"name":{"type":"string","example":"Big Bash League"},"logo":{"type":"string","example":"https://example.com/logos/league/48513362.png"}},"required":["id","season","name"]},"CricketMatchScoreTeamAwayDto":{"type":"object","properties":{"info":{"type":"string","example":"17.2/20 ov, T:138"},"score":{"type":"string","example":"139/4"}}},"CricketMatchScoreTeamHomeDto":{"type":"object","properties":{"info":{"type":"string","example":null},"score":{"type":"string","example":"137/8"}}},"CricketMatchScoreTeamsDto":{"type":"object","properties":{"away":{"$ref":"#/components/schemas/CricketMatchScoreTeamAwayDto"},"home":{"$ref":"#/components/schemas/CricketMatchScoreTeamHomeDto"}},"required":["away","home"]},"CricketMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Finished","Unknown","No live coverage","In play","Stumps","Lunch","Innings break","Drinks","Timeout","Tea","Scheduled","Match delayed","Cancelled","Abandoned","Postponed"],"example":"Finished","description":"State of the match."},"report":{"type":"string","example":"Renegades won by 6 wickets (with 16 balls remaining)","description":"Descriptive report of the match based on the match status."},"teams":{"$ref":"#/components/schemas/CricketMatchScoreTeamsDto"}},"required":["description","teams"]},"CricketMatchResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48514657"},"endDate":{"type":"string","example":"2024-01-13T00:00:00.000Z"},"startDate":{"type":"string","example":"2024-01-13T00:00:00.000Z"},"startTime":{"type":"string","example":"2024-01-13T14:30:00.000Z"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"league":{"$ref":"#/components/schemas/CricketMatchLeagueResponseDto"},"format":{"type":"string","example":"T20","description":"Cricket match format, e.g. T20, ODI, TEST"},"dayType":{"type":"string","enum":["SINGLE","MULTI"],"example":"SINGLE","description":"Information that tells us whether the match will be played across multiple days"},"state":{"$ref":"#/components/schemas/CricketMatchStateResponseDto"}},"required":["id","endDate","startDate","country","awayTeam","homeTeam","league","state"]},"CricketHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":75},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/75.png"},"title":{"type":"string","example":"Big Bash League: Melbourne Renegades vs Melbourne Stars"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/213123safas132e"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/213123safas132e"},"match":{"$ref":"#/components/schemas/CricketMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"CricketHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"CricketLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48513362"},"logo":{"type":"string","example":"https://example.com/logos/league/1635.png"},"name":{"type":"string","example":"Big Bash League"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/CricketSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"CricketLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"FieldingSummary":{"type":"object","properties":{"catches":{"type":"number","description":"Catches taken by fielding team","example":6},"catchesDropped":{"type":"number","description":"Catches dropped by fielding team","example":2},"runsSaved":{"type":"number","description":"Runs saved by fielding team","example":3},"runOuts":{"type":"number","description":"Run outs effected","example":1},"stumpings":{"type":"number","description":"Stumpings effected","example":0}}},"DismissalBatsman":{"type":"object","properties":{"name":{"type":"string","description":"Name of Dismissal Batsman","example":"Ryan Rickelton"}}},"FallOfWickets":{"type":"object","properties":{"runs":{"type":"number","example":5,"description":"Number of runs"},"order":{"type":"number","example":1,"description":"Current order number"},"overs":{"type":"number","example":1.2,"description":"Number of overs"},"dismissalBatsman":{"$ref":"#/components/schemas/DismissalBatsman"}}},"DismissalFielder":{"type":"object","properties":{"name":{"type":"string","description":"Name of the fielder","example":"Jos Buttler"},"isKeeper":{"type":"boolean","description":"Whether the fielder is the wicketkeeper","example":true},"isSubstitute":{"type":"boolean","description":"Whether the fielder is a substitute","example":false}}},"CricketBasePlayerStatsDataResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}}}},"InningBatsmen":{"type":"object","properties":{"runs":{"type":"number","example":4,"description":"Number of runs"},"balls":{"type":"number","example":5,"description":"Number of balls"},"fours":{"type":"number","example":0,"description":"Number of fours"},"sixes":{"type":"number","example":0,"description":"Number of sixes"},"battingStrikeRate":{"type":"number","example":90,"description":"Batting strike rate"},"dismissalStatus":{"type":"string","description":"Dismissal status","example":"caught"},"dismissalFielders":{"description":"Fielders involved in the dismissal","type":"array","items":{"$ref":"#/components/schemas/DismissalFielder"}},"player":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"}}},"InningBowlers":{"type":"object","properties":{"overs":{"type":"number","example":4,"description":"Number of overs"},"player":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"economy":{"type":"number","example":5.5,"description":"Economy statistics"},"maidens":{"type":"number","example":0,"description":"Number of maidens"},"wickets":{"type":"number","example":1,"description":"Number of wickets"},"concededRuns":{"type":"number","example":2,"description":"Number of conceded runs"}}},"InningPartnerships":{"type":"object","properties":{"runs":{"type":"number","example":5,"description":"Number of runs"},"balls":{"type":"number","example":8,"description":"Number of balls"},"overs":{"type":"number","example":1.2,"description":"Number of overs"},"firstPlayer":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"secondPlayer":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"firstPlayerRuns":{"type":"number","example":1,"description":"Number of runs related to first player"},"firstPlayerBalls":{"type":"number","example":3,"description":"Number of balls related to fist player"},"secondPlayerRuns":{"type":"number","example":3,"description":"Number of runs related to second player"},"secondPlayerBalls":{"type":"number","example":5,"description":"Number of balls related to second player"}}},"CricketDetailedMatchStatisticsDataDto":{"type":"object","properties":{"id":{"type":"number","description":"Cricket team id","example":282},"logo":{"type":"string","description":"Cricket team logo url","example":"https://highlightly.net/cricket/images/teams/282.png"},"name":{"type":"number","description":"Cricket team name","example":"West Indies"},"abbreviation":{"type":"string","description":"Cricket team abbreviation","example":"WI"},"inningNumber":{"type":"number","description":"Inning number","example":1},"fours":{"type":"number","description":"Total fours in the innings","example":15},"sixes":{"type":"number","description":"Total sixes in the innings","example":9},"extras":{"type":"number","description":"Total extras in the innings","example":12},"byes":{"type":"number","description":"Byes conceded","example":2},"legByes":{"type":"number","description":"Leg byes conceded","example":4},"wides":{"type":"number","description":"Wides bowled","example":5},"noBalls":{"type":"number","description":"No balls bowled","example":1},"fieldingSummary":{"$ref":"#/components/schemas/FieldingSummary"},"fallOfWickets":{"type":"array","items":{"$ref":"#/components/schemas/FallOfWickets"}},"inningBatsmen":{"type":"array","items":{"$ref":"#/components/schemas/InningBatsmen"}},"inningBowlers":{"type":"array","items":{"$ref":"#/components/schemas/InningBowlers"}},"inningPartnerships":{"type":"array","items":{"$ref":"#/components/schemas/InningPartnerships"}}},"required":["id","name","abbreviation"]},"CricketBaseTeamDataResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Cricket team id","example":282},"logo":{"type":"string","description":"Cricket team logo url","example":"https://highlightly.net/cricket/images/teams/282.png"},"name":{"type":"number","description":"Cricket team name","example":"West Indies"},"abbreviation":{"type":"string","description":"Cricket team abbreviation","example":"WI"}},"required":["id","name","abbreviation"]},"CricketSquadResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"}}}},"CricketBestBatsmenStatsResponseDto":{"type":"object","properties":{"runs":{"type":"number","example":220,"description":"Number of runs"},"average":{"type":"number","example":36.6667,"description":"Batting average stats"},"innings":{"type":"number","example":9,"description":"Total number of innings"},"matches":{"type":"number","example":10,"description":"Total number of matches"},"battingStrikeRate":{"type":"number","example":126.43,"description":"Total batting strike rate"}}},"CricketBestBatsmenStatisticsResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/CricketBestBatsmenStatsResponseDto"}}},"CricketBestBatsmenResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBatsmenStatisticsResponseDto"}}}},"CricketBestBowlerRawStatsDto":{"type":"object","properties":{"balls":{"type":"number","example":126,"description":"Number of balls"},"average":{"type":"number","example":21.29,"description":"Bowling average"},"economy":{"type":"number","example":7.1,"description":"Players economy rate"},"innings":{"type":"number","example":6,"description":"Number of innings"},"matches":{"type":"number","example":6,"description":"Number of matches"},"wickets":{"type":"number","example":7,"description":"Number of wickets"},"concededRuns":{"type":"number","example":149,"description":"Number of conceded runs"},"battingStrikeRate":{"type":"number","example":18,"description":"Batting strike rate"}}},"CricketBestBowlerStatsResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/CricketBestBowlerRawStatsDto"}}},"CricketBestBowlersResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBowlerStatsResponseDto"}}}},"TeamInfo":{"type":"object","properties":{"id":{"type":"string","example":"11759092"},"logo":{"type":"string","example":"https://highlightly.net/cricket/images/teams/11759092.png"},"name":{"type":"string","example":"Royal Challengers Bangalore"},"abbreviation":{"type":"string","example":"RCB"}},"required":["id","name"]},"BowlerStats":{"type":"object","properties":{"overs":{"type":"number","example":2.1},"balls":{"type":"number","example":13},"runsConceded":{"type":"number","example":21},"wickets":{"type":"number","example":0},"economy":{"type":"number","example":9.69}}},"BowlerPlayerLivePerformanceInfo":{"type":"object","properties":{"name":{"type":"string","example":"Rasikh Salam"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"roles":{"example":["bowler"],"type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/BowlerStats"}},"required":["name","battingStyles","bowlingStyles","roles","statistics"]},"BolwerData":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamInfo"},"player":{"$ref":"#/components/schemas/BowlerPlayerLivePerformanceInfo"}},"required":["team","player"]},"BastmenStats":{"type":"object","properties":{"runs":{"type":"number","example":17},"balls":{"type":"number","example":8},"fours":{"type":"number","example":0},"sixes":{"type":"number","example":6},"strikeRate":{"type":"number","example":212.5}}},"BatsmenPlayerLivePerformanceInfo":{"type":"object","properties":{"name":{"type":"string","example":"Sherfane Rutherford"},"battingStyles":{"example":["lhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rfm"],"type":"array","items":{"type":"string"}},"roles":{"example":["middle-order batter"],"type":"array","items":{"type":"string"}},"inning":{"type":"number","example":2},"statistics":{"$ref":"#/components/schemas/BastmenStats"}},"required":["name","battingStyles","bowlingStyles","roles","inning","statistics"]},"BatsmenData":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamInfo"},"player":{"$ref":"#/components/schemas/BatsmenPlayerLivePerformanceInfo"}},"required":["team"]},"CricketInplayResponseDto":{"type":"object","properties":{"bowlers":{"type":"array","items":{"$ref":"#/components/schemas/BolwerData"}},"batsmen":{"type":"array","items":{"$ref":"#/components/schemas/BatsmenData"}}},"required":["bowlers","batsmen"]},"CricketDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"49877382"},"endDate":{"type":"string","example":"2024-03-31T00:00:00.000Z"},"startDate":{"type":"string","example":"2024-03-31T00:00:00.000Z"},"startTime":{"type":"string","example":"2024-03-31T06:00:00.000Z"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"league":{"$ref":"#/components/schemas/CricketMatchLeagueResponseDto"},"format":{"type":"string","example":"T20","description":"Cricket match format, e.g. T20, ODI, TEST"},"dayType":{"type":"string","enum":["SINGLE","MULTI"],"example":"SINGLE","description":"Information that tells us whether the match will be played across multiple days"},"state":{"$ref":"#/components/schemas/CricketMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/CricketDetailedMatchStatisticsDataDto"}},"squad":{"type":"array","items":{"$ref":"#/components/schemas/CricketSquadResponseDto"}},"bestBatsmen":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBatsmenResponseDto"}},"bestBowlers":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBowlersResponseDto"}},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"},"inplayData":{"$ref":"#/components/schemas/CricketInplayResponseDto"}},"required":["id","endDate","startDate","country","awayTeam","homeTeam","league","state"]},"CricketTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":3},"name":{"type":"string","example":"22Bet"}},"required":["id","name"]},"CricketBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.69},"value":{"type":"string","example":"Odd"}},"required":["odd","value"]},"CricketMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":3},"bookmakerName":{"type":"string","example":"22Bet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Odd or Even"},"values":{"type":"array","items":{"$ref":"#/components/schemas/CricketMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"CricketOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"string","example":"49774517"},"odds":{"type":"array","items":{"$ref":"#/components/schemas/CricketMarketResponseDto"}}},"required":["matchId","odds"]},"CricketOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketStandingsTeamDto":{"type":"object","properties":{"id":{"type":"string","example":"13434157"},"logo":{"type":"string","example":"https://example.com/logos/team/13434157.png"},"name":{"type":"string","example":"Rwanda Women"}},"required":["id","name"]},"CricketStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketStandingsTeamDto"},"ties":{"type":"number","example":0},"wins":{"type":"number","example":6},"loses":{"type":"number","example":6},"points":{"type":"number","example":12},"position":{"type":"number","example":1},"pointsFor":{"type":"string","example":"278/46.2"},"netRunRate":{"type":"number","example":3.767},"matchesPlayed":{"type":"number","example":6},"pointsAgainst":{"type":"string","example":"268/120.0"}},"required":["team","ties","wins","loses","points","position","pointsFor","netRunRate","matchesPlayed","pointsAgainst"]},"CricketStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"BCA Kalahari Womens T20 International Tournament"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/CricketStandingsDto"}}},"required":["name","standings"]},"CricketStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"50036737"},"logo":{"type":"string","example":"https://example.com/logos/league/50036737.png"},"name":{"type":"string","example":"BCA Kalahari Womens T20 International Tournament"},"season":{"type":"number","example":2024}},"required":["id","name","season"]},"CricketStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/CricketStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/CricketStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"PlayerTeamResponseMD":{"type":"object","properties":{"id":{"type":"number","example":1},"abbreviation":{"type":"string","nullable":true,"example":"RCB"},"logo":{"type":"string","nullable":true,"example":"https://highlightly.net/cricket/images/teams/1.png"},"isCurrent":{"type":"boolean","example":true}},"required":["id","abbreviation","logo","isCurrent"]},"SinglePlayerInfoResponseMD":{"type":"object","properties":{"id":{"type":"string","example":"ee38c051-470a-4f80-93e5-a034fc6f0ce2"},"longName":{"type":"string","example":"Virat Kohli"},"gender":{"type":"string","example":"M"},"dateOfBirth":{"type":"number","example":594691200000,"description":"Player birth date in Unix timestamp"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"longBattingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"longBowlingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/PlayerTeamResponseMD"}}},"required":["id","longName","battingStyles","bowlingStyles","longBattingStyles","longBowlingStyles"]},"BasePlayerInfoResponseMD":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SinglePlayerInfoResponseMD"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"StatValueMD":{"type":"object","properties":{"value":{"type":"number","example":9},"displayName":{"type":"string","examples":["Sixes","Fifties","Hundreds","Balls Faced"]}},"required":["value","displayName"]},"BasePlayerStatisticsMD":{"type":"object","properties":{"year":{"type":"number","example":2010},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/StatValueMD"}}},"required":["year","statistics"]},"DetailedPlayerSummaryResponseMD":{"type":"object","properties":{"format":{"type":"string","examples":["T20Is","ODIs","Tests"],"description":"Match format"},"batting":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}},"bowling":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}},"fielding":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}}},"required":["format","batting","bowling","fielding"]},"DetailedPlayerInfoResponseMD":{"type":"object","properties":{"id":{"type":"string","example":"ee38c051-470a-4f80-93e5-a034fc6f0ce2"},"longName":{"type":"string","example":"Virat Kohli"},"gender":{"type":"string","example":"M"},"dateOfBirth":{"type":"number","example":594691200000,"description":"Player birth date in Unix timestamp"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"longBattingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"longBowlingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"summary":{"type":"array","items":{"$ref":"#/components/schemas/DetailedPlayerSummaryResponseMD"}}},"required":["id","longName","battingStyles","bowlingStyles","longBattingStyles","longBowlingStyles","summary"]},"BaseballHighlightMatchTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":219},"logo":{"type":"string","example":"https://example.com/logos/team/219.png"},"name":{"type":"string","example":"Bears"},"displayName":{"type":"string","example":"Baylor"},"abbreviation":{"type":"string","example":"BAY"}},"required":["id","displayName","abbreviation"]},"BaseballHighlightMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":394},"round":{"type":"string","example":"regular-season"},"date":{"type":"string","example":"2024-03-06T00:30:00.000Z"},"league":{"type":"string","example":"NCAA"},"season":{"type":"number","example":2024},"awayTeam":{"$ref":"#/components/schemas/BaseballHighlightMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/BaseballHighlightMatchTeamResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam"]},"BaseballHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":27},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/27.png"},"title":{"type":"string","example":"NCAA: Bears vs Patriots"},"description":{"type":"string","example":"Tom Poole sends one deep to right to give Dallas Baptist an insurance run over Baylor."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/v23r23fds2cff"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/v23r23fds2cff"},"match":{"$ref":"#/components/schemas/BaseballHighlightMatchResponseDto"},"channel":{"type":"string","example":"MLB","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"BaseballHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballMatchTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":219},"logo":{"type":"string","example":"https://example.com/logos/team/219.png"},"name":{"type":"string","example":"Bears"},"displayName":{"type":"string","example":"Baylor"},"abbreviation":{"type":"string","example":"BAY"}},"required":["id","displayName","abbreviation"]},"BaseballMatchScore":{"type":"object","properties":{"hits":{"type":"number","example":4},"errors":{"type":"number","example":2},"innings":{"example":[0,0,1,1,0,0,1,1,1],"description":"Scores for each played inning.","type":"array","items":{"type":"string"}}},"required":["innings"]},"BaseballMatchScoreResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/BaseballMatchScore"},"away":{"$ref":"#/components/schemas/BaseballMatchScore"},"current":{"type":"string","example":"5 - 8"}},"required":["home","away"]},"BaseballMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Finished","Postponed","Period End","Rain Delay","Scheduled","Half Time","In Progress","Canceled","Unknown","Suspended","Abandoned"],"example":"Finished"},"report":{"type":"string","example":"Final","description":"Additional description of the match state."},"score":{"$ref":"#/components/schemas/BaseballMatchScoreResponseDto"}},"required":["description","score"]},"BaseballMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":394},"round":{"type":"string","example":"regular-season"},"date":{"type":"string","example":"2024-03-06T00:30:00.000Z"},"league":{"type":"string","example":"NCAA"},"season":{"type":"number","example":2024},"awayTeam":{"$ref":"#/components/schemas/BaseballMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/BaseballMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/BaseballMatchStateResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"BaseballMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballMatchVenueResponseDto":{"type":"object","properties":{"city":{"type":"string","example":"Waco"},"name":{"type":"string","example":"Baylor Ballpark"},"state":{"type":"string","example":"Texas"}},"required":["city","name","state"]},"BaseballTeamStatItemResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Total Strikeouts"},"value":{"type":"number","example":12},"group":{"type":"string","example":"Batting"}},"required":["name","value","group"]},"BaseballMatchTeamStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":10291185},"name":{"type":"string","example":"Toronto Blue Jays"},"logo":{"type":"string","example":"https://highlightly.net/baseball/images/teams/10291185.png"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/BaseballTeamStatItemResponseDto"}}},"required":["id","name","statistics"]},"BaseballMatchStatisticsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/BaseballMatchTeamStatisticsResponseDto"}},"required":["team"]},"BaseballDetailedAthleteMinimal":{"type":"object","properties":{"fullName":{"type":"string","example":"Will Baker"},"playerId":{"type":"number","example":1364867}},"required":["fullName","playerId"]},"BaseballDetailedMatchRunners":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/BaseballDetailedAthleteMinimal"},"second":{"$ref":"#/components/schemas/BaseballDetailedAthleteMinimal"},"third":{"$ref":"#/components/schemas/BaseballDetailedAthleteMinimal"}}},"BaseballDetailedMatchPitch":{"type":"object","properties":{"type":{"type":"string","example":"CURVE"},"velocity":{"type":"number","example":78.2},"ballsCount":{"type":"number","example":0},"strikesCount":{"type":"number","example":0}}},"BaseballDetailedMatchResult":{"type":"object","properties":{"ballsCount":{"type":"number","example":1},"strikesCount":{"type":"number","example":2}}},"BaseballDetailedMatchScoreAtPlay":{"type":"object","properties":{"away":{"type":"number","example":1},"home":{"type":"number","example":2}}},"BaseballDetailedMatchPlaysDto":{"type":"object","properties":{"type":{"type":"string","example":"Start Inning"},"teamId":{"type":"number","example":229},"description":{"type":"string","example":"Top of the 1st inning"},"currentOuts":{"type":"number","example":0},"period":{"type":"string","example":"Top 1st Inning"},"runners":{"$ref":"#/components/schemas/BaseballDetailedMatchRunners"},"pitcher":{"$ref":"#/components/schemas/BaseballDetailedAthleteMinimal"},"batter":{"$ref":"#/components/schemas/BaseballDetailedAthleteMinimal"},"pitch":{"$ref":"#/components/schemas/BaseballDetailedMatchPitch"},"result":{"$ref":"#/components/schemas/BaseballDetailedMatchResult"},"score":{"$ref":"#/components/schemas/BaseballDetailedMatchScoreAtPlay"}},"required":["type","teamId","description","currentOuts","period","pitch","result","score"]},"BaseballDetailedMatchRefereesDto":{"type":"object","properties":{"name":{"type":"string","example":"Jonathan Parra"},"position":{"type":"string","example":"Home Plate Umpire"}},"required":["name","position"]},"BaseballDetailedMatchRosterSingleDto":{"type":"object","properties":{"jersey":{"type":"number","example":1},"fullName":{"type":"string","example":"Hunter Hines"},"position":{"type":"string","example":"First Baseman"},"isStarter":{"type":"boolean","example":true}},"required":["fullName","position","isStarter"]},"BaseballDetailedMatchRostersDto":{"type":"object","properties":{"awayTeam":{"$ref":"#/components/schemas/BaseballDetailedMatchRosterSingleDto"},"homeTeam":{"$ref":"#/components/schemas/BaseballDetailedMatchRosterSingleDto"}},"required":["awayTeam","homeTeam"]},"BaseballDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58348},"round":{"type":"string","example":"regular-season"},"date":{"type":"string","example":"2024-03-31T17:00:00.000Z"},"league":{"type":"string","example":"NCAA"},"season":{"type":"number","example":2024},"awayTeam":{"$ref":"#/components/schemas/BaseballMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/BaseballMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/BaseballMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/BaseballMatchVenueResponseDto"},"stats":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMatchStatisticsResponseDto"}},"plays":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedMatchPlaysDto"}},"referees":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedMatchRefereesDto"}},"rosters":{"$ref":"#/components/schemas/BaseballDetailedMatchRostersDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"BaseballTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":219},"logo":{"type":"string","example":"https://example.com/logos/team/219.png"},"name":{"type":"string","example":"Bears"},"displayName":{"type":"string","example":"Baylor"},"abbreviation":{"type":"string","example":"BAY"},"league":{"type":"string","example":"NCAA"}},"required":["id","displayName","abbreviation","league"]},"BaseballTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league round.","example":102},"wins":{"type":"number","description":"Number of games team has won during a specific league round.","example":43},"loses":{"type":"number","description":"Number of games team has lost during a specific league round.","example":59}},"required":["played","wins","loses"]},"BaseballTeamTotalPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":566,"description":"Number of points team has scored during a specific league round."},"received":{"type":"number","example":600,"description":"Number of points team has received during a specific league round."}},"required":["scored","received"]},"BaseballTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round.","allOf":[{"$ref":"#/components/schemas/BaseballTeamTotalGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored, and received during a specific league round.","allOf":[{"$ref":"#/components/schemas/BaseballTeamTotalPointsStatsResponseDto"}]}},"required":["games","points"]},"BaseballTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":49},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":21},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":28}},"required":["played","wins","loses"]},"BaseballTeamHomePointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored whilst playing as home team during a specific league round.","example":263},"received":{"type":"number","description":"Number of points team has received whilst playing as home team during a specific league round.","example":300}},"required":["scored","received"]},"BaseballTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/BaseballTeamHomeGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received, during a specific league round, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/BaseballTeamHomePointsStatsResponseDto"}]}},"required":["games","points"]},"BaseballTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":53},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":22},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":31}},"required":["played","wins","loses"]},"BaseballTeamAwayPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league round.","example":303},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league round.","example":300}},"required":["scored","received"]},"BaseballTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/BaseballTeamAwayGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/BaseballTeamAwayPointsStatsResponseDto"}]}},"required":["games","points"]},"BaseballTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league round.","allOf":[{"$ref":"#/components/schemas/BaseballTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league round, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/BaseballTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league round, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/BaseballTeamAwayStatsResponseDto"}]},"leagueName":{"type":"string","example":"MLB","description":"League name to which team statistics are associated."},"round":{"type":"string","example":"regular-season","description":"Round to which team statistics are associated."}},"required":["total","home","away","leagueName","round"]},"BaseballStandingsTeamStatsResponseDto":{"type":"object","properties":{"description":{"type":"string","example":"Number of Overtime Losses"},"abbreviation":{"type":"string","example":"OTL"},"displayValue":{"type":"string","example":"0"}},"required":["description","abbreviation","displayValue"]},"BaseballStandingsTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58},"logo":{"type":"string","example":"https://example.com/baseball/images/teams/58.png"},"name":{"type":"string","example":"Dodgers"},"stats":{"type":"array","items":{"$ref":"#/components/schemas/BaseballStandingsTeamStatsResponseDto"}}},"required":["id","name","stats"]},"BaseballStandingsResponseDto":{"type":"object","properties":{"leagueName":{"type":"string","example":"Cactus League (MLB)"},"abbreviation":{"type":"string","example":"CAC"},"year":{"type":"number","example":2024},"leagueType":{"type":"string","example":"MLB"},"seasonType":{"type":"string","example":"Spring Training"},"startDate":{"type":"string","example":"2024-02-15T08:00:00.000Z"},"endDate":{"type":"string","example":"2024-03-27T06:59:00.000Z"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballStandingsTeamResponseDto"}}},"required":["leagueName","abbreviation","year","leagueType","seasonType","startDate","endDate","data"]},"BaseballStandingsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballStandingsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":2.8},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"BaseballMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":53},"bookmakerName":{"type":"string","example":"Megapari Sport"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Odd or Even"},"values":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"BaseballOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":394},"odds":{"type":"array","items":{"$ref":"#/components/schemas/BaseballMarketResponseDto"}}},"required":["matchId","odds"]},"BaseballOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":53},"name":{"type":"string","example":"Megapari Sport"}},"required":["id","name"]},"BaseballBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballLineupsPlayerDto":{"type":"object","properties":{"id":{"type":"number","example":619412},"jersey":{"type":"number","example":22},"player":{"type":"string","example":"Parker Meadows"},"position":{"type":"string","example":"Center field"},"positionAbbreviation":{"type":"string","example":"CF"},"isStarter":{"type":"boolean","example":true}},"required":["id","player","position","positionAbbreviation"]},"BaseballLineupsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/BaseballTeamResponseDto"},"lineup":{"type":"array","items":{"$ref":"#/components/schemas/BaseballLineupsPlayerDto"}}},"required":["team","lineup"]},"BaseballLineupsResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/BaseballLineupsDto"},"away":{"$ref":"#/components/schemas/BaseballLineupsDto"}},"required":["home","away"]},"BaseballPlayerBoxScoreTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":10291185},"name":{"type":"string","example":"Toronto Blue Jays"},"logo":{"type":"string","example":"https://highlightly.net/baseball/images/teams/10291185.png "}},"required":["id","name"]},"BaseballBoxScorePlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":482237},"name":{"type":"string","example":"George Springer"}},"required":["id","name"]},"BaseballBoxScoreStatisticsItemResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Total At-Bats"},"group":{"type":"string","example":"Batting"},"value":{"type":"number","example":6}},"required":["name","group","value"]},"BaseballBoxScoreItemResponseDto":{"type":"object","properties":{"player":{"$ref":"#/components/schemas/BaseballBoxScorePlayerResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/BaseballBoxScoreStatisticsItemResponseDto"}}},"required":["player","statistics"]},"BaseballPlayerBoxScoreMatchStatsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/BaseballPlayerBoxScoreTeamResponseDto"},"boxScores":{"type":"array","items":{"$ref":"#/components/schemas/BaseballBoxScoreItemResponseDto"}}},"required":["team","boxScores"]},"BaseballPlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":342182},"fullName":{"type":"string","example":"Reese Albert"},"logo":{"type":"string"}},"required":["id"]},"BaseballPlayerPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BaseballPlayerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"BaseballDetailedPlayerSummaryPositionDto":{"type":"object","properties":{"main":{"type":"string","example":"Unknown"},"abbreviation":{"type":"string","example":"UN"}}},"BaseballDetailedPlayerSummaryTeamDto":{"type":"object","properties":{"id":{"type":"number","example":10291561},"logo":{"type":"string","example":"https://highlightly.net/baseball/images/teams/10291561.png"},"name":{"type":"string","example":"Seminoles"},"league":{"type":"string","example":"MLB"},"displayName":{"type":"string","example":"Florida State"},"abbreviation":{"type":"string","example":"FSU"}},"required":["id","name","league","displayName","abbreviation"]},"BaseballDetailedPlayerSummaryProfileDto":{"type":"object","properties":{"fullName":{"type":"string","example":"Reese Albert"},"birthPlace":{"type":"string","example":"Jupiter, FL, United States"},"birthDate":{"type":"string","description":"DD.MM.YYYY format","example":"10.07.1999"},"height":{"type":"string","example":"6' 2\""},"jersey":{"type":"string"},"weight":{"type":"string","example":"190 lbs"},"isActive":{"type":"boolean","example":true},"debut":{"type":"number","description":"Player debut year"},"position":{"$ref":"#/components/schemas/BaseballDetailedPlayerSummaryPositionDto"},"team":{"$ref":"#/components/schemas/BaseballDetailedPlayerSummaryTeamDto"}},"required":["position","team"]},"BaseballDetailedPlayerSummaryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":342182},"fullName":{"type":"string","example":"Reese Albert"},"logo":{"type":"string"},"profile":{"$ref":"#/components/schemas/BaseballDetailedPlayerSummaryProfileDto"}},"required":["id"]},"BaseballStatEntry":{"type":"object","properties":{"name":{"type":"string","example":"Player Hit By Pitch"},"value":{"type":"number","example":7},"category":{"type":"string","enum":["Pitching","Batting"],"example":"Batting"}},"required":["name","value","category"]},"BaseballDetailedPlayerStatisticsPerSeasonDto":{"type":"object","properties":{"stats":{"description":"Relevant stats for player position.","type":"array","items":{"$ref":"#/components/schemas/BaseballStatEntry"}},"teams":{"description":"Teams for which the player played in a given season.","type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedPlayerSummaryTeamDto"}},"league":{"type":"string","example":"MLB"},"season":{"type":"number","example":2022},"seasonBreakdown":{"type":"string","enum":["Entire","Season"],"example":"Entire","description":"Represents the coverage for the stored statistics. Pre-season is never included."}},"required":["stats","teams","league","season","seasonBreakdown"]},"BaseballDetailedPlayerStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":342182},"fullName":{"type":"string","example":"Reese Albert"},"logo":{"type":"string"},"perSeason":{"type":"array","items":{"$ref":"#/components/schemas/BaseballDetailedPlayerStatisticsPerSeasonDto"}}},"required":["id","perSeason"]},"NbaBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":53},"name":{"type":"string","example":"Megapari Sport"}},"required":["id","name"]},"NbaBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NbaMatchScoreResponseDto":{"type":"object","properties":{"awayTeam":{"description":"Current away team result for each inning.","type":"array","items":{"type":"number"}},"homeTeam":{"description":"Current home team result for each inning.","type":"array","items":{"type":"number"}}},"required":["awayTeam","homeTeam"]},"NbaMatchStateResponseDto":{"type":"object","properties":{"clock":{"type":"number","example":0,"description":"Time left for a game to finish."},"score":{"$ref":"#/components/schemas/NbaMatchScoreResponseDto"},"period":{"type":"number","example":4,"description":"Current period"},"description":{"type":"string","enum":["Suspended","Postponed","Cancelled","Abandoned","Finished","Scheduled","In progress","End period","Half time","Unknown"],"example":"Finished","description":"Current game state description"}},"required":["clock","score","period","description"]},"NbaTeamInfoResponseDto":{"type":"object","properties":{"id":{"type":"number","example":3},"displayName":{"type":"string","example":"Denver Nuggets"},"name":{"type":"string","example":"Nuggets"},"logo":{"type":"string","example":"https://highlightly.net/nba/images/teams/3.png"},"abbreviation":{"type":"string","example":"DEN"}},"required":["id","displayName","name","abbreviation"]},"NbaMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":5294},"league":{"type":"string","enum":["NBA","NCAA"],"example":"NBA"},"season":{"type":"number","example":2024},"state":{"$ref":"#/components/schemas/NbaMatchStateResponseDto"},"homeTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"awayTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"date":{"type":"string","example":"2024-04-07T01:00:00.000Z"}},"required":["id","league","season","state","homeTeam","awayTeam","date"]},"NbaMatchBaseInfo":{"type":"object","properties":{"id":{"type":"number","example":9853},"league":{"type":"string","enum":["NBA","NCAA"],"example":"NBA"},"homeTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"awayTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"}},"required":["id","league","homeTeam","awayTeam"]},"NbaHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1361},"match":{"$ref":"#/components/schemas/NbaMatchBaseInfo"},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"NCAA: Huskies vs Crimson Tide"},"description":{"type":"string","example":"Following an impressive postseason run that came to an end in a program-first Final Four appearance, Nate Oats expresses his pride in the Tide and says they'll be \"knocking on the door\" next season."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/29g9urg92387"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/213123safas132e"},"channel":{"type":"string","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","match","type","url","embedUrl"]},"NbaHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NbaMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"VenueDetails":{"type":"object","properties":{"city":{"type":"string","example":"Denver"},"name":{"type":"string","example":"Ball Arena"},"state":{"type":"string","example":"CO"}}},"MatchStatisticsItem":{"type":"object","properties":{"name":{"type":"string","example":"3PT Accuracy","description":"Display name for each statistics info."},"value":{"type":"number","example":"Numeric value representing statistics data."}},"required":["name","value"]},"MatchTeamStatistics":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/MatchStatisticsItem"}}},"required":["statistics"]},"MatchStatistics":{"type":"object","properties":{"awayTeam":{"$ref":"#/components/schemas/MatchTeamStatistics"},"homeTeam":{"$ref":"#/components/schemas/MatchTeamStatistics"}},"required":["awayTeam","homeTeam"]},"Event":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"clock":{"type":"string","example":"12:00"},"period":{"type":"string","example":"1st Quarter"},"description":{"type":"string","example":"Rudy Gobert vs. Nikola Jokic (Anthony Edwards gains possession)"},"isScoringPlay":{"type":"boolean","description":"boolean describing whether specific event is scoring or not"},"isShootingPlay":{"type":"boolean","description":"boolean describing whether specific play is shooting or not"}},"required":["team"]},"NbaDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":5294},"league":{"type":"string","enum":["NBA","NCAA"],"example":"NBA"},"season":{"type":"number","example":2024},"state":{"$ref":"#/components/schemas/NbaMatchStateResponseDto"},"homeTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"awayTeam":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"date":{"type":"string","example":"2024-04-07T01:00:00.000Z"},"venue":{"$ref":"#/components/schemas/VenueDetails"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"matchStatistics":{"$ref":"#/components/schemas/MatchStatistics"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","league","season","state","homeTeam","awayTeam","date"]},"NbaMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.75},"value":{"type":"string","example":"Over"}},"required":["odd","value"]},"NbaMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":1},"bookmakerName":{"type":"string","example":"Pinnacle"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Total Points 161.5"},"values":{"type":"array","items":{"$ref":"#/components/schemas/NbaMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"NbaOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":1},"odds":{"type":"array","items":{"$ref":"#/components/schemas/NbaMarketResponseDto"}}},"required":["matchId","odds"]},"NbaOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"StandingsStatistics":{"type":"object","properties":{"value":{"type":"string","example":"75.0"},"displayName":{"type":"string","example":"Opponent Points Per Game"}},"required":["value","displayName"]},"StandingsData":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NbaTeamInfoResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/StandingsStatistics"}}},"required":["team"]},"NbaStandingsResponseDto":{"type":"object","properties":{"leagueName":{"type":"string","example":"America East Conference"},"abbreviation":{"type":"string","example":"AEAST"},"data":{"type":"array","items":{"$ref":"#/components/schemas/StandingsData"}},"year":{"type":"number","example":2024},"seasonType":{"type":"string","example":"Postseason"},"startDate":{"type":"string","example":"2024-03-19T07:00:00.000Z"},"endDate":{"type":"string","example":"2024-03-19T07:00:00.000Z"},"leagueType":{"type":"string","example":"NCAA","enum":["NBA","NCAA"]}},"required":["leagueName","abbreviation","data"]},"NbaPaginatedStandingsResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaStandingsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NbaTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":28},"logo":{"type":"string","example":"https://highlightly.net/nba/images/teams/28.png"},"name":{"type":"string","example":"Rockets"},"displayName":{"type":"string","example":"Houston Rockets"},"abbreviation":{"type":"string","example":"HOU"},"league":{"type":"string","example":"NBA","enum":["NBA","NCAA"]}},"required":["id","displayName","abbreviation","league"]},"NbaTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league round.","example":67},"wins":{"type":"number","description":"Number of games team has won during a specific league round.","example":24},"loses":{"type":"number","description":"Number of games team has lost during a specific league round.","example":43}},"required":["played","wins","loses"]},"NbaTeamTotalPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":1369,"description":"Number of points team has scored during a specific league round."},"received":{"type":"number","example":1619,"description":"Number of points team has received during a specific league round."}},"required":["scored","received"]},"NbaTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round.","allOf":[{"$ref":"#/components/schemas/NbaTeamTotalGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored, and received during a specific league round.","allOf":[{"$ref":"#/components/schemas/NbaTeamTotalPointsStatsResponseDto"}]}},"required":["games","points"]},"NbaTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":33},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":13},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":20}},"required":["played","wins","loses"]},"NbaTeamHomePointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored whilst playing as home team during a specific league round.","example":694},"received":{"type":"number","description":"Number of points team has received whilst playing as home team during a specific league round.","example":713}},"required":["scored","received"]},"NbaTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/NbaTeamHomeGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received, during a specific league round, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/NbaTeamHomePointsStatsResponseDto"}]}},"required":["games","points"]},"NbaTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":34},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":11},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":23}},"required":["played","wins","loses"]},"NbaTeamAwayPointsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of points team has scored as away team, during a specific league round.","example":675},"received":{"type":"number","description":"Number of points team has received as away team, during a specific league round.","example":906}},"required":["scored","received"]},"NbaTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/NbaTeamAwayGameStatsResponseDto"}]},"points":{"description":"Number of points team has scored and received as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/NbaTeamAwayPointsStatsResponseDto"}]}},"required":["games","points"]},"NbaTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and points statistics corresponding to specific league round.","allOf":[{"$ref":"#/components/schemas/NbaTeamTotalStatsResponseDto"}]},"home":{"description":"Game and point statistics corresponding to specific league round, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/NbaTeamHomeStatsResponseDto"}]},"away":{"description":"Game and point statistics corresponding to specific league round, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/NbaTeamAwayStatsResponseDto"}]},"leagueName":{"type":"string","example":"NBA","description":"League name to which team statistics are associated."}},"required":["total","home","away","leagueName"]},"NbaLineupsPlayerDto":{"type":"object","properties":{"id":{"type":"number","example":61000787},"jersey":{"type":"number","example":28},"player":{"type":"string","example":"Hachimura"},"position":{"type":"string","example":"Small forward"},"positionAbbreviation":{"type":"string","example":"SF"},"isStarter":{"type":"boolean","example":true}},"required":["id","player","position","positionAbbreviation"]},"NbaLineupsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NbaTeamResponseDto"},"lineup":{"type":"array","items":{"$ref":"#/components/schemas/NbaLineupsPlayerDto"}}},"required":["team","lineup"]},"NbaLineupsResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/NbaLineupsDto"},"away":{"$ref":"#/components/schemas/NbaLineupsDto"}},"required":["home","away"]},"NbaNcaaPlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36827},"fullName":{"type":"string","example":"Dwight Howard"},"logo":{"type":"string"}},"required":["id"]},"NbaNcaaPlayerPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NbaNcaaPlayerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NbaNcaaDetailedPlayerSummaryPositionDto":{"type":"object","properties":{"main":{"type":"string","example":"Center"},"abbreviation":{"type":"string","example":"C"}}},"NbaNcaaDetailedPlayerSummaryDraftDto":{"type":"object","properties":{"round":{"type":"number","example":1},"year":{"type":"number","example":2004},"pick":{"type":"number","example":1}}},"NbaNcaaDetailedPlayerSummaryTeamDto":{"type":"object","properties":{"id":{"type":"number","example":4},"logo":{"type":"string","example":"https://highlightly.net/nba/images/teams/4.png"},"name":{"type":"string","example":"Lakers"},"league":{"type":"string","example":"NBA"},"displayName":{"type":"string","example":"Los Angeles Lakers"},"abbreviation":{"type":"string","example":"LAL"}},"required":["id","name","league","displayName","abbreviation"]},"NbaNcaaDetailedPlayerSummaryProfileDto":{"type":"object","properties":{"fullName":{"type":"string","example":"Dwight Howard"},"birthPlace":{"type":"string","example":"Atlanta, GA, USA"},"birthDate":{"type":"string","description":"DD.MM.YYYY format","example":"08.12.1985"},"height":{"type":"string","example":"6' 10\""},"jersey":{"type":"string","example":"39"},"weight":{"type":"string","example":"265 lbs"},"isActive":{"type":"boolean","example":false},"position":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryPositionDto"},"draft":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryDraftDto"},"team":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryTeamDto"}},"required":["position","draft","team"]},"NbaNcaaDetailedPlayerSummaryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36827},"fullName":{"type":"string","example":"Dwight Howard"},"logo":{"type":"string"},"profile":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryProfileDto"}},"required":["id"]},"NbaNcaaStatEntry":{"type":"object","properties":{"name":{"type":"string","example":"Total Fouls"},"value":{"type":"number","example":115},"category":{"type":"string","enum":["General","Defense","Offense"],"example":"Offense"}},"required":["name","value","category"]},"NbaNcaaDetailedPlayerStatisticsPerSeasonDto":{"type":"object","properties":{"stats":{"description":"Relevant stats for player position.","type":"array","items":{"$ref":"#/components/schemas/NbaNcaaStatEntry"}},"teams":{"description":"Teams for which the player played in a given season.","type":"array","items":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerSummaryTeamDto"}},"league":{"type":"string","example":"NBA"},"season":{"type":"number","example":2022},"seasonBreakdown":{"type":"string","enum":["Entire","Season"],"example":"Entire","description":"Represents the coverage for the stored statistics. Pre-season is never included."}},"required":["stats","teams","league","season","seasonBreakdown"]},"NbaNcaaDetailedPlayerStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":36827},"fullName":{"type":"string","example":"Dwight Howard"},"logo":{"type":"string"},"perSeason":{"type":"array","items":{"$ref":"#/components/schemas/NbaNcaaDetailedPlayerStatisticsPerSeasonDto"}}},"required":["id","perSeason"]},"NbaBoxScorePlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":99737},"name":{"type":"string","example":"Harrison Barnes"},"jersey":{"type":"number"}},"required":["id","name"]},"NbaBoxScoreStatItemResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"Total Minutes Played"},"value":{"type":"number","example":29}},"required":["name","value"]},"NbaBoxScoreItemResponseDto":{"type":"object","properties":{"player":{"$ref":"#/components/schemas/NbaBoxScorePlayerResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/NbaBoxScoreStatItemResponseDto"}}},"required":["player","statistics"]},"NbaTeamPlayerBoxScoreResponseDto":{"type":"object","properties":{"id":{"type":"number","example":32},"name":{"type":"string","example":"Sacramento Kings"},"logo":{"type":"string","example":"https://highlightly.net/nba/images/teams/32.png"},"boxScores":{"type":"array","items":{"$ref":"#/components/schemas/NbaBoxScoreItemResponseDto"}}},"required":["id","name","boxScores"]},"NbaPlayerBoxScoreResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NbaTeamPlayerBoxScoreResponseDto"}},"required":["team"]},"NhlBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Stake.com"}},"required":["id","name"]},"NhlBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlMatchTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"logo":{"type":"string","example":"https://example.com/logos/team/1.png"},"name":{"type":"string","example":"Panthers"},"displayName":{"type":"string","example":"Florida Panthers"},"abbreviation":{"type":"string","example":"FLA"}},"required":["id","displayName","abbreviation"]},"NhlMatchScoreResponseDto":{"type":"object","properties":{"current":{"type":"string","example":"1 - 1","description":"Home - Away score for the match."},"firstPeriod":{"type":"string","example":"0 - 0","description":"Home - Away score in 1st period."},"secondPeriod":{"type":"string","example":"1 - 1","description":"Home - Away score in 2nd period."},"thirdPeriod":{"type":"string","example":"2 - 2","description":"Home - Away score in 3rd period."},"overtimePeriod":{"type":"string","example":"1 - 0","description":"Home - Away score in the overtime period."}}},"NhlMatchStateResponseDto":{"type":"object","properties":{"period":{"type":"number","description":"Current in play period.","example":2},"clock":{"type":"number","description":"Current minute of the in play period.","example":8},"description":{"type":"string","enum":["Suspended","Postponed","Cancelled","Abandoned","Finished","In progress","End period","Half time","Unknown","Scheduled"],"example":"In progress","description":"Current status/description of the match."},"score":{"$ref":"#/components/schemas/NhlMatchScoreResponseDto"},"report":{"type":"string","example":"Final","description":"Additional description of the match state."}},"required":["description","score"]},"NhlMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"round":{"type":"string","example":"Regular Season - 14"},"date":{"type":"string","example":"2023-05-20T15:30:00.000Z"},"league":{"type":"string","example":"NHL"},"season":{"type":"number","example":2023},"awayTeam":{"$ref":"#/components/schemas/NhlMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/NhlMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/NhlMatchStateResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"NhlHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/1.png"},"title":{"type":"string","example":"NFL: New Orleans Saints vs Kansas City Chiefs"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/v23r23fds2cff"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/v23r23fds2cff"},"match":{"$ref":"#/components/schemas/NhlMatchResponseDto"},"channel":{"type":"string","example":"NHL","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"NhlHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlMatchVenueResponseDto":{"type":"object","properties":{"city":{"type":"string","example":"Sudbury"},"name":{"type":"string","example":"Sudbury Community Arena"},"state":{"type":"string","example":"ON"}},"required":["city","name","state"]},"NhlDetailedMatchRefereesDto":{"type":"object","properties":{"name":{"type":"string","example":"Jonathan Parra"},"position":{"type":"string","example":"Home Plate Umpire"}},"required":["name","position"]},"NhlOverallStatsItemResponseDto":{"type":"object","properties":{"value":{"type":"string","example":"10"},"displayName":{"type":"string","example":"Blocked Shots"}},"required":["value","displayName"]},"NhlTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"logo":{"type":"string","example":"https://example.com/logos/team/1.png"},"name":{"type":"string","example":"Stars"},"displayName":{"type":"string","example":"Dallas Stars"},"abbreviation":{"type":"string","example":"DAL"},"league":{"type":"string","example":"NHL"}},"required":["id","displayName","abbreviation","league"]},"NhlOverallStatsResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlOverallStatsItemResponseDto"}},"team":{"$ref":"#/components/schemas/NhlTeamResponseDto"}},"required":["data","team"]},"NhlDetailedMatchEventDto":{"type":"object","properties":{"type":{"type":"string","example":"Shot"},"clock":{"type":"string","example":"0:32"},"period":{"type":"number","example":1},"isScoringPlay":{"type":"boolean","example":false},"team":{"$ref":"#/components/schemas/NhlTeamResponseDto"}},"required":["type","clock","period","isScoringPlay"]},"NhlDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"number","example":1},"round":{"type":"string","example":"Regular Season - 14"},"date":{"type":"string","example":"2023-05-20T15:30:00.000Z"},"league":{"type":"string","example":"NHL"},"season":{"type":"number","example":2023},"awayTeam":{"$ref":"#/components/schemas/NhlMatchTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/NhlMatchTeamResponseDto"},"state":{"$ref":"#/components/schemas/NhlMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/NhlMatchVenueResponseDto"},"referees":{"type":"array","items":{"$ref":"#/components/schemas/NhlDetailedMatchRefereesDto"}},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"overallStatistics":{"type":"array","items":{"$ref":"#/components/schemas/NhlOverallStatsResponseDto"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/NhlDetailedMatchEventDto"}},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"}},"required":["id","round","date","league","season","awayTeam","homeTeam","state"]},"NhlMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":2.8},"value":{"type":"string","example":"Home"}},"required":["odd","value"]},"NhlMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":1},"bookmakerName":{"type":"string","example":"Stake.com"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Odd or Even"},"values":{"type":"array","items":{"$ref":"#/components/schemas/NhlMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"NhlOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"number","example":1},"odds":{"type":"array","items":{"$ref":"#/components/schemas/NhlMarketResponseDto"}}},"required":["matchId","odds"]},"NhlOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlStandingsTeamResponseDto":{"type":"object","properties":{"id":{"type":"number","example":3},"logo":{"type":"string","example":"https://highlightly.net/nhl/images/teams/1.png"},"name":{"type":"string","example":"Panthers"},"displayName":{"type":"string","example":"Florida Panthers"},"abbreviation":{"type":"string","example":"FLA"}},"required":["id","logo","name","displayName","abbreviation"]},"NhlStatsValueResponseDto":{"type":"object","properties":{"value":{"type":"string","example":"+4"},"displayName":{"type":"string","example":"Differential"}},"required":["value","displayName"]},"NhlTeamStatsResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NhlStandingsTeamResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/NhlStatsValueResponseDto"}}},"required":["team","statistics"]},"NhlStandingsDataResponseDto":{"type":"object","properties":{"leagueName":{"type":"string","example":"Eastern Conference"},"abbreviation":{"type":"string","example":"EAST"},"year":{"type":"number","example":2024},"leagueType":{"type":"string","example":"NHL"},"seasonType":{"type":"string","example":"Regular Season"},"startDate":{"type":"string","example":"2023-10-09T07:00:00.000Z"},"endDate":{"type":"string","example":"2024-04-19T06:59:00.000Z"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlTeamStatsResponseDto"}}},"required":["leagueName","abbreviation","year","leagueType","seasonType","startDate","endDate","data"]},"NhlStandingsResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlStandingsDataResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlTeamTotalGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played during a specific league round.","example":67},"wins":{"type":"number","description":"Number of games team has won during a specific league round.","example":24},"loses":{"type":"number","description":"Number of games team has lost during a specific league round.","example":43}},"required":["played","wins","loses"]},"NhlTeamTotalGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","example":444,"description":"Number of goals a team has scored during a specific league round."},"received":{"type":"number","example":555,"description":"Number of goals a team has received during a specific league round."}},"required":["scored","received"]},"NhlTeamTotalStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round.","allOf":[{"$ref":"#/components/schemas/NhlTeamTotalGameStatsResponseDto"}]},"goals":{"description":"Number of goals a team has scored, and received during a specific league round.","allOf":[{"$ref":"#/components/schemas/NhlTeamTotalGoalsStatsResponseDto"}]}},"required":["games","goals"]},"NhlTeamHomeGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":33},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":13},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":20}},"required":["played","wins","loses"]},"NhlTeamHomeGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals a team has scored whilst playing as home team during a specific league round.","example":122},"received":{"type":"number","description":"Number of goals a team has received whilst playing as home team during a specific league round.","example":54}},"required":["scored","received"]},"NhlTeamHomeStatsResponseDto":{"type":"object","properties":{"games":{"description":"Number of games team has played, won, and lost during a specific league round, whilst playing as home team.","allOf":[{"$ref":"#/components/schemas/NhlTeamHomeGameStatsResponseDto"}]},"goals":{"description":"Number of goals a team has scored and received, during a specific league round, whilst playing as away team.","allOf":[{"$ref":"#/components/schemas/NhlTeamHomeGoalsStatsResponseDto"}]}},"required":["games","goals"]},"NhlTeamAwayGameStatsResponseDto":{"type":"object","properties":{"played":{"type":"number","description":"Number of games team has played as home team during a specific league round.","example":34},"wins":{"type":"number","description":"Number of games team has won as home team during a specific league round.","example":11},"loses":{"type":"number","description":"Number of games team has lost as home team during a specific league round.","example":23}},"required":["played","wins","loses"]},"NhlTeamAwayGoalsStatsResponseDto":{"type":"object","properties":{"scored":{"type":"number","description":"Number of goals a team has scored as away team, during a specific league round.","example":133},"received":{"type":"number","description":"Number of goals a team has received as away team, during a specific league round.","example":111}},"required":["scored","received"]},"NhlTeamAwayStatsResponseDto":{"type":"object","properties":{"games":{"description":"Game related statistics team has played as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/NhlTeamAwayGameStatsResponseDto"}]},"goals":{"description":"Number of goals a team has scored and received as away team, during a specific league round.","allOf":[{"$ref":"#/components/schemas/NhlTeamAwayGoalsStatsResponseDto"}]}},"required":["games","goals"]},"NhlTeamStatisticsResponseDto":{"type":"object","properties":{"total":{"description":"Total game and goals statistics corresponding to specific league round.","allOf":[{"$ref":"#/components/schemas/NhlTeamTotalStatsResponseDto"}]},"home":{"description":"Game and goal statistics corresponding to specific league round, where the team has played as a home team.","allOf":[{"$ref":"#/components/schemas/NhlTeamHomeStatsResponseDto"}]},"away":{"description":"Game and goal statistics corresponding to specific league round, where the team has played as an away team.","allOf":[{"$ref":"#/components/schemas/NhlTeamAwayStatsResponseDto"}]},"leagueName":{"type":"string","example":"NHL","description":"League name to which team statistics are associated."},"round":{"type":"string","example":"regular-season","description":"Round to which team statistics are associated."}},"required":["total","home","away","leagueName","round"]},"NhlLineupsPlayerDto":{"type":"object","properties":{"id":{"type":"number","example":74958347},"jersey":{"type":"number","example":14},"player":{"type":"string","example":"B. Kramer"},"position":{"type":"string","example":"Defense"},"positionAbbreviation":{"type":"string","example":"D"},"isScratched":{"type":"boolean","example":false}},"required":["id","player","position","positionAbbreviation"]},"NhlLineupsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/NhlTeamResponseDto"},"lineup":{"type":"array","items":{"$ref":"#/components/schemas/NhlLineupsPlayerDto"}}},"required":["team","lineup"]},"NhlLineupsResponseDto":{"type":"object","properties":{"home":{"$ref":"#/components/schemas/NhlLineupsDto"},"away":{"$ref":"#/components/schemas/NhlLineupsDto"}},"required":["home","away"]},"NhlNcaaPlayerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58504952},"fullName":{"type":"string","example":"Colin White"},"logo":{"type":"string"}},"required":["id"]},"NhlNcaaPlayerPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NhlNcaaPlayerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"NhlNcaaDetailedPlayerSummaryPositionDto":{"type":"object","properties":{"main":{"type":"string","example":"Center"},"abbreviation":{"type":"string","example":"C"}}},"NhlNcaaDetailedPlayerSummaryDraftDto":{"type":"object","properties":{"round":{"type":"number","example":1},"year":{"type":"number","example":2015},"pick":{"type":"number","example":21}}},"NhlNcaaDetailedPlayerSummaryTeamDto":{"type":"object","properties":{"id":{"type":"number","example":20},"logo":{"type":"string","example":"https://highlightly.net/nhl/images/teams/20.png"},"name":{"type":"string","example":"Senators"},"league":{"type":"string","example":"NHL"},"displayName":{"type":"string","example":"Ottawa Senators"},"abbreviation":{"type":"string","example":"OTT"}},"required":["id","name","league","displayName","abbreviation"]},"NhlNcaaDetailedPlayerSummaryProfileDto":{"type":"object","properties":{"fullName":{"type":"string","example":"Bryan Berard"},"birthPlace":{"type":"string","example":"Boston, MA, USA"},"birthDate":{"type":"string","description":"DD.MM.YYYY format","example":"30.01.1997"},"height":{"type":"string","example":"5' 11\""},"jersey":{"type":"string","example":"16"},"weight":{"type":"string","example":"191 lbs"},"isActive":{"type":"boolean","example":true},"position":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryPositionDto"},"draft":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryDraftDto"},"team":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryTeamDto"}},"required":["position","draft","team"]},"NhlNcaaDetailedPlayerSummaryResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58504952},"fullName":{"type":"string","example":"Colin White"},"logo":{"type":"string"},"profile":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryProfileDto"}},"required":["id"]},"NhlNcaaStatEntry":{"type":"object","properties":{"name":{"type":"string","example":"Total Assists"},"value":{"type":"number","example":7},"category":{"type":"string","enum":["General","Defense","Offense","Penalties"],"example":"Offense"}},"required":["name","value","category"]},"NhlNcaaDetailedPlayerStatisticsPerSeasonDto":{"type":"object","properties":{"stats":{"description":"Relevant stats for player position.","type":"array","items":{"$ref":"#/components/schemas/NhlNcaaStatEntry"}},"teams":{"description":"Teams for which the player played in a given season.","type":"array","items":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerSummaryTeamDto"}},"league":{"type":"string","example":"Nhl"},"season":{"type":"number","example":2022},"seasonBreakdown":{"type":"string","enum":["Entire","Season"],"example":"Entire","description":"Represents the coverage for the stored statistics. Pre-season is never included."}},"required":["stats","teams","league","season","seasonBreakdown"]},"NhlNcaaDetailedPlayerStatisticsResponseDto":{"type":"object","properties":{"id":{"type":"number","example":58504952},"fullName":{"type":"string","example":"Colin White"},"logo":{"type":"string"},"perSeason":{"type":"array","items":{"$ref":"#/components/schemas/NhlNcaaDetailedPlayerStatisticsPerSeasonDto"}}},"required":["id","perSeason"]}}}}