{"openapi":"3.0.0","paths":{"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}},"/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":"basketball-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"]}}},"info":{"title":"Basketball API Documentation","description":"The Highlightly Basketball API provides real-time basketball data including live scores with quarter-by-quarter breakdowns, video highlights, team statistics, standings, predictions, head-to-head data, and last five games across 340+ leagues including Euroleague, ACB, BBL, LNB, Lega A, NBL, CBA, FIBA World Cup, and WNBA.\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/basketball-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/basketball-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://basketball.highlightly.net`\n\n> RapidAPI API base url: `https://basketball-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` | `basketball-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":"7.2.4","contact":{}},"tags":[],"servers":[{"url":"https://basketball.highlightly.net"},{"url":"https://basketball-highlights-api.p.rapidapi.com"}],"components":{"schemas":{"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"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"]},"NotFoundDto":{"type":"object","properties":{"message":{"type":"string","example":"Not Found"},"statusCode":{"type":"number","example":404}},"required":["message","statusCode"]}}}}