{"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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketCountryResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all countries","tags":["Cricket.Countries"]}},"/countries/{countryCode}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve associated country details by specifying the country code path parameter. The path parameter should follow the `ISO 3166` standard.\n    \nCountry name and code can be used to query other resources such as `matches`, `leagues`, `highlights`, etc.","operationId":"CountriesController_getCountryById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"countryCode","required":true,"in":"path","description":"A string value code of the country, following the ISO 3166 standard.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketCountryQueryParamDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get country by country code","tags":["Cricket.Countries"]}},"/highlights":{"get":{"description":"> Refresh interval: Once a minute\n\n> Note: Certain highlights might be uploaded whilst the game is playing. Full game recaps tend to be uploaded anywhere from 1 to 48 hours after a match is finished.\n\n  Highlights represent the core of our API. They include various different kinds of clips ranging from real time live events such as insane plays, last minute scores to full game recaps, pre/post match interviews. \n\nCurrently we aggregate videos from many different sources. Depending on the source and verification process we divide the clips into two categories:\n\n| Type        | Description |\n| ----------- | ----------- |\n| VERIFIED    | Videos come from reputable sources that have been thoroughly inspected. In most cases the clips are from official authors who own the copyrights to the video itself. The hosting platform can impose geo restrictions or prevent direct embedding (`highlights/geo-restrictions/{highlightId}` route can be used to check for potential restrictions). Verified highlights are uploaded anywhere from 1 to 48 hours of the match being finished. |\n| UNVERIFIED  | Highlights vary and might not have gone through the verification process or are considered user uploaded. Videos include a wide spectrum of topics such as last minute scores, memorable plays, game recaps, etc. Unverified highlights are considered more real time and might be uploaded even when the match is still being played. The lifetime of these clips vary and is dependant on the hosting platform.       |\n\nEach highlight has a `title` which describes what the video is about. Certain entries will have a `description` as well which is used to further describe the associated clip. The `source` field defines where the clip was aggregated from (e.g. would be *youtube*, *twitter*, *reddit*, *espn*, etc.). For certain sources you will see additional information being present in the `channel` field. By utilising this information you can further narrow down which videos you want to showcase. Highlights might also have an `embedUrl` property which is used to directly embed the videos into your website or mobile application.\n\nEach highlight also has a `category` field which describes the type of content the clip contains. Categorization happens automatically when a highlight is aggregated. Clips that cannot be confidently placed are labeled `other` rather than being forced into a category they do not belong to, so filtering by a specific category will not return unrelated content.\n\n### Categories\n\nEach highlight has a `category` field describing the clip's content type. Possible values for this sport:\n\n| Category | Description |\n| -------- | ----------- |\n| `match-highlights` | Edited recap of a match (full-game highlights, summaries in any language). |\n| `innings-highlights` | Highlights of a single innings. |\n| `full-match-replay` | Complete match replay, unedited. |\n| `live-coverage` | Raw live streams (warm-ups, watch-alongs), as opposed to edited recaps. |\n| `batting-highlight` | Centuries, fifties and batting performances. |\n| `bowling-highlight` | Wickets, spells and bowling performances. |\n| `six-boundary` | Sixes and boundary compilations. |\n| `catch-fielding` | Catches, run-outs and fielding plays. |\n| `toss` | The coin toss. |\n| `pre-match-content` | Previews, predictions and build-up content ahead of a match. |\n| `post-match-content` | Reactions, interviews and analysis after a match. |\n| `other` | Clips that do not fit any other category. |\n\nBelow is an example of what you can aim to achieve with our highlights data:\n\n![Highlights example](https://highlightly.net/assets/img/documentation/cricket/highlights.png)\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/cricket-highlights-api).\n","operationId":"HighlightsController_getHighlights","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48513362,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-01-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"example":48514657,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":17838627,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":17838662,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Melbourne Renegades","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":40,"default":40,"example":40,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"MR","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketHighlightPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all highlights","tags":["Cricket.Highlights"]}},"/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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get geo restrictions for highlight","tags":["Cricket.Highlights"]}},"/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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested highlight id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketHighlightResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get highlight by id","tags":["Cricket.Highlights"]}},"/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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"season","in":"query","schema":{"minimum":0,"example":2023,"type":"number"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"description":"Country code specified by the ISO 3166 standard.","required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketLeaguePaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all leagues","tags":["Cricket.Leagues"]}},"/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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested league id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketLeagueResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get league by id","tags":["Cricket.Leagues"]}},"/matches":{"get":{"description":"> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State        | Description |\n| -----------  | ----------- |\n| Finished  | Match has been concluded.          |\n| Unknown  | The status of the match is not known.         |\n| No live coverage |  There is no live coverage for the match. |\n| In play | The match is currently in progress. |\n| Stumps | The end of a day's play in a multi-day match (e.g. Test match). |\n| Lunch | The break taken during lunch time in a match. |\n| Innings break | The interval between the end of one innings and the start of the next. |\n| Drinks | A short break for players to have drinks. |\n| Timeout | A strategic break taken during the match. |\n| Tea | The break taken during tea time in a match, typically in Test matches. |\n| Scheduled    |  The match is planned and scheduled to be played.        |\n| Match delayed  | The match start or continuation is delayed, often due to weather or other interruptions.           |\n| Cancelled  |  The match has been cancelled and will not be played.        |\n| Postponed  | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future.           |\n| Abandoned  | \tThe match has started but is stopped and will not continue, typically due to weather or other uncontrollable circumstances.  |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n![Cricket matches example](https://highlightly.net/assets/img/documentation/cricket/matches.png)","operationId":"MatchesController_getMatches","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"example":"Big Bash League","type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"example":48513362,"type":"number"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"example":"2024-01-13","type":"string"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"season","in":"query","schema":{"example":2023,"type":"number"}},{"required":false,"name":"homeTeamId","in":"query","schema":{"example":17838627,"type":"number"}},{"required":false,"name":"awayTeamId","in":"query","schema":{"example":17838662,"type":"number"}},{"required":false,"name":"homeTeamName","in":"query","schema":{"example":"Melbourne Renegades","type":"string"}},{"required":false,"name":"awayTeamName","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"countryCode","in":"query","schema":{"example":"AU","type":"string"}},{"required":false,"name":"countryName","in":"query","schema":{"example":"Australia","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":100,"example":100,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"homeTeamAbbreviation","in":"query","schema":{"example":"MR","type":"string"}},{"required":false,"name":"awayTeamAbbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketMatchPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all matches","tags":["Cricket.Matches"]}},"/matches/{id}":{"get":{"description":"\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will include additional details such as venue information, weather forecast, predictions, statistics, squad data, and top player performances (best batsmen, best bowlers, and in play data).\n\n> Note: Used to retrieve additional match information.\n","operationId":"MatchesController_getMatchById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested match id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketDetailedMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get match by id","tags":["Cricket.Matches"]}},"/teams":{"get":{"description":"Retrieve a list of teams that are supported by the API.\n\nBy utilising either the `name` or `abbreviation` query parameter you can check whether a specific team exists or simply retrieve the associated data.\n\nThere are two other important query parameters. The `limit` parameter defines what the number of returned teams will be. If the number of actual teams is above the `limit` value you can make subsequent requests by increasing the `offset` value.\n","operationId":"TeamsController_getTeams","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":500,"default":500,"example":50,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"name","in":"query","schema":{"example":"Melbourne Stars","type":"string"}},{"required":false,"name":"abbreviation","in":"query","schema":{"example":"MS","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketTeamPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all teams","tags":["Cricket.Teams"]}},"/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":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested team id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketTeamResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get team by team id","tags":["Cricket.Teams"]}},"/bookmakers":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve a list of supported bookmakers. \n\nThere are two important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned bookmakers will be. If the number of actual bookmakers is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nThe bookmakers `name` or `id` can be used to filter data from the `odds` endpoint. ","operationId":"CricketBookmakersController_getBookmakers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"22Bet","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":100,"default":20,"example":20,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketBookmakersPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all bookmakers","tags":["Cricket.Bookmakers"]}},"/bookmakers/{id}":{"get":{"description":"\nRetrieve bookmaker information by specifying the bookmaker id path parameter.\n\n> Note: Used to check whether a bookmaker still exists or had its information updated.\n","operationId":"CricketBookmakersController_getBookmakerById","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested bookmaker id.","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketBookmakerResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get bookmaker by id","tags":["Cricket.Bookmakers"]}},"/odds":{"get":{"description":"\n> Prematch odds refresh interval: Multiple times a day\n \n> Live odds refresh interval: Once every 10 minutes\n \n> Note: Endpoint is not available in the Basic/Free plan.\n\nRetrieve a list of match odds based on the requested query parameters. With `oddsType` query parameter you can specify whether you want **prematch** or **live** odds. If you do not set a specific value **prematch** odds will be returned.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset`, `oddsType` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home` or `Away`. |\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 376.5 \"*, *\"Over/Under 378.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n\nThere are two other important query parameters. The `limit` parameter defines what the number of returned match odds will be. If the number of actual match odds is above the `limit` value you can make subsequent requests by increasing the `offset` value.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n![Odds example](https://highlightly.net/assets/img/documentation/odds-ha.png)","operationId":"CricketOddsController_getOddsV2","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"description":"Defines whether live or prematch odds will be returned.","required":false,"name":"oddsType","in":"query","schema":{"example":"prematch","type":"string"}},{"required":false,"name":"leagueName","in":"query","schema":{"type":"string"}},{"required":false,"name":"leagueId","in":"query","schema":{"type":"number"}},{"description":"Valid timezone identifier.","required":false,"name":"timezone","in":"query","schema":{"default":"Etc/UTC","example":"Europe/London","type":"string"}},{"required":false,"name":"bookmakerId","in":"query","schema":{"example":3,"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":5,"default":5,"example":5,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"matchId","in":"query","schema":{"type":"number"}},{"required":false,"name":"bookmakerName","in":"query","schema":{"example":"22Bet","type":"string"}},{"description":"Date that follows the YYYY-MM-DD format.","required":false,"name":"date","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketOddsPaginatedResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all odds","tags":["Cricket.Odds"]}},"/last-five-games":{"get":{"description":"> Refresh interval: Immediately once a game is considered finished\n\nRetrieve a list of the **last five finished** games for a specific team. If a game was not finished (e.g. was cancelled or postponed) it will *not* be returned.\n\nSpecify `teamId` query parameter to retrieve the data. Endpoint is used to create a form section between two teams that are playing a match. Below is an example of what can be achieved:\n\n![Last five games example](https://highlightly.net/assets/img/documentation/l5g.png)","operationId":"CricketLastFiveGamesController_getLastFiveGames","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamId","in":"query","required":true,"schema":{"example":17838662,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get last five finished games for a specific team id","tags":["Cricket.Last Five Games"]}},"/head-2-head":{"get":{"description":"Retrieve a list of the **last ten** head 2 head games between two teams. Compare the two teams to find out who is stronger based on their past match results. \n\nSpecify `teamIdOne` and `teamIdTwo` query parameters to retrieve the data. The order of team ids does not matter.\n\nBelow is an example of what you can achieve with the data:\n\n![H2H example](https://highlightly.net/assets/img/documentation/cricket/h2h.png)","operationId":"CricketHead2HeadController_getHead2HeadData","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"teamIdOne","in":"query","required":true,"schema":{"example":17838627,"type":"number"}},{"name":"teamIdTwo","in":"query","required":true,"schema":{"example":17838662,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get head 2 head games","tags":["Cricket.Head 2 Head"]}},"/standings":{"get":{"description":"> Refresh interval: Up to an hour after a match for the associated league and season is finished\n\nRetrieve standings data for a specific league, conference or division.\n\nEndpoint requires both `leagueId` and `season` query parameters to be specified before you can fetch the data. \n\nBelow is an example on how you could render league associated standings\n\n![Standings example](https://highlightly.net/assets/img/documentation/cricket/standings.png)","operationId":"CricketStandingsController_getStandings","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"leagueId","in":"query","required":true,"schema":{"example":50036737,"type":"number"}},{"name":"season","in":"query","required":true,"schema":{"example":2024,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CricketStandingsResponseDto"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get standings","tags":["Cricket.Standings"]}},"/players":{"get":{"description":"> Refresh interval: Once a day\n\n> This endpoint returns only general player information. For detailed career statistics use the dedicated player detail endpoints.\n\nRetrieve a list of cricket players based on the requested query parameters.\n\nReturned results are paginated. The `limit` parameter specifies the maximum number of players returned in a single response. If the total number of matching players exceeds the specified `limit`, additional results can be retrieved by increasing the `offset` parameter.\n\nEach player record contains basic profile information, including:\n\n| Field | Description |\n| ------- | ----------- |\n| ID | Unique identifier of the player. |\n| Long name | Full name of the player. |\n| Gender | Gender of the player. |\n| Date of birth | Player's date of birth represented as a Unix timestamp in milliseconds. |\n| Batting styles | Short-form batting style codes associated with the player (e.g. `rhb`, `lhb`). |\n| Bowling styles | Short-form bowling style codes associated with the player. |\n| Long batting styles | Human-readable descriptions of the player's batting styles. |\n| Long bowling styles | Human-readable descriptions of the player's bowling styles. |\n| Teams | List of teams the player has been associated with. Each team entry includes: `id`, `abbreviation`, `logo`, and `isCurrent` flag indicating whether the player is currently part of the team. |\n\nThe `teams` field structure:\n\n- **id**: Unique identifier of the team  \n- **abbreviation**: Short code/name of the team (e.g. SL, RCB, MI)  \n- **logo**: URL to the team's logo image (can be null)  \n- **isCurrent**: Boolean indicating whether the player currently represents the team  \n\nThis endpoint is useful for player discovery, search functionality, and obtaining basic player profile information before requesting more detailed player-specific data.","operationId":"CricketPlayersController_getPlayers","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"required":false,"name":"name","in":"query","schema":{"example":"Virat Kohli","type":"string"}},{"required":false,"name":"limit","in":"query","schema":{"minimum":0,"maximum":1000,"default":1000,"example":1000,"type":"number"}},{"required":false,"name":"offset","in":"query","schema":{"minimum":0,"default":0,"example":0,"type":"number"}},{"required":false,"name":"teamId","in":"query","schema":{"example":422,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePlayerInfoResponseMD"}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get all players","tags":["Cricket.Players"]}},"/players/{id}":{"get":{"description":"> Refresh interval: Once a day\n\nRetrieve detailed player summary by specifying the player `id` path parameter.\n\nDetailed player summary consists of the following information:\n\n| Type     | Description |\n| -------- | ----------- |\n| Profile  | Provides a structured summary of a cricket player's personal and professional profile. It includes key details such as full name, date of birth, batting style (e.g. right-hand bat), and bowling style (e.g. right-arm medium). The data offers a high-level overview of the player's identity and playing characteristics, useful for profile display, comparison, or scouting purposes. |\n| Summary  | Contains a comprehensive year-by-year statistical breakdown of a cricket player's career across all international formats (Tests, ODIs, T20Is). For each format and season, the summary is divided into batting, bowling, and fielding sections. Batting statistics include matches, innings, runs, fours, sixes, fifties, hundreds, balls faced, ducks, not outs, high score, batting average, and strike rate. Bowling statistics include matches, innings, overs, runs conceded, maidens, wickets, four- and five-wicket hauls, bowling average, economy rate, and bowling strike rate. Fielding statistics include matches, innings, dismissals, catches, stumpings, catches as wicketkeeper, catches as fielder, max dismissals in an innings, and dismissals per innings. This data enables detailed performance analysis across formats and seasons, supporting trend identification, form evaluation, and historical comparisons throughout the player's career. |\n","operationId":"CricketPlayersController_getPlayerStatistics","parameters":[{"name":"x-rapidapi-host","in":"header","description":"cricket-highlights-api.p.rapidapi.com","required":true,"schema":{"type":"string"}},{"name":"x-rapidapi-key","in":"header","description":"Rapid API Token","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Requested player id.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DetailedPlayerInfoResponseMD"}}}}},"400":{"description":"Bad request descriptive error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestDto"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDto"}}}}},"summary":"Get player summary by player id","tags":["Cricket.Players"]}}},"info":{"title":"Cricket API Documentation","description":"The Highlightly Cricket API provides real-time cricket data including live scores with scorecards, video highlights, standings, head-to-head data, and last five games across 900+ leagues and tournaments in 80+ countries. Covers ICC World Cup, T20 World Cup, IPL, Big Bash, CPL, PSL, The Hundred, SA20, County Championship, and women's cricket across Test, ODI, and T20 formats.\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/cricket-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/cricket-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://cricket.highlightly.net`\n\n> RapidAPI API base url: `https://cricket-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` | `cricket-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.0.2","contact":{}},"tags":[{"name":"Cricket API","description":""}],"servers":[{"url":"https://cricket.highlightly.net"},{"url":"https://cricket-highlights-api.p.rapidapi.com"}],"components":{"schemas":{"CricketCountryResponseDto":{"type":"object","properties":{"code":{"type":"string","description":"Country code specified by the ISO 3166 standard.","example":"AU"},"name":{"type":"string","example":"Australia"},"logo":{"type":"string","example":"https://example.com/logos/country/AU.png"}},"required":["code","name","logo"]},"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"]},"CricketCountryQueryParamDto":{"type":"object","properties":{"name":{"type":"string","example":"Australia"}}},"CricketTeamResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"17838627"},"logo":{"type":"string","example":"https://example.com/logos/team/17838627.png"},"name":{"type":"string","example":"Melbourne Stars"},"abbreviation":{"type":"string","example":"MS"}},"required":["id","name","abbreviation"]},"CricketMatchLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48513362"},"season":{"type":"number","example":2023},"name":{"type":"string","example":"Big Bash League"},"logo":{"type":"string","example":"https://example.com/logos/league/48513362.png"}},"required":["id","season","name"]},"CricketMatchScoreTeamAwayDto":{"type":"object","properties":{"info":{"type":"string","example":"17.2/20 ov, T:138"},"score":{"type":"string","example":"139/4"}}},"CricketMatchScoreTeamHomeDto":{"type":"object","properties":{"info":{"type":"string","example":null},"score":{"type":"string","example":"137/8"}}},"CricketMatchScoreTeamsDto":{"type":"object","properties":{"away":{"$ref":"#/components/schemas/CricketMatchScoreTeamAwayDto"},"home":{"$ref":"#/components/schemas/CricketMatchScoreTeamHomeDto"}},"required":["away","home"]},"CricketMatchStateResponseDto":{"type":"object","properties":{"description":{"type":"string","enum":["Finished","Unknown","No live coverage","In play","Stumps","Lunch","Innings break","Drinks","Timeout","Tea","Scheduled","Match delayed","Cancelled","Abandoned","Postponed"],"example":"Finished","description":"State of the match."},"report":{"type":"string","example":"Renegades won by 6 wickets (with 16 balls remaining)","description":"Descriptive report of the match based on the match status."},"teams":{"$ref":"#/components/schemas/CricketMatchScoreTeamsDto"}},"required":["description","teams"]},"CricketMatchResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48514657"},"endDate":{"type":"string","example":"2024-01-13T00:00:00.000Z"},"startDate":{"type":"string","example":"2024-01-13T00:00:00.000Z"},"startTime":{"type":"string","example":"2024-01-13T14:30:00.000Z"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"league":{"$ref":"#/components/schemas/CricketMatchLeagueResponseDto"},"format":{"type":"string","example":"T20","description":"Cricket match format, e.g. T20, ODI, TEST"},"dayType":{"type":"string","enum":["SINGLE","MULTI"],"example":"SINGLE","description":"Information that tells us whether the match will be played across multiple days"},"state":{"$ref":"#/components/schemas/CricketMatchStateResponseDto"}},"required":["id","endDate","startDate","country","awayTeam","homeTeam","league","state"]},"CricketHighlightResponseDto":{"type":"object","properties":{"id":{"type":"number","example":75},"type":{"type":"string","example":"VERIFIED"},"imgUrl":{"type":"string","description":"Preview picture of the highlight.","example":"https://example.com/images/preview/75.png"},"title":{"type":"string","example":"Big Bash League: Melbourne Renegades vs Melbourne Stars"},"description":{"type":"string","example":"Game recap of the match."},"url":{"type":"string","description":"Url location of the video highlight.","example":"https://example.com/highlight/213123safas132e"},"embedUrl":{"type":"string","description":"Url of embeddable video highlight.","example":"https://example.com/embed/213123safas132e"},"match":{"$ref":"#/components/schemas/CricketMatchResponseDto"},"channel":{"type":"string","example":"Ligue 1 Uber Eats","description":"Channel title of a given highlight."},"source":{"type":"string","example":"youtube","description":"Aggregation source from social media and other equivalent platforms."},"category":{"type":"string","example":"match-highlights","description":"Assumed highlight category"}},"required":["id","type","title","url","match"]},"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"]},"CricketHighlightPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketHighlightResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"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"]},"CricketSeasonResponseDto":{"type":"object","properties":{"season":{"type":"number","example":2023}},"required":["season"]},"CricketLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"48513362"},"logo":{"type":"string","example":"https://example.com/logos/league/1635.png"},"name":{"type":"string","example":"Big Bash League"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/CricketSeasonResponseDto"}}},"required":["id","name","country","seasons"]},"CricketLeaguePaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketLeagueResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketMatchPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketMatchResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"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"}}},"FieldingSummary":{"type":"object","properties":{"catches":{"type":"number","description":"Catches taken by fielding team","example":6},"catchesDropped":{"type":"number","description":"Catches dropped by fielding team","example":2},"runsSaved":{"type":"number","description":"Runs saved by fielding team","example":3},"runOuts":{"type":"number","description":"Run outs effected","example":1},"stumpings":{"type":"number","description":"Stumpings effected","example":0}}},"DismissalBatsman":{"type":"object","properties":{"name":{"type":"string","description":"Name of Dismissal Batsman","example":"Ryan Rickelton"}}},"FallOfWickets":{"type":"object","properties":{"runs":{"type":"number","example":5,"description":"Number of runs"},"order":{"type":"number","example":1,"description":"Current order number"},"overs":{"type":"number","example":1.2,"description":"Number of overs"},"dismissalBatsman":{"$ref":"#/components/schemas/DismissalBatsman"}}},"DismissalFielder":{"type":"object","properties":{"name":{"type":"string","description":"Name of the fielder","example":"Jos Buttler"},"isKeeper":{"type":"boolean","description":"Whether the fielder is the wicketkeeper","example":true},"isSubstitute":{"type":"boolean","description":"Whether the fielder is a substitute","example":false}}},"CricketBasePlayerStatsDataResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}}}},"InningBatsmen":{"type":"object","properties":{"runs":{"type":"number","example":4,"description":"Number of runs"},"balls":{"type":"number","example":5,"description":"Number of balls"},"fours":{"type":"number","example":0,"description":"Number of fours"},"sixes":{"type":"number","example":0,"description":"Number of sixes"},"battingStrikeRate":{"type":"number","example":90,"description":"Batting strike rate"},"dismissalStatus":{"type":"string","description":"Dismissal status","example":"caught"},"dismissalFielders":{"description":"Fielders involved in the dismissal","type":"array","items":{"$ref":"#/components/schemas/DismissalFielder"}},"player":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"}}},"InningBowlers":{"type":"object","properties":{"overs":{"type":"number","example":4,"description":"Number of overs"},"player":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"economy":{"type":"number","example":5.5,"description":"Economy statistics"},"maidens":{"type":"number","example":0,"description":"Number of maidens"},"wickets":{"type":"number","example":1,"description":"Number of wickets"},"concededRuns":{"type":"number","example":2,"description":"Number of conceded runs"}}},"InningPartnerships":{"type":"object","properties":{"runs":{"type":"number","example":5,"description":"Number of runs"},"balls":{"type":"number","example":8,"description":"Number of balls"},"overs":{"type":"number","example":1.2,"description":"Number of overs"},"firstPlayer":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"secondPlayer":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"},"firstPlayerRuns":{"type":"number","example":1,"description":"Number of runs related to first player"},"firstPlayerBalls":{"type":"number","example":3,"description":"Number of balls related to fist player"},"secondPlayerRuns":{"type":"number","example":3,"description":"Number of runs related to second player"},"secondPlayerBalls":{"type":"number","example":5,"description":"Number of balls related to second player"}}},"CricketDetailedMatchStatisticsDataDto":{"type":"object","properties":{"id":{"type":"number","description":"Cricket team id","example":282},"logo":{"type":"string","description":"Cricket team logo url","example":"https://highlightly.net/cricket/images/teams/282.png"},"name":{"type":"number","description":"Cricket team name","example":"West Indies"},"abbreviation":{"type":"string","description":"Cricket team abbreviation","example":"WI"},"inningNumber":{"type":"number","description":"Inning number","example":1},"fours":{"type":"number","description":"Total fours in the innings","example":15},"sixes":{"type":"number","description":"Total sixes in the innings","example":9},"extras":{"type":"number","description":"Total extras in the innings","example":12},"byes":{"type":"number","description":"Byes conceded","example":2},"legByes":{"type":"number","description":"Leg byes conceded","example":4},"wides":{"type":"number","description":"Wides bowled","example":5},"noBalls":{"type":"number","description":"No balls bowled","example":1},"fieldingSummary":{"$ref":"#/components/schemas/FieldingSummary"},"fallOfWickets":{"type":"array","items":{"$ref":"#/components/schemas/FallOfWickets"}},"inningBatsmen":{"type":"array","items":{"$ref":"#/components/schemas/InningBatsmen"}},"inningBowlers":{"type":"array","items":{"$ref":"#/components/schemas/InningBowlers"}},"inningPartnerships":{"type":"array","items":{"$ref":"#/components/schemas/InningPartnerships"}}},"required":["id","name","abbreviation"]},"CricketBaseTeamDataResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Cricket team id","example":282},"logo":{"type":"string","description":"Cricket team logo url","example":"https://highlightly.net/cricket/images/teams/282.png"},"name":{"type":"number","description":"Cricket team name","example":"West Indies"},"abbreviation":{"type":"string","description":"Cricket team abbreviation","example":"WI"}},"required":["id","name","abbreviation"]},"CricketSquadResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBasePlayerStatsDataResponseDto"}}}},"CricketBestBatsmenStatsResponseDto":{"type":"object","properties":{"runs":{"type":"number","example":220,"description":"Number of runs"},"average":{"type":"number","example":36.6667,"description":"Batting average stats"},"innings":{"type":"number","example":9,"description":"Total number of innings"},"matches":{"type":"number","example":10,"description":"Total number of matches"},"battingStrikeRate":{"type":"number","example":126.43,"description":"Total batting strike rate"}}},"CricketBestBatsmenStatisticsResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/CricketBestBatsmenStatsResponseDto"}}},"CricketBestBatsmenResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBatsmenStatisticsResponseDto"}}}},"CricketBestBowlerRawStatsDto":{"type":"object","properties":{"balls":{"type":"number","example":126,"description":"Number of balls"},"average":{"type":"number","example":21.29,"description":"Bowling average"},"economy":{"type":"number","example":7.1,"description":"Players economy rate"},"innings":{"type":"number","example":6,"description":"Number of innings"},"matches":{"type":"number","example":6,"description":"Number of matches"},"wickets":{"type":"number","example":7,"description":"Number of wickets"},"concededRuns":{"type":"number","example":149,"description":"Number of conceded runs"},"battingStrikeRate":{"type":"number","example":18,"description":"Batting strike rate"}}},"CricketBestBowlerStatsResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Player name","example":"Ryan Rickelton"},"battingStyles":{"description":"Players batting styles","type":"array","items":{"type":"string"}},"bowlingStyles":{"description":"Players bowling styles","type":"array","items":{"type":"string"}},"roles":{"description":"Players roles","type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/CricketBestBowlerRawStatsDto"}}},"CricketBestBowlersResponseDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketBaseTeamDataResponseDto"},"players":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBowlerStatsResponseDto"}}}},"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"]},"TeamInfo":{"type":"object","properties":{"id":{"type":"string","example":"11759092"},"logo":{"type":"string","example":"https://highlightly.net/cricket/images/teams/11759092.png"},"name":{"type":"string","example":"Royal Challengers Bangalore"},"abbreviation":{"type":"string","example":"RCB"}},"required":["id","name"]},"BowlerStats":{"type":"object","properties":{"overs":{"type":"number","example":2.1},"balls":{"type":"number","example":13},"runsConceded":{"type":"number","example":21},"wickets":{"type":"number","example":0},"economy":{"type":"number","example":9.69}}},"BowlerPlayerLivePerformanceInfo":{"type":"object","properties":{"name":{"type":"string","example":"Rasikh Salam"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"roles":{"example":["bowler"],"type":"array","items":{"type":"string"}},"statistics":{"$ref":"#/components/schemas/BowlerStats"}},"required":["name","battingStyles","bowlingStyles","roles","statistics"]},"BolwerData":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamInfo"},"player":{"$ref":"#/components/schemas/BowlerPlayerLivePerformanceInfo"}},"required":["team","player"]},"BastmenStats":{"type":"object","properties":{"runs":{"type":"number","example":17},"balls":{"type":"number","example":8},"fours":{"type":"number","example":0},"sixes":{"type":"number","example":6},"strikeRate":{"type":"number","example":212.5}}},"BatsmenPlayerLivePerformanceInfo":{"type":"object","properties":{"name":{"type":"string","example":"Sherfane Rutherford"},"battingStyles":{"example":["lhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rfm"],"type":"array","items":{"type":"string"}},"roles":{"example":["middle-order batter"],"type":"array","items":{"type":"string"}},"inning":{"type":"number","example":2},"statistics":{"$ref":"#/components/schemas/BastmenStats"}},"required":["name","battingStyles","bowlingStyles","roles","inning","statistics"]},"BatsmenData":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamInfo"},"player":{"$ref":"#/components/schemas/BatsmenPlayerLivePerformanceInfo"}},"required":["team"]},"CricketInplayResponseDto":{"type":"object","properties":{"bowlers":{"type":"array","items":{"$ref":"#/components/schemas/BolwerData"}},"batsmen":{"type":"array","items":{"$ref":"#/components/schemas/BatsmenData"}}},"required":["bowlers","batsmen"]},"CricketDetailedMatchResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"49877382"},"endDate":{"type":"string","example":"2024-03-31T00:00:00.000Z"},"startDate":{"type":"string","example":"2024-03-31T00:00:00.000Z"},"startTime":{"type":"string","example":"2024-03-31T06:00:00.000Z"},"country":{"$ref":"#/components/schemas/CricketCountryResponseDto"},"awayTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"homeTeam":{"$ref":"#/components/schemas/CricketTeamResponseDto"},"league":{"$ref":"#/components/schemas/CricketMatchLeagueResponseDto"},"format":{"type":"string","example":"T20","description":"Cricket match format, e.g. T20, ODI, TEST"},"dayType":{"type":"string","enum":["SINGLE","MULTI"],"example":"SINGLE","description":"Information that tells us whether the match will be played across multiple days"},"state":{"$ref":"#/components/schemas/CricketMatchStateResponseDto"},"venue":{"$ref":"#/components/schemas/DetailedMatchVenueResponseDto"},"forecast":{"$ref":"#/components/schemas/DetailedMatchForecastResponseDto"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/CricketDetailedMatchStatisticsDataDto"}},"squad":{"type":"array","items":{"$ref":"#/components/schemas/CricketSquadResponseDto"}},"bestBatsmen":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBatsmenResponseDto"}},"bestBowlers":{"type":"array","items":{"$ref":"#/components/schemas/CricketBestBowlersResponseDto"}},"predictions":{"$ref":"#/components/schemas/PredictionResponseDto"},"inplayData":{"$ref":"#/components/schemas/CricketInplayResponseDto"}},"required":["id","endDate","startDate","country","awayTeam","homeTeam","league","state"]},"CricketTeamPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketTeamResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketBookmakerResponseDto":{"type":"object","properties":{"id":{"type":"number","example":3},"name":{"type":"string","example":"22Bet"}},"required":["id","name"]},"CricketBookmakersPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketBookmakerResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketMarketSelectionResponseDto":{"type":"object","properties":{"odd":{"type":"number","example":1.69},"value":{"type":"string","example":"Odd"}},"required":["odd","value"]},"CricketMarketResponseDto":{"type":"object","properties":{"bookmakerId":{"type":"number","example":3},"bookmakerName":{"type":"string","example":"22Bet"},"type":{"type":"string","example":"prematch"},"market":{"type":"string","example":"Odd or Even"},"values":{"type":"array","items":{"$ref":"#/components/schemas/CricketMarketSelectionResponseDto"}}},"required":["bookmakerId","type","market","values"]},"CricketOddsResponseDto":{"type":"object","properties":{"matchId":{"type":"string","example":"49774517"},"odds":{"type":"array","items":{"$ref":"#/components/schemas/CricketMarketResponseDto"}}},"required":["matchId","odds"]},"CricketOddsPaginatedResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CricketOddsResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"CricketStandingsTeamDto":{"type":"object","properties":{"id":{"type":"string","example":"13434157"},"logo":{"type":"string","example":"https://example.com/logos/team/13434157.png"},"name":{"type":"string","example":"Rwanda Women"}},"required":["id","name"]},"CricketStandingsDto":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/CricketStandingsTeamDto"},"ties":{"type":"number","example":0},"wins":{"type":"number","example":6},"loses":{"type":"number","example":6},"points":{"type":"number","example":12},"position":{"type":"number","example":1},"pointsFor":{"type":"string","example":"278/46.2"},"netRunRate":{"type":"number","example":3.767},"matchesPlayed":{"type":"number","example":6},"pointsAgainst":{"type":"string","example":"268/120.0"}},"required":["team","ties","wins","loses","points","position","pointsFor","netRunRate","matchesPlayed","pointsAgainst"]},"CricketStandingsGroupsResponseDto":{"type":"object","properties":{"name":{"type":"string","example":"BCA Kalahari Womens T20 International Tournament"},"standings":{"type":"array","items":{"$ref":"#/components/schemas/CricketStandingsDto"}}},"required":["name","standings"]},"CricketStandingsLeagueResponseDto":{"type":"object","properties":{"id":{"type":"string","example":"50036737"},"logo":{"type":"string","example":"https://example.com/logos/league/50036737.png"},"name":{"type":"string","example":"BCA Kalahari Womens T20 International Tournament"},"season":{"type":"number","example":2024}},"required":["id","name","season"]},"CricketStandingsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/CricketStandingsGroupsResponseDto"}},"league":{"allOf":[{"$ref":"#/components/schemas/CricketStandingsLeagueResponseDto"}]}},"required":["groups","league"]},"PlayerTeamResponseMD":{"type":"object","properties":{"id":{"type":"number","example":1},"abbreviation":{"type":"string","nullable":true,"example":"RCB"},"logo":{"type":"string","nullable":true,"example":"https://highlightly.net/cricket/images/teams/1.png"},"isCurrent":{"type":"boolean","example":true}},"required":["id","abbreviation","logo","isCurrent"]},"SinglePlayerInfoResponseMD":{"type":"object","properties":{"id":{"type":"string","example":"ee38c051-470a-4f80-93e5-a034fc6f0ce2"},"longName":{"type":"string","example":"Virat Kohli"},"gender":{"type":"string","example":"M"},"dateOfBirth":{"type":"number","example":594691200000,"description":"Player birth date in Unix timestamp"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"longBattingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"longBowlingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/PlayerTeamResponseMD"}}},"required":["id","longName","battingStyles","bowlingStyles","longBattingStyles","longBowlingStyles"]},"BasePlayerInfoResponseMD":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SinglePlayerInfoResponseMD"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"},"plan":{"$ref":"#/components/schemas/PlanResponseDto"}},"required":["data","pagination","plan"]},"StatValueMD":{"type":"object","properties":{"value":{"type":"number","example":9},"displayName":{"type":"string","examples":["Sixes","Fifties","Hundreds","Balls Faced"]}},"required":["value","displayName"]},"BasePlayerStatisticsMD":{"type":"object","properties":{"year":{"type":"number","example":2010},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/StatValueMD"}}},"required":["year","statistics"]},"DetailedPlayerSummaryResponseMD":{"type":"object","properties":{"format":{"type":"string","examples":["T20Is","ODIs","Tests"],"description":"Match format"},"batting":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}},"bowling":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}},"fielding":{"type":"array","items":{"$ref":"#/components/schemas/BasePlayerStatisticsMD"}}},"required":["format","batting","bowling","fielding"]},"DetailedPlayerInfoResponseMD":{"type":"object","properties":{"id":{"type":"string","example":"ee38c051-470a-4f80-93e5-a034fc6f0ce2"},"longName":{"type":"string","example":"Virat Kohli"},"gender":{"type":"string","example":"M"},"dateOfBirth":{"type":"number","example":594691200000,"description":"Player birth date in Unix timestamp"},"battingStyles":{"example":["rhb"],"type":"array","items":{"type":"string"}},"bowlingStyles":{"example":["rm"],"type":"array","items":{"type":"string"}},"longBattingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"longBowlingStyles":{"example":["right-hand bat"],"type":"array","items":{"type":"string"}},"summary":{"type":"array","items":{"$ref":"#/components/schemas/DetailedPlayerSummaryResponseMD"}}},"required":["id","longName","battingStyles","bowlingStyles","longBattingStyles","longBowlingStyles","summary"]}}}}