{"openapi":"3.0.0","paths":{"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}},"/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":"nfl-ncaa-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"]}}},"info":{"title":"NFL & NCAA API Documentation","description":"The Highlightly NFL & NCAA API provides real-time American football data including live scores, video highlights, game statistics, player profiles and stats, depth charts, standings, predictions, and live play-by-play events. Covers NFL preseason, regular season, playoffs, and championship games plus NCAA FBS.\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/nfl-ncaa-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/nfl-ncaa-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://american-football.highlightly.net`\n\n> RapidAPI API base url: `https://nfl-ncaa-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` | `nfl-ncaa-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":"8.2.2","contact":{}},"tags":[{"name":"NFL, NCAA API","description":""}],"servers":[{"url":"https://american-football.highlightly.net"},{"url":"https://nfl-ncaa-highlights-api.p.rapidapi.com"}],"components":{"schemas":{"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"]},"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"]},"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"]},"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"]},"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"]},"DetailedMatchForecastResponseDto":{"type":"object","properties":{"status":{"type":"string","example":"cloudy"},"temperature":{"type":"string","example":"11.97°C"}}},"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"]},"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"]},"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"]},"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"]},"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"]}}}}