Manchester United VS Manchester City
{
"openapi": "3.0.0",
"paths": {
"/football/countries": {
"get": {
"operationId": "CountriesController_getAllCountries",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "France",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Countries"
]
}
},
"/football/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getCountryByCountryCode",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "FR",
"description": "A string value code of the country, following the ISO 3166 standard.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Countries"
]
}
},
"/football/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "Superettan",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "SE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Sweden",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballLeaguePaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Leagues"
]
}
},
"/football/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 97798,
"description": "Requested league id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLeagueResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Leagues"
]
}
},
"/football/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Skövde AIK",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Teams"
]
}
},
"/football/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_teamStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 5700782,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Teams"
]
}
},
"/football/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 5700782,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Teams"
]
}
},
"/football/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Half time | Half time pause between first and second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and extra time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after extra time | Match has been concluded in extra time. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Cancelled | Game will not be played. |\n| Awarded | Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc. |\n| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| In progress | Match is considered in play but the coverage information is minimal. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Superettan",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 97798,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5700782,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 1907875,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Skövde AIK",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Vasteras SK FK",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "SE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Sweden",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Matches"
]
}
},
"/football/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue`, weather `forecast`, match `statistics`, and who the game's `referee` is. The retrieved data will also contain a list of important events that happened:\n\n| Type | Description |\n| ----------- | ----------- |\n| Goal | A player strikes the ball into the opposing team's goal. |\n| Own Goal | A player strikes or deflects the ball into their own team's goal. |\n| Penalty | A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area. |\n| Missed Penatly | The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper. |\n| Yellow Card | A player is cautioned by the referee for unsporting behavior or foul play. |\n| Red Card | A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card. |\n| Substitution | A player is replaced by another player from the bench during a stoppage in play. |\n| VAR Goal Confirmed | The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand. |\n| VAR Goal Cancelled | The VAR review determines that a goal should be disallowed due to an infringement or violation. |\n| VAR Penalty | The VAR review results in a penalty being awarded to a team. |\n| VAR Penalty Cancelled | The VAR review results in a previously awarded penalty being overturned. |\n| VAR Goal Cancelled - Offside | The VAR review determines that a goal should be disallowed due to an offside infringement. |\n\nThe above list may be updated with additional entries in the future.\n\n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1002433681,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Matches"
]
}
},
"/football/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/football-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "TR",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Turkey",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Süper Lig",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 173537,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-11",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 914490490,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 850082,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 856039,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Trabzonspor",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Antalyaspor",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Highlights"
]
}
},
"/football/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 125344,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Football.Highlights"
]
}
},
"/football/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 8780,
"description": "Requested higlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Highlights"
]
}
},
"/football/bookmakers": {
"get": {
"operationId": "FootballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Stake.com",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Bookmakers"
]
}
},
"/football/bookmakers/{id}": {
"get": {
"operationId": "FootballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Bookmakers"
]
}
},
"/football/odds": {
"get": {
"operationId": "FootballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -1.25/+1.25\"*, *\"Asian Handicap -1.5/+1.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even | The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Total Goals | This is considered a complex market. It is split into multiple possible variants such as *\"Total Goals 2\"*, *\"Total Goals 3.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Both Teams to Score | The market defines whether both teams will score or not. Outcomes can be either `Yes` or `No`. |\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 1,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Stake.com",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Odds"
]
}
},
"/football/standings": {
"get": {
"operationId": "FootballStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 33973,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2023,
"name": "season",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballStandingsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Standings"
]
}
},
"/football/last-five-games": {
"get": {
"operationId": "FootballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 5700782,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Last Five Games"
]
}
},
"/football/head-2-head": {
"get": {
"operationId": "FootballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 314803,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 5700782,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Head 2 Head"
]
}
},
"/football/lineups/{matchId}": {
"get": {
"operationId": "FootballLineupsController_getLineups",
"summary": "Get linups by match id",
"description": "> Lineups will become available 30 minutes before the game starts or, at the latest, 15 minutes after kickoff.\n\n> Refresh interval: Once every 10 minutes\n\nRetrieve home and away team lineups for a specific match.\n\nUnderstanding the returned data structure is crucial for accurate rendering. The `formation` and `initialLineup` fields are closely related. The first row will always include the team's goalkeeper, while subsequent rows will have the number of entries specified by the formation field.\n\nBelow is an example of what you can aim to achieve with the lineup endpoint:\n\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "matchId",
"required": true,
"in": "path",
"example": 890342514,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FootballLineupsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Lineups"
]
}
},
"/football/statistics/{matchId}": {
"get": {
"operationId": "FootballStatisticsController_getStatistics",
"summary": "Get match statistics by match id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "matchId",
"required": true,
"in": "path",
"example": 979465191,
"description": "Requested statistics for given match id",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"404": {
"description": "Match statistics not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Statistics"
]
}
},
"/football/events/{id}": {
"get": {
"operationId": "FootballLiveEventsController_getLiveEvents",
"summary": "Get live events by match id",
"description": "> Refresh interval: Once a minute\n\nRetrieve a list of live events for a match by specifying `matchId` as the path parameter.\n\nCurrently supported live events:\n\n| Type | Description |\n| ----------- | ----------- |\n| Goal | A player strikes the ball into the opposing team's goal. |\n| Own Goal | A player strikes or deflects the ball into their own team's goal. |\n| Penalty | A player scores the goal from the penalty spot after a foul or hand play by the defending team inside the penalty area. |\n| Missed Penatly | The player taking the penalty kick failed to score, either by missing the target or the shot being saved by the goalkeeper. |\n| Yellow Card | A player is cautioned by the referee for unsporting behavior or foul play. |\n| Red Card | A player is sent off the field for serious foul play, violent conduct, or receiving a second yellow card. |\n| Substitution | A player is replaced by another player from the bench during a stoppage in play. |\n| VAR Goal Confirmed | The Video Assistant Referee (VAR) review confirms that a goal is valid and should stand. |\n| VAR Goal Cancelled | The VAR review determines that a goal should be disallowed due to an infringement or violation. |\n| VAR Penalty | The VAR review results in a penalty being awarded to a team. |\n| VAR Penalty Cancelled | The VAR review results in a previously awarded penalty being overturned. |\n| VAR Goal Cancelled - Offside | The VAR review determines that a goal should be disallowed due to an offside infringement. |\n\nThe above list may be updated with additional entries in the future.\n\nBelow is an example of what you can aim to achieve with the live events endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1022538556,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLiveEventDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Football.Live Events"
]
}
},
"/american-football/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"description": "Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Miners",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "UTEP Miners",
"required": false,
"name": "displayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "UTEP",
"required": false,
"name": "abbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "league",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Teams"
]
}
},
"/american-football/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getTeamStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmfTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Teams"
]
}
},
"/american-football/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 21,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Teams"
]
}
},
"/american-football/matches": {
"get": {
"operationId": "MatchController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Cancelled | Game will not be played. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| Finished | Match has been concluded. |\n| Scheduled | Match has not been started yet. |\n| End period | Break time between periods. |\n| Half time | Half time pause between second and third quarter. |\n| In progress | Game is currently in progress. |\n| Unknown | Unknown match coverage or state. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "league",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-26",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 21,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 22,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Gamecocks",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Miners",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "JVST",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "UTEP",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Jacksonville State Gamecocks",
"required": false,
"name": "homeTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "UTEP Miners",
"required": false,
"name": "awayTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmericanFootballMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Matches"
]
}
},
"/american-football/matches/{id}": {
"get": {
"operationId": "MatchController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue` and weather `forecast`.\n\n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 39,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Matches"
]
}
},
"/american-football/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/nfl-ncaa-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-09-01",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 35,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 69,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 70,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Eagles",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Bison",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "EMU",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "HOW",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Eastern Michigan Eagles",
"required": false,
"name": "homeTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Howard Bison",
"required": false,
"name": "awayTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmericanFootballHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Highlights"
]
}
},
"/american-football/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 12774,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"American Football.Highlights"
]
}
},
"/american-football/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 12,
"description": "Requested highlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Highlights"
]
}
},
"/american-football/last-five-games": {
"get": {
"operationId": "AmericanFootballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 21,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Last Five Games"
]
}
},
"/american-football/head-2-head": {
"get": {
"operationId": "AmericanFootballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 13,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 3,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Head 2 Head"
]
}
},
"/american-football/bookmakers": {
"get": {
"operationId": "AmericanFootballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Megapari Sport",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmericanFootballBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Bookmakers"
]
}
},
"/american-football/bookmakers/{id}": {
"get": {
"operationId": "AmericanFootballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 43,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Bookmakers"
]
}
},
"/american-football/odds": {
"get": {
"operationId": "AmericanFootballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Away` or `Draw`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Totals | This is considered a complex market. It is split into multiple possible variants such as *\"Totals 25\"*, *\"Totals 25.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NFL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 43,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Cashwin",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmericanFootballOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"American Football.Odds"
]
}
},
"/basketball/countries": {
"get": {
"operationId": "CountriesController_getAllCountries",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "name",
"in": "query",
"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"
}
}
}
}
},
"tags": [
"Basketball.Countries"
]
}
},
"/basketball/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getCountryByCountryCode",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "AU",
"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"
}
}
}
}
},
"tags": [
"Basketball.Countries"
]
}
},
"/basketball/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NBL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 1635,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-10-01",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 7592,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 1635,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Adelaide",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Melbourne United",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 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"
}
}
}
}
},
"tags": [
"Basketball.Matches"
]
}
},
"/basketball/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n\n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 318831338,
"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"
}
}
}
}
},
"tags": [
"Basketball.Matches"
]
}
},
"/basketball/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "NBL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 1635,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-10-01",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 299340885,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 7592,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 1635,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Adelaide",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Melbourne United",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 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"
}
}
}
}
},
"tags": [
"Basketball.Highlights"
]
}
},
"/basketball/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 13,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Basketball.Highlights"
]
}
},
"/basketball/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 28,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Basketball.Highlights"
]
}
},
"/basketball/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "NBL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Leagues"
]
}
},
"/basketball/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1635,
"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"
}
}
}
}
},
"tags": [
"Basketball.Leagues"
]
}
},
"/basketball/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Adelaide",
"required": false,
"name": "name",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Teams"
]
}
},
"/basketball/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getTeamStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 7592,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"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"
}
}
}
}
},
"tags": [
"Basketball.Teams"
]
}
},
"/basketball/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 7592,
"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"
}
}
}
}
},
"tags": [
"Basketball.Teams"
]
}
},
"/basketball/bookmakers": {
"get": {
"operationId": "BasketballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Stake.com",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 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"
}
}
}
}
},
"tags": [
"Basketball.Bookmakers"
]
}
},
"/basketball/bookmakers/{id}": {
"get": {
"operationId": "BasketballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"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"
}
}
}
}
},
"tags": [
"Basketball.Bookmakers"
]
}
},
"/basketball/odds": {
"get": {
"operationId": "BasketballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` 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\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 75,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Powbet",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Odds"
]
}
},
"/basketball/last-five-games": {
"get": {
"operationId": "BasketballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 1635,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Last Five Games"
]
}
},
"/basketball/head-2-head": {
"get": {
"operationId": "BasketballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 1635,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 7592,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Head 2 Head"
]
}
},
"/basketball/standings": {
"get": {
"operationId": "BasketballStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 2486,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2023,
"name": "season",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Basketball.Standings"
]
}
},
"/hockey/countries": {
"get": {
"operationId": "CountriesController_getAllCountries",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Countries"
]
}
},
"/hockey/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getCountryByCountryCode",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "DE",
"description": "A string value code of the country, following the ISO 3166 standard.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Countries"
]
}
},
"/hockey/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/hockey-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "DEL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 16953,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-10-13",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 291869956,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 223746,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 214385,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Frankfurt Lowen",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Kolner",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Highlights"
]
}
},
"/hockey/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 16,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Hockey.Highlights"
]
}
},
"/hockey/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 16,
"description": "Requested higlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Highlights"
]
}
},
"/hockey/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "DEL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyLeaguePaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Leagues"
]
}
},
"/hockey/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 16953,
"description": "Requested league id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyLeagueResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Leagues"
]
}
},
"/hockey/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| 1st period | Match is in the first period of regular play. |\n| 2nd period | Match is in the second period of regular play. |\n| 3nd period | Match is in the third period of regular play. |\n| Over time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and over time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after over time | Match has been concluded in over time. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Cancelled | Game will not be played. |\n| Awarded | Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc. |\n| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "DEL",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 16953,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-10-13",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 223746,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 214385,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Frankfurt Lowen",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Kolner",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Matches"
]
}
},
"/hockey/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 308606573,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Matches"
]
}
},
"/hockey/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Frankfurt Lowen",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Teams"
]
}
},
"/hockey/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getTeamStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 223746,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Teams"
]
}
},
"/hockey/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 223746,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Teams"
]
}
},
"/hockey/bookmakers": {
"get": {
"operationId": "HockeyBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Stake.com",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Bookmakers"
]
}
},
"/hockey/bookmakers/{id}": {
"get": {
"operationId": "HockeyBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Bookmakers"
]
}
},
"/hockey/odds": {
"get": {
"operationId": "HockeyOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| 3-Way Moneyline| The possible outcomes for the three-way moneyline market are `Home`, `Draw` or `Away`. |\n| Moneyline | When a match does not have a three-way moneyline it will have a two-way one instead. The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Goals | This is considered a complex market. It is split into multiple possible variants such as *\"Total Goals 8\"*, *\"Total Goals 8.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n| Both Teams to Score | The market defines whether both teams will score or not. Outcomes can be either `Yes` or `No`. |\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 19,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "1Bet",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Odds"
]
}
},
"/hockey/last-five-games": {
"get": {
"operationId": "HockeyLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 214385,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Last Five Games"
]
}
},
"/hockey/head-2-head": {
"get": {
"operationId": "HockeyHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 214385,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 223746,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Head 2 Head"
]
}
},
"/hockey/standings": {
"get": {
"operationId": "HockeyStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 130987,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2022,
"name": "season",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HockeyStandingsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Hockey.Standings"
]
}
},
"/rugby/countries": {
"get": {
"operationId": "CountriesController_getAll",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Europe",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Countries"
]
}
},
"/rugby/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getById",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "EU",
"description": "A string value code of the country, following the ISO 3166 standard.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Countries"
]
}
},
"/rugby/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/rugby-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "EU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Europe",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Six Nations U20",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 48440,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-03-08",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2024,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 36224450,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 384585,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 385436,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Italy U20",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Scotland U20",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Highlights"
]
}
},
"/rugby/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 88,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Rugby.Highlights"
]
}
},
"/rugby/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1034,
"description": "Requested higlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Highlights"
]
}
},
"/rugby/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2024,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "Six Nations U20",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "EU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Europe",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyLeaguePaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Leagues"
]
}
},
"/rugby/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 48440,
"description": "Requested league id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyLeagueResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Leagues"
]
}
},
"/rugby/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause to let the players recover, resolve temporary issues, attend to injuries and so on. |\n| Half time | Half time pause between first and second half. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after extra time | Match has been concluded in extra time. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Cancelled | Game will not be played. |\n| Awarded | Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc. |\n| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Six Nations U20",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 48440,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-03-08",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2024,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 384585,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 385436,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Italy U20",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Scotland U20",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "EU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Europe",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Matches"
]
}
},
"/rugby/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"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` and who the game's `referee` is.\n \n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 36125734,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Matches"
]
}
},
"/rugby/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Italy U20",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Teams"
]
}
},
"/rugby/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getTeamStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 384585,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyTeamStatsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Teams"
]
}
},
"/rugby/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 384585,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
}
},
"tags": [
"Rugby.Teams"
]
}
},
"/rugby/bookmakers": {
"get": {
"operationId": "RugbyBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Marathonbet",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Bookmakers"
]
}
},
"/rugby/bookmakers/{id}": {
"get": {
"operationId": "RugbyBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 5,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Bookmakers"
]
}
},
"/rugby/odds": {
"get": {
"operationId": "RugbyOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 65.5\"*, *\"Over/Under 63.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -26.5/+26.5\"*, *\"Asian Handicap -27.5/+27.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere are two other important query parameters. The `limit` parameter defines what the number of returned match odds will be. If the number of actual match odds is above the `limit` value you can make subsequent requests by increasing the `offset` value.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 219,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Bets10",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Odds"
]
}
},
"/rugby/last-five-games": {
"get": {
"operationId": "RugbyLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 384585,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Last Five Games"
]
}
},
"/rugby/head-2-head": {
"get": {
"operationId": "RugbyHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head data for a specific set of teams.",
"description": "Retrieve a list of head 2 head games played for given team ids.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 385436,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 384585,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Head 2 Head"
]
}
},
"/rugby/standings": {
"get": {
"operationId": "RugbyStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 69715,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2022,
"name": "season",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RugbyStandingsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Rugby.Standings"
]
}
},
"/handball/countries": {
"get": {
"operationId": "CountriesController_getAll",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Countries"
]
}
},
"/handball/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getById",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "DE",
"description": "A string value code of the country, following the ISO 3166 standard.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Countries"
]
}
},
"/handball/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/handball-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "1. Bundesliga Women",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 36526,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-12-27",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 127621850,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 302038,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 332674,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Bensheim-Auerbach W",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Solingen W",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Highlights"
]
}
},
"/handball/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 53,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Handball.Highlights"
]
}
},
"/handball/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested higlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Highlights"
]
}
},
"/handball/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "1. Bundesliga Women",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballLeaguePaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Leagues"
]
}
},
"/handball/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 36526,
"description": "Requested league id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballLeagueResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Leagues"
]
}
},
"/handball/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First half | Match is considered in play and is in the first half. |\n| Second half | Match is considered in play and is in the second half. |\n| Half time | Half time pause between first and second half. |\n| Extra time | Game was considered a draw in normal time. Additional extra time is needed to decide the winner. |\n| Break time | Short pause between in play periods and extra time. |\n| Penalties | Penalty shootout to decide the winner of the match. |\n| Finished | Match has been concluded. |\n| Finished after penalties | Match has been concluded with the penalty shootout. |\n| Finished after extra time | Match has been concluded in extra time. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Cancelled | Game will not be played. |\n| Awarded | Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc. |\n| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "1. Bundesliga Women",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 36526,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-12-27",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 302038,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 332674,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Bensheim-Auerbach W",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Solingen W",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "DE",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Germany",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Matches"
]
}
},
"/handball/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 127484839,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Matches"
]
}
},
"/handball/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Solingen W",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Teams"
]
}
},
"/handball/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getTeamStats",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 332674,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Teams"
]
}
},
"/handball/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 332674,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Teams"
]
}
},
"/handball/bookmakers": {
"get": {
"operationId": "HandballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Stake.com",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Bookmakers"
]
}
},
"/handball/bookmakers/{id}": {
"get": {
"operationId": "HandballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Bookmakers"
]
}
},
"/handball/odds": {
"get": {
"operationId": "HandballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Full Time Result | The possible outcomes for the mentioned market are `Home`, `Draw` or `Away`. |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 62.5\"*, *\"Over/Under 57.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -0.5/+0.5\"*, *\"Asian Handicap -4.5/+4.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere are two other important query parameters. The `limit` parameter defines what the number of returned match odds will be. If the number of actual match odds is above the `limit` value you can make subsequent requests by increasing the `offset` value.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 3,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "22Bet",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Odds"
]
}
},
"/handball/last-five-games": {
"get": {
"operationId": "HandballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 302038,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Last Five Games"
]
}
},
"/handball/head-2-head": {
"get": {
"operationId": "HandballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 881569,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 892632,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Head 2 Head"
]
}
},
"/handball/standings": {
"get": {
"operationId": "HandballStandingsController_getOdds",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 171835,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2024,
"name": "season",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HandballStandingsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Handball.Standings"
]
}
},
"/volleyball/countries": {
"get": {
"operationId": "CountriesController_getAll",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Italy",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Countries"
]
}
},
"/volleyball/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getById",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "IT",
"description": "A string value code of the country, following the ISO 3166 standard.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballCountryResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Countries"
]
}
},
"/volleyball/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/volleyball-highlights-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "IT",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Italy",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "SuperLega",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 83331,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-12-30",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 126347903,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 630524,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 631375,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Trentino",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Cisterna",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Highlights"
]
}
},
"/volleyball/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 93,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Volleyball.Highlights"
]
}
},
"/volleyball/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested higlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Highlights"
]
}
},
"/volleyball/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "SuperLega",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "IT",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Italy",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballLeaguePaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Leagues"
]
}
},
"/volleyball/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 83331,
"description": "Requested league id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballLeagueResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Leagues"
]
}
},
"/volleyball/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Not started | Match has not been started yet. |\n| First set | Match is considered in play and is in the first set. |\n| Second set | Match is considered in play and is in the second set. |\n| Third set | Match is considered in play and is in the third set. |\n| Fourth set | Match is considered in play and is in the fourth set. |\n| Fifth set | Match is considered in play and is in the fifth set. |\n| Finished | Match has been concluded. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Cancelled | Game will not be played. |\n| Awarded | Game awarded to one of the teams when the other forfeits or specific circumstances have been met such as insufficient players, late arrival, team withdrawl, etc. |\n| Interrupted | An issue arose that is preventing the game from continuing. Based on the interruption the game will either resume normal play or be abandoned. |\n| Abandoned | Considered \"abandoned\" when it is prematurely ended by the officials and can not be resumed or completed. In the future the game **might be** resumed from the exact point where it was halted. |\n| Unknown | Unknown match coverage or state. |\n| To be announced | Match's start time will be updated or competing teams are not yet known. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "SuperLega",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 83331,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-12-30",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 630524,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 631375,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Trentino",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Cisterna",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "IT",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Italy",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Matches"
]
}
},
"/volleyball/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nCertain popular leagues and their associated matches will have additional data about the `venue` and match weather `forecast`.\n \n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 139134178,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Matches"
]
}
},
"/volleyball/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Trentino",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Teams"
]
}
},
"/volleyball/teams/statistics/{id}": {
"get": {
"operationId": "TeamsController_getStatistics",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 630524,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Teams"
]
}
},
"/volleyball/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 630524,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Teams"
]
}
},
"/volleyball/bookmakers": {
"get": {
"operationId": "VolleyballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Stake.com",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Bookmakers"
]
}
},
"/volleyball/bookmakers/{id}": {
"get": {
"operationId": "VolleyballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 1,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Bookmakers"
]
}
},
"/volleyball/odds": {
"get": {
"operationId": "VolleyballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Match Winner | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Total Sets | This is considered a complex market. It is split into multiple possible variants such as *\"Total Sets 3.5\"*, *\"Total Sets 4.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Total Points | This is considered a complex market. It is split into multiple possible variants such as *\"Total Points 172.5\"*, *\"Total Points 174.5\"* and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "22Bet",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Odds"
]
}
},
"/volleyball/last-five-games": {
"get": {
"operationId": "VolleyballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 630524,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Last Five Games"
]
}
},
"/volleyball/head-2-head": {
"get": {
"operationId": "VolleyballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 630524,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 631375,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Head 2 Head"
]
}
},
"/volleyball/standings": {
"get": {
"operationId": "VolleyballStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 150560,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2020,
"name": "season",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolleyballStandingsResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Volleyball.Standings"
]
}
},
"/cricket/countries": {
"get": {
"operationId": "CountriesController_getAllCountries",
"summary": "Get all countries",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "name",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Countries"
]
}
},
"/cricket/countries/{countryCode}": {
"get": {
"operationId": "CountriesController_getCountryById",
"summary": "Get country by country code",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"required": true,
"in": "path",
"example": "AU",
"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"
}
}
}
}
},
"tags": [
"Cricket.Countries"
]
}
},
"/cricket/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Big Bash League",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 48513362,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-01-13",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 48514657,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 17838627,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 17838662,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Melbourne Renegades",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Melbourne Stars",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "MR",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "MS",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Highlights"
]
}
},
"/cricket/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 117,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Cricket.Highlights"
]
}
},
"/cricket/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 75,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Cricket.Highlights"
]
}
},
"/cricket/leagues": {
"get": {
"operationId": "LeaguesController_getLeagues",
"summary": "Get all leagues",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"example": "Big Bash League",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Leagues"
]
}
},
"/cricket/leagues/{id}": {
"get": {
"operationId": "LeaguesController_getLeagueById",
"summary": "Get league by id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 48513362,
"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"
}
}
}
}
},
"tags": [
"Cricket.Leagues"
]
}
},
"/cricket/matches": {
"get": {
"operationId": "MatchesController_getMatches",
"summary": "Get all matches",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Big Bash League",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 48513362,
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-01-13",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2023,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 17838627,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 17838662,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Melbourne Renegades",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Melbourne Stars",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "AU",
"required": false,
"name": "countryCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Australia",
"required": false,
"name": "countryName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "MR",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "MS",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Matches"
]
}
},
"/cricket/matches/{id}": {
"get": {
"operationId": "MatchesController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue` and weather `forecast`.\n\n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 49877382,
"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"
}
}
}
}
},
"tags": [
"Cricket.Matches"
]
}
},
"/cricket/teams": {
"get": {
"operationId": "TeamsController_getTeams",
"summary": "Get all teams",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 500,
"default": 500,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "Melbourne Stars",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "MS",
"required": false,
"name": "abbreviation",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Teams"
]
}
},
"/cricket/teams/{id}": {
"get": {
"operationId": "TeamsController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 17838627,
"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"
}
}
}
}
},
"tags": [
"Cricket.Teams"
]
}
},
"/cricket/bookmakers": {
"get": {
"operationId": "CricketBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "22Bet",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 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"
}
}
}
}
},
"tags": [
"Cricket.Bookmakers"
]
}
},
"/cricket/bookmakers/{id}": {
"get": {
"operationId": "CricketBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 3,
"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"
}
}
}
}
},
"tags": [
"Cricket.Bookmakers"
]
}
},
"/cricket/odds": {
"get": {
"operationId": "CricketOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` 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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"required": false,
"name": "leagueId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 3,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "22Bet",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Odds"
]
}
},
"/cricket/last-five-games": {
"get": {
"operationId": "CricketLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 17838662,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Last Five Games"
]
}
},
"/cricket/head-2-head": {
"get": {
"operationId": "CricketHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 17838627,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 17838662,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Head 2 Head"
]
}
},
"/cricket/standings": {
"get": {
"operationId": "CricketStandingsController_getStandings",
"summary": "Get standings",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 50036737,
"name": "leagueId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 2024,
"name": "season",
"in": "query",
"required": true,
"schema": {
"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"
}
}
}
}
},
"tags": [
"Cricket.Standings"
]
}
},
"/baseball/highlights": {
"get": {
"operationId": "HighlightsController_getHighlights",
"summary": "Get all highlights",
"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 imbedding (`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\nBelow is an example of what you can aim to achieve with our highlights data:\n\n\n\n\n## Retrieve highlights\n\nRetrieve a list of highlights based on the requested query parameters.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get highlights relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned highlights will be. If the number of actual highlights is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\n> Note: The Basic/Free plan might have certain restrictions in place. More information can be found [here](https://rapidapi.com/highlightly-api-highlightly-api-default/api/mlb-college-baseball-api).\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-03-06",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2024,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 394,
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 219,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 302,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Bears",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Patriots",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "BAY",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "DBU",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Baylor",
"required": false,
"name": "homeTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Dallas Baptist",
"required": false,
"name": "awayTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 40,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 40,
"default": 40,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballHighlightPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Highlights"
]
}
},
"/baseball/highlights/geo-restrictions/{id}": {
"get": {
"operationId": "HighlightsController_getGeoRestrictions",
"summary": "Get geo restrictions for highlight",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 44,
"description": "Requested higlight 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"
}
}
}
}
},
"tags": [
"Baseball.Highlights"
]
}
},
"/baseball/highlights/{id}": {
"get": {
"operationId": "HighlightsController_getHighlightById",
"summary": "Get highlight by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 27,
"description": "Requested highlight id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballHighlightResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Highlights"
]
}
},
"/baseball/matches": {
"get": {
"operationId": "BaseballMatchController_getMatches",
"summary": "Get all matches",
"description": "> Refresh interval: Once a minute\n\n> Route returns only general match information. For additional match details check the `matches/{matchId}` route. \n\nRetrieve a list of matches based on the requested query parameters. \n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nYou can specify the `timezone` field in combination with the `date` query parameter to get matches relevant to your location.\n\nThere are two other important parameters. The `limit` parameter defines what the number of returned matches will be. If the number of actual matches is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nMatches have different possible states they can be in:\n\n| State | Description |\n| ----------- | ----------- |\n| Finished | Match has been concluded. |\n| Postponed | Match has been postponed due to certain circumstances that are preventing the game from being played. Event start time will be changed to a moment in the future. |\n| Scheduled | Match has not been started yet. |\n| Canceled | Game will not be played. |\n| In Progress | Game is currently in progress. |\n| Half Time | Half time pause between first and second half. |\n| Suspended | Match has already been in play but was suspended. In the future the game will resume from the exact point where it was halted. |\n| Unknown | Unknown match coverage or state. |\n| Rain Delay | Match has been delayed due to bad weather conditions. Will either be resumed or suspended. |\n| Period End | Break time between periods. |\n\nBelow is an example of what you can aim to achieve with the matches endpoint:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "league",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2024-03-06",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 2024,
"required": false,
"name": "season",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 219,
"required": false,
"name": "homeTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 302,
"required": false,
"name": "awayTeamId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Bears",
"required": false,
"name": "homeTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Patriots",
"required": false,
"name": "awayTeamName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "BAY",
"required": false,
"name": "homeTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "DBU",
"required": false,
"name": "awayTeamAbbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Baylor",
"required": false,
"name": "homeTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Dallas Baptist",
"required": false,
"name": "awayTeamDisplayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 100,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 100,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballMatchPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Matches"
]
}
},
"/baseball/matches/{id}": {
"get": {
"operationId": "BaseballMatchController_getMatchById",
"summary": "Get match by id",
"description": "\nRetrieve detailed match information by specifying the match id path parameter.\n\nFetched data will have additional information about the `venue`, weather `forecast`, match `stats`, who the game's `referees` are, each team's `rosters`, and `plays`.\n\n> Note: Used to retrieve additional match information.\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 47299,
"description": "Requested match id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Matches"
]
}
},
"/baseball/teams": {
"get": {
"operationId": "TeamController_getTeams",
"summary": "Get all teams",
"description": "Retrieve a list of teams that are supported by the API.\n\nBy utilising either `league`, `name`, `displayName` or `abbreviation` query parameters you can check whether a specific team exists or simply retrieve the associated data.\n\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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "league",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Bears",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "Baylor",
"required": false,
"name": "displayName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "BAY",
"required": false,
"name": "abbreviation",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballTeamPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Teams"
]
}
},
"/baseball/teams/statistics/{id}": {
"get": {
"operationId": "TeamController_getTeamStats",
"summary": "Get team statistics",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 219,
"description": "Requested team id.",
"schema": {
"type": "number"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"example": "2023-08-06",
"name": "fromDate",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballTeamStatisticsResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Teams"
]
}
},
"/baseball/teams/{id}": {
"get": {
"operationId": "TeamController_getTeamById",
"summary": "Get team by team id",
"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.",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 219,
"description": "Requested team id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballTeamResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Teams"
]
}
},
"/baseball/standings": {
"get": {
"operationId": "BaseballStandingsController_getStandings",
"summary": "Get standings",
"description": "> Refresh interval: Up to an hour after a match for the associated league and season is finished\n \n Retrieve standings data for a specific league, conference or division.\n \n There are numerous ways on how to fetch the data. You can utilise either `abbreviation` or `leagueName`:\n\n | Abbreviation | League Name |\n | ----------- | ----------- |\n | CAC | Cactus League (MLB)\t |\n | GPF | Grapefruit League (MLB)\t |\n | AL | American League (MLB) |\n | NL | National League (MLB)\t |\n | NCAA | NCAA Division I (CBASE)\t |\n\nAdditionally you can specify the `year` parameter to narrow down the the standings for that season.\n\nThere are two other important parameters that are used to navigate through the pagination. The `limit` parameter defines what the number of returned standings will be. If the number of actual standings is above the `limit` value you can make subsequent requests by increasing the `offset` value. \n\nBelow is an example on how you could render league associated standings\n \n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "MLB",
"required": false,
"name": "leagueType",
"in": "query",
"schema": {
"enum": [
"MLB",
"NCAA"
],
"type": "string"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 10,
"default": 10,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"example": "National League (MLB)",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": "NL",
"required": false,
"name": "abbreviation",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 2024,
"required": false,
"name": "year",
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballStandingsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Standings"
]
}
},
"/baseball/odds": {
"get": {
"operationId": "BaseballOddsController_getOddsV2",
"summary": "Get all odds",
"description": "\n> Refresh interval: Multiple times a day\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.\n\nAt least one primary query parameter needs to be specified before you can retrieve the data (`timezone`, `limit`, `offset` are considered secondary).\n\nThe most popular way of getting match odds is by specifying the `matchId` query parameter. You can also utilise the `date` parameter alongside the `timezone` to fetch all match odds for a given day. By specifying league or bookmaker related fields you can further narrow down your search.\n\nAs it stands, we currently offer the support for the following markets:\n\n| Market | Description |\n| ----------- | ----------- |\n| Home/Away | The possible outcomes for the mentioned market are either `Home` or `Away`. There is no possible way for the game to end in a `Draw`. |\n| Over/Under | This is considered a complex market. It is split into multiple possible variants such as *\"Over/Under 7.5\"*, *\"Over/Under 9.5\"* points and so on. The possible outcome of a variant is either `Over` or `Under`.|\n| Asian Handicap | This is considered a complex market. It is split into multiple possible variants such as *\"Asian Handicap -0.5/+0.5\"*, *\"Asian Handicap -1.5/+1.5\"* and so on. The possible outcome of a variant is either `Home` or `Away`.|\n| Odd or Even| The Odd or Even market defines whether the score of both teams will be either `Odd` or `Even`. |\n\nThere are two other important query parameters. The `limit` parameter defines what the number of returned match odds will be. If the number of actual match odds is above the `limit` value you can make subsequent requests by increasing the `offset` value.\n\n> Match odds are available up to 28 days after the game finishes and up to 7 days before the game starts.\n\nBelow is an example of what can be achieved with bookmaker odds on a match basis:\n\n",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "NCAA",
"required": false,
"name": "leagueName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Valid timezone identifier.",
"example": "Europe/London",
"required": false,
"name": "timezone",
"in": "query",
"schema": {
"default": "Etc/UTC",
"type": "string"
}
},
{
"example": 53,
"required": false,
"name": "bookmakerId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": 5,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 5,
"default": 5,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
},
{
"required": false,
"name": "matchId",
"in": "query",
"schema": {
"type": "number"
}
},
{
"example": "Megapari Sport",
"required": false,
"name": "bookmakerName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Date that follows the YYYY-MM-DD format.",
"required": false,
"name": "date",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballOddsPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Odds"
]
}
},
"/baseball/bookmakers": {
"get": {
"operationId": "BaseballBookmakersController_getBookmakers",
"summary": "Get all bookmakers",
"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. ",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "Megapari Sport",
"required": false,
"name": "name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"example": 20,
"required": false,
"name": "limit",
"in": "query",
"schema": {
"minimum": 0,
"maximum": 100,
"default": 20,
"type": "number"
}
},
{
"example": 0,
"required": false,
"name": "offset",
"in": "query",
"schema": {
"minimum": 0,
"default": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseballBookmakersPaginatedResponseDto"
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Bookmakers"
]
}
},
"/baseball/bookmakers/{id}": {
"get": {
"operationId": "BaseballBookmakersController_getBookmakerById",
"summary": "Get bookmaker by id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"example": 53,
"description": "Requested bookmaker id.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballBookmakerResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Bookmakers"
]
}
},
"/baseball/last-five-games": {
"get": {
"operationId": "BaseballLastFiveGamesController_getLastFiveGames",
"summary": "Get last five finished games for a specific team id",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 42,
"name": "teamId",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Last Five Games"
]
}
},
"/baseball/head-2-head": {
"get": {
"operationId": "BaseballHead2HeadController_getHead2HeadData",
"summary": "Get head 2 head games",
"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",
"parameters": [
{
"name": "x-rapidapi-host",
"in": "header",
"description": "sport-highlights-api.p.rapidapi.com",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-rapidapi-key",
"in": "header",
"description": "Rapid API Token",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": 42,
"name": "teamIdOne",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
},
{
"example": 52,
"name": "teamIdTwo",
"in": "query",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballMatchResponseDto"
}
}
}
}
},
"400": {
"description": "Bad request descriptive error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestDto"
}
}
}
},
"500": {
"description": "Internal server error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerErrorDto"
}
}
}
}
},
"tags": [
"Baseball.Head 2 Head"
]
}
}
},
"info": {
"title": "Highlightly Sports API",
"description": "Welcome to the biggest Sports Highlights API. Get access to a centralized hub for diverse and engaging sport highlights to ensure that your sport application remains dynamic, distinctive, and rich in content. Expand your applications interactiveness by integrating live events, match and team statistics, pre-match odds and much more.\n\n## Supported sports\n\n| Sport | Coverage |\n| ----------- | ----------- |\n| Football | +750 leagues |\n| Basketball | +300 leagues |\n| Hockey | +170 leagues |\n| Baseball | MLB, NCAA |\n| American Football | NFL, NCAA |\n| Cricket | +1000 leagues |\n| Rugby | +100 leagues |\n| Handball | +180 leagues |\n| Volleyball | +200 leagues |\n\n## Contact\n\nFor feature requests, questions, private plans or business inquiries you can contact us at [support@highlightly.net](mailto:support@highlightly.net).\n\nYou can also contact us via [RapidAPI](https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api) by starting a discussion or by sending us a private message.\n\n# RapidAPI integration\n\nTo start using our API services you will first need to create a [RapidAPI account](https://rapidapi.com/auth/sign-up?referral=/highlightly-api-highlightly-api-default/api/sport-highlights-api/pricing/). The platform offers you the ability to view the API analytics, manage billing settings, control API keys and much more. \n\n> Please ensure that your API key is **not** made public to prevent potential abuse. Your API key can be managed through the RapidAPI platform.\n\n## API usage\n\n> Base API url: `https://sport-highlights-api.p.rapidapi.com`\n\nEach API request will be considered valid only if the following headers are present:\n\n| Request Header | Value |\n| ----------- | ----------- |\n| `x-rapidapi-key` | *Your RapidAPI API Key* |\n| `x-rapidapi-host` | `sport-highlights-api.p.rapidapi.com` |\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": "5.0.1",
"contact": {}
},
"tags": [
{
"name": "Sports API",
"description": ""
}
],
"servers": [
{
"url": "https://sport-highlights-api.p.rapidapi.com"
}
],
"components": {
"schemas": {
"FootballCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "FR"
},
"name": {
"type": "string",
"example": "France"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/FR.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"BadRequestDto": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Descriptive bad request error message."
},
"statusCode": {
"type": "number",
"example": 400
}
},
"required": [
"message",
"statusCode"
]
},
"InternalServerErrorDto": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Internal server error."
},
"statusCode": {
"type": "number",
"example": 500
}
},
"required": [
"message",
"statusCode"
]
},
"FootballSeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2022
}
},
"required": [
"season"
]
},
"FootballLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 104
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/104.png"
},
"name": {
"type": "string",
"example": "UEFA Champions League"
},
"country": {
"$ref": "#/components/schemas/FootballCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballSeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"PaginationResponseDto": {
"type": "object",
"properties": {
"totalCount": {
"type": "number",
"description": "Available number of items, relevant to the provided query.",
"example": 490
},
"offset": {
"type": "number",
"example": 20
},
"limit": {
"type": "number",
"example": 100
}
},
"required": [
"totalCount",
"offset",
"limit"
]
},
"PlanResponseDto": {
"type": "object",
"properties": {
"tier": {
"type": "string",
"description": "Your current API subscription tier.",
"example": "BASIC"
},
"message": {
"type": "string",
"description": "Explanation message regarding your current tier.",
"example": "Some results might be hidden with FREE tier. Check your API coverage for more information: https://rapidapi.com/highlightly-api-highlightly-api-default/api/sport-highlights-api/details"
}
},
"required": [
"tier",
"message"
]
},
"FootballLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"FootballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 553
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/553.png"
},
"name": {
"type": "string",
"example": "Montpellier"
}
},
"required": [
"id",
"name"
]
},
"FootballTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"FootballTeamGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a given league/season.",
"example": 34
},
"wins": {
"type": "number",
"description": "Number of games team has won during a given league/season.",
"example": 20
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a given league/season.",
"example": 5
},
"draws": {
"type": "number",
"description": "Number of games team has drawn during a given league/season.",
"example": 5
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"FootballTeamGoalStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of goals team has scored.",
"example": 57
},
"received": {
"type": "number",
"description": "Number of goals team has received.",
"example": 39
}
},
"required": [
"scored",
"received"
]
},
"FootballDetailedTeamStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game statistics associated with given league.",
"allOf": [
{
"$ref": "#/components/schemas/FootballTeamGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored and received.",
"allOf": [
{
"$ref": "#/components/schemas/FootballTeamGoalStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"FootballTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"leagueId": {
"type": "number",
"description": "Id of league to which team statistics are associated.",
"example": 216087
},
"season": {
"type": "number",
"description": "Season year to which team statistics are associated.",
"example": 2023
},
"leagueName": {
"type": "string",
"description": "Name of league to which team statistics are associated.",
"example": "Major League Soccer"
},
"total": {
"description": "Goal and game statistics for given season/year.",
"allOf": [
{
"$ref": "#/components/schemas/FootballDetailedTeamStatsResponseDto"
}
]
},
"home": {
"description": "Goal and game statistics team has played at home for given season/year.",
"allOf": [
{
"$ref": "#/components/schemas/FootballDetailedTeamStatsResponseDto"
}
]
},
"away": {
"description": "Goal and game statistics team has played away for given season/year.",
"allOf": [
{
"$ref": "#/components/schemas/FootballDetailedTeamStatsResponseDto"
}
]
}
},
"required": [
"leagueId",
"season",
"leagueName",
"total",
"home",
"away"
]
},
"FootballMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 133
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "Ligue 1"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/133.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"FootballMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "3 - 1",
"description": "Home - Away score up to penalties."
},
"penalties": {
"type": "string",
"example": "6 - 4",
"description": "Home - Away team score after the penalties phase."
}
}
},
"FootballMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"To be announced",
"Not started",
"First half",
"Half time",
"Second half",
"Extra time",
"Break time",
"Penalties",
"Suspended",
"Interrupted",
"Finished",
"Finished after penalties",
"Finished after extra time",
"Postponed",
"Cancelled",
"Abandoned",
"Awarded",
"In progress",
"Unknown"
],
"example": "Second half",
"description": "State of the match."
},
"clock": {
"type": "number",
"example": 67,
"description": "Current minute of the match."
},
"score": {
"$ref": "#/components/schemas/FootballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"FootballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 489389
},
"round": {
"type": "string",
"example": "Regular Season - 32"
},
"date": {
"type": "string",
"example": "2023-05-20T15:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/FootballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/FootballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/FootballMatchStateResponseDto"
}
},
"required": [
"id",
"round",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"FootballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"FootballLiveEventTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 13394673
},
"logo": {
"type": "string",
"example": "https://example.com/logo/preview/66311.13394673"
},
"name": {
"type": "string",
"example": "Tersana"
}
},
"required": [
"id",
"name"
]
},
"FootballLiveEventDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/FootballLiveEventTeamDto"
},
"time": {
"type": "string",
"example": "45+1"
},
"type": {
"type": "string",
"enum": [
"Goal",
"Own Goal",
"Penalty",
"Missed Penatly",
"Yellow Card",
"Red Card",
"Substitution",
"VAR Goal Confirmed",
"VAR Goal Cancelled",
"VAR Penalty",
"VAR Penalty Cancelled",
"VAR Goal Cancelled - Offside"
],
"example": "Goal"
},
"player": {
"type": "string",
"example": "M. Mamdouh"
},
"assist": {
"type": "string",
"example": "J. Johanson"
},
"substituted": {
"type": "string"
}
},
"required": [
"team",
"time",
"type"
]
},
"FootballMatchStatisticsResponseItemDto": {
"type": "object",
"properties": {
"value": {
"type": "number",
"example": 0.62
},
"displayName": {
"type": "string",
"example": "Shots accuracy"
}
},
"required": [
"value",
"displayName"
]
},
"DetailedMatchRefereeResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Brace, Andrew"
},
"nationality": {
"type": "string",
"example": "Ireland"
}
}
},
"DetailedMatchVenueResponseDto": {
"type": "object",
"properties": {
"city": {
"type": "string",
"example": "Swansea"
},
"name": {
"type": "string",
"example": "Liberty Stadium"
},
"country": {
"type": "string",
"example": "Wales"
},
"capacity": {
"type": "string",
"example": "20827"
}
}
},
"DetailedMatchForecastResponseDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "cloudy"
},
"temperature": {
"type": "string",
"example": "11.97°C"
}
}
},
"FootballDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1002433681
},
"round": {
"type": "string",
"example": "Apertura - 9"
},
"date": {
"type": "string",
"example": "\"2024-03-31T20:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/FootballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/FootballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/FootballMatchStateResponseDto"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLiveEventDto"
}
},
"statistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchStatisticsResponseItemDto"
}
},
"referee": {
"$ref": "#/components/schemas/DetailedMatchRefereeResponseDto"
},
"venue": {
"$ref": "#/components/schemas/DetailedMatchVenueResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"round",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state",
"events",
"statistics"
]
},
"FootballHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/1.png"
},
"title": {
"type": "string",
"example": "Ligue 1: Lyon vs Reims"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/29g9urg92387"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/213123safas132e"
},
"match": {
"$ref": "#/components/schemas/FootballMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"FootballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RestrictionResponseDto": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"No restricitons applied",
"Allowed countries restriction",
"Blocked countries restriction",
"Unknown restrictions"
],
"example": "Allowed countries restriction",
"description": "Specifies which restriction rule is applied to the requested highlight. If allowed restriction is applied, read from allowedCountries field. When blocked restriction is applied, countries from blockedCountries field are applied."
},
"allowedCountries": {
"example": [
"IT"
],
"description": "ISO 3166 two letter country list of allowed countries when restriction rules is in allowed state.",
"type": "array",
"items": {
"type": "string"
}
},
"blockedCountries": {
"example": [],
"description": "ISO 3166 two letter country list of blocked countries. Rule list is valid when restriction rules is in blocked state.",
"type": "array",
"items": {
"type": "string"
}
},
"embeddable": {
"type": "boolean",
"example": true,
"description": "Boolean flag which indicates whether highlight provider allows embedding inside web applications."
}
},
"required": [
"state",
"allowedCountries",
"blockedCountries",
"embeddable"
]
},
"FootballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Stake.com"
}
},
"required": [
"id",
"name"
]
},
"FootballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"FootballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 6.6
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"FootballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 1
},
"bookmakerName": {
"type": "string",
"example": "Stake.com"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Full Time Result"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"FootballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 884822928
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"FootballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"FootballStandingsStatsDto": {
"type": "object",
"properties": {
"wins": {
"type": "number",
"example": 11
},
"draws": {
"type": "number",
"example": 4
},
"games": {
"type": "number",
"example": 17
},
"loses": {
"type": "number",
"example": 5
},
"scoredGoals": {
"type": "number",
"example": 28
},
"receivedGoals": {
"type": "number",
"example": 27
}
},
"required": [
"wins",
"draws",
"games",
"loses",
"scoredGoals",
"receivedGoals"
]
},
"FootballStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 56950
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/56950.png"
},
"name": {
"type": "string",
"example": "Aston Villa"
}
},
"required": [
"id",
"name"
]
},
"FootballStandingsDto": {
"type": "object",
"properties": {
"away": {
"$ref": "#/components/schemas/FootballStandingsStatsDto"
},
"home": {
"$ref": "#/components/schemas/FootballStandingsStatsDto"
},
"team": {
"$ref": "#/components/schemas/FootballStandingsTeamDto"
},
"total": {
"$ref": "#/components/schemas/FootballStandingsStatsDto"
},
"points": {
"type": "number",
"example": 63
},
"position": {
"type": "number",
"example": 4
}
},
"required": [
"team",
"total",
"points",
"position"
]
},
"FootballStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Premier League - Regular Season"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"FootballStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 33973
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/33973.png"
},
"name": {
"type": "string",
"example": "Premier League"
},
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"id",
"name",
"season"
]
},
"FootballStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/FootballStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"FootballLineupsPlayerDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Lilian Raolisoa"
},
"number": {
"type": "number",
"example": 27
},
"position": {
"type": "string",
"example": "Defender"
}
},
"required": [
"name",
"number",
"position"
]
},
"FootballLineupsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 66311
},
"logo": {
"type": "string",
"example": "https://example.com/logo/preview/66311.png"
},
"formation": {
"type": "string",
"example": "4-2-3-1"
},
"name": {
"type": "string",
"example": "Angers"
},
"substitutes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLineupsPlayerDto"
}
},
"initialLineup": {
"description": "2D grid of players representing their position on the board. The first entry will always be the goal keeper. Other entries will follow the team formation, e.g. formation 4-2-3-1 means that there will be 4 more arrays each containing the associated number of players in the correct order.",
"example": [
[
{
"name": "Yahia Fofana",
"number": 30,
"position": "Goalkeeper"
}
],
[
{
"name": "Florent Hanin",
"number": 26,
"position": "Defender"
},
{
"name": "Jordan Lefort",
"number": 21,
"position": "Defender"
},
{
"name": "Cédric Hountondji",
"number": 22,
"position": "Defender"
},
{
"name": "Yan Valery",
"number": 2,
"position": "Defender"
}
],
[
{
"name": "Himad Abdelli",
"number": 10,
"position": "Midfielder"
},
{
"name": "Zinédine Ould Khaled",
"number": 12,
"position": "Midfielder"
}
],
[
{
"name": "Justin-Noel Kalumba",
"number": 17,
"position": "Midfielder"
},
{
"name": "Pierrick Capelle",
"number": 15,
"position": "Midfielder"
},
{
"name": "Farid El Melali",
"number": 28,
"position": "Midfielder"
}
],
[
{
"name": "Loïs Diony",
"number": 9,
"position": "Forward"
}
]
],
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballLineupsPlayerDto"
}
}
},
"required": [
"id",
"logo",
"formation",
"name",
"substitutes",
"initialLineup"
]
},
"FootballLineupsResponseDto": {
"type": "object",
"properties": {
"homeTeam": {
"$ref": "#/components/schemas/FootballLineupsTeamDto"
},
"awayTeam": {
"$ref": "#/components/schemas/FootballLineupsTeamDto"
}
},
"required": [
"homeTeam",
"awayTeam"
]
},
"FootballMatchStatisticsResponseDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/FootballTeamResponseDto"
},
"statistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FootballMatchStatisticsResponseItemDto"
}
}
},
"required": [
"team",
"statistics"
]
},
"NotFoundDto": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Not Found"
},
"statusCode": {
"type": "number",
"example": 404
}
},
"required": [
"message",
"statusCode"
]
},
"AmericanFootballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/111.png"
},
"name": {
"type": "string",
"example": "Saints"
},
"displayName": {
"type": "string",
"example": "New Orleans Saints"
},
"abbreviation": {
"type": "string",
"example": "NO"
},
"league": {
"type": "string",
"example": "NFL"
}
},
"required": [
"id",
"displayName",
"abbreviation",
"league"
]
},
"AmfTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league round.",
"example": 67
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league round.",
"example": 24
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league round.",
"example": 43
}
},
"required": [
"played",
"wins",
"loses"
]
},
"AmfTeamTotalPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 1369,
"description": "Number of points team has scored during a specific league round."
},
"received": {
"type": "number",
"example": 1619,
"description": "Number of points team has received during a specific league round."
}
},
"required": [
"scored",
"received"
]
},
"AmfTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamTotalGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored, and received during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamTotalPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"AmfTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league round.",
"example": 33
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league round.",
"example": 13
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league round.",
"example": 20
}
},
"required": [
"played",
"wins",
"loses"
]
},
"AmfTeamHomePointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored whilst playing as home team during a specific league round.",
"example": 694
},
"received": {
"type": "number",
"description": "Number of points team has received whilst playing as home team during a specific league round.",
"example": 713
}
},
"required": [
"scored",
"received"
]
},
"AmfTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league round, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamHomeGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received, during a specific league round, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamHomePointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"AmfTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league round.",
"example": 34
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league round.",
"example": 11
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league round.",
"example": 23
}
},
"required": [
"played",
"wins",
"loses"
]
},
"AmfTeamAwayPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored as away team, during a specific league round.",
"example": 675
},
"received": {
"type": "number",
"description": "Number of points team has received as away team, during a specific league round.",
"example": 906
}
},
"required": [
"scored",
"received"
]
},
"AmfTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamAwayGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received as away team, during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamAwayPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"AmfTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league round, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league round, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/AmfTeamAwayStatsResponseDto"
}
]
},
"leagueName": {
"type": "string",
"example": "NFL",
"description": "League name to which team statistics are associated."
},
"round": {
"type": "string",
"example": "regular-season",
"description": "Round to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueName",
"round"
]
},
"AmericanFootballMatchTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/111.png"
},
"name": {
"type": "string",
"example": "Saints"
},
"displayName": {
"type": "string",
"example": "New Orleans Saints"
},
"abbreviation": {
"type": "string",
"example": "NO"
}
},
"required": [
"id",
"displayName",
"abbreviation"
]
},
"AmericanFootballMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "21 - 7",
"description": "Home - Away score for the match."
},
"firstPeriod": {
"type": "string",
"example": "0 - 0",
"description": "Home - Away score in 1st period."
},
"secondPeriod": {
"type": "string",
"example": "7 - 7",
"description": "Home - Away score in 2nd period."
},
"thirdPeriod": {
"type": "string",
"example": "7 - 0",
"description": "Home - Away score in 3rd period."
},
"fourthPeriod": {
"type": "string",
"example": "7 - 0",
"description": "Home - Away score in 4th period."
}
}
},
"AmericanFootballMatchStateResponseDto": {
"type": "object",
"properties": {
"period": {
"type": "number",
"description": "Current in play period.",
"example": 2
},
"clock": {
"type": "number",
"description": "Current minute of the in play period.",
"example": 8
},
"description": {
"type": "string",
"enum": [
"Suspended",
"Postponed",
"Cancelled",
"Abandoned",
"Finished",
"In progress",
"End period",
"Half time",
"Unknown",
"Scheduled"
],
"example": "In progress",
"description": "Current status/description of the match."
},
"score": {
"$ref": "#/components/schemas/AmericanFootballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"AmericanFootballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"round": {
"type": "string",
"example": "Regular Season - 32"
},
"date": {
"type": "string",
"example": "2023-05-20T15:30:00.000Z"
},
"league": {
"type": "string",
"example": "NFL"
},
"season": {
"type": "number",
"example": 2023
},
"awayTeam": {
"$ref": "#/components/schemas/AmericanFootballMatchTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/AmericanFootballMatchTeamResponseDto"
},
"state": {
"$ref": "#/components/schemas/AmericanFootballMatchStateResponseDto"
}
},
"required": [
"id",
"round",
"date",
"league",
"season",
"awayTeam",
"homeTeam",
"state"
]
},
"AmericanFootballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"AmericanFootballMatchVenueResponseDto": {
"type": "object",
"properties": {
"city": {
"type": "string",
"example": "Toronto"
},
"name": {
"type": "string",
"example": "Rogers Centre"
},
"state": {
"type": "string",
"example": "Ontario"
}
},
"required": [
"city",
"name",
"state"
]
},
"AmericanFootballDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"round": {
"type": "string",
"example": "Regular Season - 32"
},
"date": {
"type": "string",
"example": "2023-05-20T15:30:00.000Z"
},
"league": {
"type": "string",
"example": "NFL"
},
"season": {
"type": "number",
"example": 2023
},
"awayTeam": {
"$ref": "#/components/schemas/AmericanFootballMatchTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/AmericanFootballMatchTeamResponseDto"
},
"state": {
"$ref": "#/components/schemas/AmericanFootballMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/AmericanFootballMatchVenueResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"round",
"date",
"league",
"season",
"awayTeam",
"homeTeam",
"state"
]
},
"AmericanFootballHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/1.png"
},
"title": {
"type": "string",
"example": "NFL: New Orleans Saints vs Kansas City Chiefs"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/v23r23fds2cff"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/v23r23fds2cff"
},
"match": {
"$ref": "#/components/schemas/AmericanFootballMatchResponseDto"
},
"channel": {
"type": "string",
"example": "NFL",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"AmericanFootballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"AmericanFootballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 53
},
"name": {
"type": "string",
"example": "Megapari Sport"
}
},
"required": [
"id",
"name"
]
},
"AmericanFootballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"AmericanFootballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 2.8
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"AmericanFootballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 53
},
"bookmakerName": {
"type": "string",
"example": "Megapari Sport"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Odd or Even"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"AmericanFootballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 394
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"AmericanFootballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmericanFootballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU"
},
"name": {
"type": "string",
"example": "Australia"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/AU.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"BasketballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 7592
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/7592.png"
},
"name": {
"type": "string",
"example": "Adelaide"
}
},
"required": [
"id",
"name"
]
},
"BasketballMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1635
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "NBL"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/1635.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"BasketballMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "105 - 104",
"description": "Home - Away score for the match. Includes overtime as well."
},
"q1": {
"type": "string",
"example": "22 - 15",
"description": "Home - Away score in 1st quarter."
},
"q2": {
"type": "string",
"example": "17 - 33",
"description": "Home - Away score in 2nd quarter."
},
"q3": {
"type": "string",
"example": "11 - 27",
"description": "Home - Away score in 3rd quarter."
},
"q4": {
"type": "string",
"example": "33 - 14",
"description": "Home - Away score in 4th quarter."
},
"overTime": {
"type": "string",
"example": "22 - 15",
"description": "Home - Away score in overtime."
}
}
},
"BasketballMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Not started",
"First quarter",
"Second quarter",
"Third quarter",
"Fourth quarter",
"Over time",
"Break time",
"Half time",
"Finished",
"Finished after over time",
"Postponed",
"Cancelled",
"Suspended",
"Awarded",
"Abandoned",
"Unknown",
"To be announced"
],
"example": "Finished",
"description": "State of the match."
},
"clock": {
"type": "number",
"example": 9,
"description": "Current minute of the current period."
},
"score": {
"$ref": "#/components/schemas/BasketballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"BasketballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 489389
},
"week": {
"type": "string",
"example": "1"
},
"stage": {
"type": "string",
"example": "Final"
},
"date": {
"type": "string",
"example": "2023-10-01T03:00:00.000Z"
},
"country": {
"$ref": "#/components/schemas/BasketballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/BasketballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/BasketballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/BasketballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/BasketballMatchStateResponseDto"
}
},
"required": [
"id",
"stage",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"BasketballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"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"
}
},
"required": [
"id",
"stage",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"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."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"BasketballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballSeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"season"
]
},
"BasketballLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1635
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/1635.png"
},
"name": {
"type": "string",
"example": "NBL"
},
"country": {
"$ref": "#/components/schemas/BasketballCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballSeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"BasketballLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league-season.",
"example": 42
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league-season.",
"example": 36
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league-season.",
"example": 6
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BasketballTeamTotalPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 3722,
"description": "Number of points team has scored during a specific league-season."
},
"received": {
"type": "number",
"example": 3328,
"description": "Number of points team has received during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"BasketballTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamTotalGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored, and received during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamTotalPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BasketballTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league-season.",
"example": 22
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league-season.",
"example": 20
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league-season.",
"example": 2
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BasketballTeamHomePointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored whilst playing as home team during a specific league-season.",
"example": 2015
},
"received": {
"type": "number",
"description": "Number of points team has received whilst playing as home team during a specific league-season.",
"example": 1733
}
},
"required": [
"scored",
"received"
]
},
"BasketballTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamHomeGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received, during a specific league-season, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamHomePointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BasketballTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as away team during a specific league-season.",
"example": 20
},
"wins": {
"type": "number",
"description": "Number of games team has won as away team during a specific league-season.",
"example": 16
},
"loses": {
"type": "number",
"description": "Number of games team has lost as away team during a specific league-season.",
"example": 4
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BasketballTeamAwayPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored as away team, during a specific league-season.",
"example": 1707
},
"received": {
"type": "number",
"description": "Number of points team has received as away team, during a specific league-season.",
"example": 1595
}
},
"required": [
"scored",
"received"
]
},
"BasketballTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamAwayGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamAwayPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BasketballTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/BasketballTeamAwayStatsResponseDto"
}
]
},
"leagueId": {
"type": "number",
"example": 100351,
"description": "League id to which team statistics are associated."
},
"leagueName": {
"type": "string",
"example": "ACB",
"description": "League name to which team statistics are associated."
},
"season": {
"type": "number",
"example": 2023,
"description": "Season year to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueId",
"leagueName",
"season"
]
},
"BasketballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Stake.com"
}
},
"required": [
"id",
"name"
]
},
"BasketballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 1.75
},
"value": {
"type": "string",
"example": "Over"
}
},
"required": [
"odd",
"value"
]
},
"BasketballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 75
},
"bookmakerName": {
"type": "string",
"example": "Powbet"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Total Points 161.5"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"BasketballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 298649022
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"BasketballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BasketballStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 14400
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/14400.png"
},
"name": {
"type": "string",
"example": "Monaco"
}
},
"required": [
"id",
"name"
]
},
"BasketballStandingsDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/BasketballStandingsTeamDto"
},
"wins": {
"type": "number",
"example": 28
},
"loses": {
"type": "number",
"example": 4
},
"position": {
"type": "number",
"example": 1
},
"gamesPlayed": {
"type": "number",
"example": 32
},
"scoredPoints": {
"type": "number",
"example": 2759
},
"receivedPoints": {
"type": "number",
"example": 2383
}
},
"required": [
"team",
"wins",
"loses",
"position",
"gamesPlayed",
"scoredPoints",
"receivedPoints"
]
},
"BasketballStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Regular Season"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"BasketballStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2486
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/2486.png"
},
"name": {
"type": "string",
"example": "LNB"
},
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"id",
"name",
"season"
]
},
"BasketballStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasketballStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/BasketballStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"HockeyCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE"
},
"name": {
"type": "string",
"example": "Germany"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/DE.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"HockeyTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 223746
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/223746.png"
},
"name": {
"type": "string",
"example": "Frankfurt Lowen"
}
},
"required": [
"id",
"name"
]
},
"HockeyMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 16953
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "DEL"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/16953.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"HockeyMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "4 - 4",
"description": "Home - Away score for the match."
},
"overTime": {
"type": "string",
"example": "6 - 4",
"description": "Home - Away score in overtime."
},
"penalties": {
"type": "string",
"example": "17 - 33",
"description": "Home - Away score in penalties."
},
"firstPeriod": {
"type": "string",
"example": "2 - 0",
"description": "Home - Away score in 1st period."
},
"secondPeriod": {
"type": "string",
"example": "2 - 1",
"description": "Home - Away score in 2nd period."
},
"thirdPeriod": {
"type": "string",
"example": "5 - 2",
"description": "Home - Away score in 3rd period."
}
}
},
"HockeyMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Not started",
"1st period",
"2nd period",
"3rd period",
"Over time",
"Penalties",
"Break time",
"Awarded",
"Postponed",
"Cancelled",
"Interrupted",
"Abandoned",
"Finished",
"To be announced",
"Finished after penalties",
"Finished after over time",
"Unknown"
],
"example": "1st period",
"description": "Current state of the game."
},
"score": {
"$ref": "#/components/schemas/HockeyMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"HockeyMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 291869956
},
"week": {
"type": "string",
"example": "1"
},
"date": {
"type": "string",
"example": "2023-10-13T17:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/HockeyCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/HockeyMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/HockeyMatchStateResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"HockeyHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 16
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/16.png"
},
"title": {
"type": "string",
"example": "DEL: Frankfurt Lowen vs Kolner"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/13efe2g4t542"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/13efe2g4t542"
},
"match": {
"$ref": "#/components/schemas/HockeyMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"HockeyHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeySeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"season"
]
},
"HockeyLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 16953
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/16953.png"
},
"name": {
"type": "string",
"example": "DEL"
},
"country": {
"$ref": "#/components/schemas/HockeyCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeySeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"HockeyLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeyMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeyDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 308606573
},
"week": {
"type": "string",
"example": "Quarter-finals"
},
"date": {
"type": "string",
"example": "2024-03-30T15:00:00.000Z"
},
"country": {
"$ref": "#/components/schemas/HockeyCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/HockeyMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/HockeyMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/DetailedMatchVenueResponseDto"
},
"referee": {
"$ref": "#/components/schemas/DetailedMatchRefereeResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"HockeyTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeyTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league-season.",
"example": 114
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league-season.",
"example": 72
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league-season.",
"example": 42
}
},
"required": [
"played",
"wins",
"loses"
]
},
"HockeyTeamTotalGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 366,
"description": "Number of goals team has scored during a specific league-season."
},
"received": {
"type": "number",
"example": 283,
"description": "Number of goals team has received during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"HockeyTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamTotalGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored, and received during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamTotalGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HockeyTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league-season.",
"example": 58
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league-season.",
"example": 38
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league-season.",
"example": 20
}
},
"required": [
"played",
"wins",
"loses"
]
},
"HockeyTeamHomeGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of goals team has scored whilst playing as home team during a specific league-season.",
"example": 186
},
"received": {
"type": "number",
"description": "Number of goals team has received whilst playing as home team during a specific league-season.",
"example": 141
}
},
"required": [
"scored",
"received"
]
},
"HockeyTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamHomeGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored and received, during a specific league-season, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamHomeGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HockeyTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as away team during a specific league-season.",
"example": 56
},
"wins": {
"type": "number",
"description": "Number of games team has won as away team during a specific league-season.",
"example": 34
},
"loses": {
"type": "number",
"description": "Number of games team has lost as away team during a specific league-season.",
"example": 22
}
},
"required": [
"played",
"wins",
"loses"
]
},
"HockeyTeamAwayGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of goals team has scored as away team, during a specific league-season.",
"example": 180
},
"received": {
"type": "number",
"description": "Number of goals team has received as away team, during a specific league-season.",
"example": 142
}
},
"required": [
"scored",
"received"
]
},
"HockeyTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamAwayGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored and received as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamAwayGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HockeyTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/HockeyTeamAwayStatsResponseDto"
}
]
},
"leagueId": {
"type": "number",
"example": 49291,
"description": "League id to which team statistics are associated."
},
"leagueName": {
"type": "string",
"example": "NHL",
"description": "League name to which team statistics are associated."
},
"season": {
"type": "number",
"example": 2023,
"description": "Season year to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueId",
"leagueName",
"season"
]
},
"HockeyBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Stake.com"
}
},
"required": [
"id",
"name"
]
},
"HockeyBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeyMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 2.2
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"HockeyMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 19
},
"bookmakerName": {
"type": "string",
"example": "1Bet"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "3-Way Moneyline"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"HockeyOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 295119925
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"HockeyOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HockeyStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1330897
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/1330897.png"
},
"name": {
"type": "string",
"example": "Finland U20"
}
},
"required": [
"id",
"name"
]
},
"HockeyStandingsDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/HockeyStandingsTeamDto"
},
"position": {
"type": "number",
"example": 1
},
"wins": {
"type": "number",
"example": 3
},
"gamesPlayed": {
"type": "number",
"example": 3
},
"loses": {
"type": "number",
"example": 0
},
"scoredGoals": {
"type": "number",
"example": 11
},
"winsOvertime": {
"type": "number",
"example": 0
},
"losesOvertime": {
"type": "number",
"example": 0
},
"receivedGoals": {
"type": "number",
"example": 2
}
},
"required": [
"team",
"position",
"wins",
"gamesPlayed",
"loses",
"scoredGoals",
"winsOvertime",
"losesOvertime",
"receivedGoals"
]
},
"HockeyStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Group A"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"HockeyStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 130987
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/130987.png"
},
"name": {
"type": "string",
"example": "WCH U20"
},
"season": {
"type": "number",
"example": 2022
}
},
"required": [
"id",
"name",
"season"
]
},
"HockeyStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HockeyStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/HockeyStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"RugbyCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "EU"
},
"name": {
"type": "string",
"example": "Europe"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/EU.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"RugbyTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 384585
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/90990.png"
},
"name": {
"type": "string",
"example": "Italy U20"
}
},
"required": [
"id",
"name"
]
},
"RugbyMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 48440
},
"season": {
"type": "number",
"example": 2024
},
"name": {
"type": "string",
"example": "Six Nations U20"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/48440.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"RugbyMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Not started",
"First half",
"Half time",
"Second half",
"Extra time",
"Break time",
"Penalties",
"Suspended",
"Interrupted",
"Finished",
"Finished after extra time",
"Postponed",
"Cancelled",
"Abandoned",
"Awarded",
"Unknown",
"To be announced"
],
"example": "Finished",
"description": "State of the match."
},
"score": {
"type": "string",
"example": "47 - 14",
"description": "Home - Away match score."
}
},
"required": [
"description"
]
},
"RugbyMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 36224450
},
"week": {
"type": "string",
"example": "4"
},
"date": {
"type": "string",
"example": "2024-03-08T19:15:00.000Z"
},
"country": {
"$ref": "#/components/schemas/RugbyCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/RugbyMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/RugbyMatchStateResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"RugbyHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/28.png"
},
"title": {
"type": "string",
"example": "HIGHLIGHTS | Italy v Scotland | Under-20 Six Nations Championship 2024"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/213123safas132e"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/13efe2g4t542"
},
"match": {
"$ref": "#/components/schemas/RugbyMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"RugbyHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbySeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2024
}
},
"required": [
"season"
]
},
"RugbyLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 48440
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/48440.png"
},
"name": {
"type": "string",
"example": "Six Nations U20"
},
"country": {
"$ref": "#/components/schemas/RugbyCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbySeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"RugbyLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbyMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbyDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 36125734
},
"week": {
"type": "string",
"example": "14"
},
"date": {
"type": "string",
"example": "2024-03-30T15:00:00.000Z"
},
"country": {
"$ref": "#/components/schemas/RugbyCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/RugbyMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/RugbyMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/DetailedMatchVenueResponseDto"
},
"referee": {
"$ref": "#/components/schemas/DetailedMatchRefereeResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"RugbyTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbyTotalGamesResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played within given league-season.",
"example": 16
},
"wins": {
"type": "number",
"description": "Number of games team has won within associated league-season.",
"example": 11
},
"loses": {
"type": "number",
"description": "Number of games team has lost within associated league-season.",
"example": 5
},
"draws": {
"type": "number",
"description": "Number of games team has drawn within associated league-season.",
"example": 0
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"RugbyTotalPointsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 463,
"description": "Number of total points a team has scored."
},
"received": {
"type": "number",
"example": 344,
"description": "Number of total points a team has received."
}
},
"required": [
"scored",
"received"
]
},
"RugbyTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Total number of games team has won, drawn, or lost",
"allOf": [
{
"$ref": "#/components/schemas/RugbyTotalGamesResponseDto"
}
]
},
"points": {
"description": "Total number of points team has scored and received.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyTotalPointsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"RugbyHomeGamesResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played within given league-season.",
"example": 8
},
"wins": {
"type": "number",
"description": "Number of games team has won within associated league-season.",
"example": 5
},
"loses": {
"type": "number",
"description": "Number of games team has lost within associated league-season.",
"example": 0
},
"draws": {
"type": "number",
"description": "Number of games team has drawn within associated league-season.",
"example": 3
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"RugbyHomePointsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 229,
"description": "Total number of points team has scored whilst playing at home during a specific league-season."
},
"received": {
"type": "number",
"example": 172,
"description": "Total number of points team has received whilst playing at home during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"RugbyHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Total number of games team has played, won, and lost at home, during a specific league-season",
"allOf": [
{
"$ref": "#/components/schemas/RugbyHomeGamesResponseDto"
}
]
},
"points": {
"description": "Total number of points team has scored and received at home, during a specific league-season",
"allOf": [
{
"$ref": "#/components/schemas/RugbyHomePointsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"RugbyAwayGamesResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Total number of games team has played as away team during a specific league-season.",
"example": 8
},
"wins": {
"type": "number",
"description": "Total number of games team has won as away team during a specific league-season.",
"example": 5
},
"draws": {
"type": "number",
"description": "Total number of games team has drawn as away team during a specific league-season.",
"example": 0
},
"loses": {
"type": "number",
"description": "Total number of games team has lost as away team during a specific league-season.",
"example": 3
}
},
"required": [
"played",
"wins",
"draws",
"loses"
]
},
"RugbyAwayPointsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 234,
"description": "Total number of points team has scored as away team during a specific league-season."
},
"received": {
"type": "number",
"example": 172,
"description": "Total number of points team has received as away team during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"RugbyAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Total number of games team has played, won, and lost during a specific league-season whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyAwayGamesResponseDto"
}
]
},
"points": {
"description": "Total number of points team has scored and received during a specific league-season whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyAwayPointsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"RugbyTeamStatsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Games and points statistics for the whole league-season.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyTotalStatsResponseDto"
}
]
},
"home": {
"description": "Total number of games and points the team has scored and received during a specific league-season whilst playing as the home team.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyHomeStatsResponseDto"
}
]
},
"away": {
"description": "Total number of games and points team has scored and received during a specific league-season whilst playing as the away team.",
"allOf": [
{
"$ref": "#/components/schemas/RugbyAwayStatsResponseDto"
}
]
},
"leagueId": {
"type": "number",
"description": "League id corresponding to summarized statistics.",
"example": 38228
},
"leagueName": {
"type": "string",
"description": "League name corresponding to summarized statistics.",
"example": "Major League Rugby"
},
"season": {
"type": "number",
"description": "Season year associated to team statistics.",
"example": "Major League Rugby"
}
},
"required": [
"total",
"home",
"away",
"leagueId",
"leagueName",
"season"
]
},
"RugbyBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 5
},
"name": {
"type": "string",
"example": "Marathonbet"
}
},
"required": [
"id",
"name"
]
},
"RugbyBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbyMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 1.92
},
"value": {
"type": "string",
"example": "Over"
}
},
"required": [
"odd",
"value"
]
},
"RugbyMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 1
},
"bookmakerName": {
"type": "string",
"example": "Bets10"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Over/Under 58.5"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"RugbyOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 34909655
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"RugbyOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"RugbyStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 361608
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/361608.png"
},
"name": {
"type": "string",
"example": "Germany 7s"
}
},
"required": [
"id",
"name"
]
},
"RugbyStandingsDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/RugbyStandingsTeamDto"
},
"wins": {
"type": "number",
"example": 3
},
"loses": {
"type": "number",
"example": 0
},
"draws": {
"type": "number",
"example": 0
},
"position": {
"type": "number",
"example": 1
},
"points": {
"type": "number",
"example": 9
},
"gamesPlayed": {
"type": "number",
"example": 18
},
"scoredPoints": {
"type": "number",
"example": 53
},
"receivedPoints": {
"type": "number",
"example": 10
}
},
"required": [
"team",
"wins",
"loses",
"draws",
"position",
"points",
"gamesPlayed",
"scoredPoints",
"receivedPoints"
]
},
"RugbyStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Group A"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"RugbyStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 69715
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/69715.png"
},
"name": {
"type": "string",
"example": "Sevens Europe Series - Portugal"
},
"season": {
"type": "number",
"example": 2022
}
},
"required": [
"id",
"name",
"season"
]
},
"RugbyStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RugbyStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/RugbyStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"HandballCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "DE"
},
"name": {
"type": "string",
"example": "Germany"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/DE.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"HandballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 332674
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/332674.png"
},
"name": {
"type": "string",
"example": "Solingen W"
}
},
"required": [
"id",
"name"
]
},
"HandballMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 36526
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "1. Bundesliga Women"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/36526.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"HandballMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "26 - 26",
"description": "Home - Away match score."
},
"firstHalf": {
"type": "string",
"example": "13 - 15",
"description": "Home - Away match score in the first half."
},
"secondHalf": {
"type": "string",
"example": "13 - 11",
"description": "Home - Away match score in the second half."
}
}
},
"HandballMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Not started",
"First half",
"Half time",
"Second half",
"Extra time",
"Break time",
"Penalties",
"Suspended",
"Interrupted",
"Finished",
"Postponed",
"Cancelled",
"Abandoned",
"Awarded",
"Unknown",
"To be announced",
"Finished after penalties",
"Finished after extra time"
],
"example": "Finished",
"description": "State of the match."
},
"score": {
"$ref": "#/components/schemas/HandballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"HandballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 126347903
},
"week": {
"type": "object",
"example": "9"
},
"date": {
"type": "string",
"example": "2023-12-27T18:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/HandballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/HandballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/HandballMatchStateResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"HandballHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/1.png"
},
"title": {
"type": "string",
"example": "1. Bundesliga Women: Bensheim-Auerbach W vs Solingen W"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/13efe2g4t542"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/13efe2g4t542"
},
"match": {
"$ref": "#/components/schemas/HandballMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"HandballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballSeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"season"
]
},
"HandballLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 36526
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/36526.png"
},
"name": {
"type": "string",
"example": "1. Bundesliga Women"
},
"country": {
"$ref": "#/components/schemas/HandballCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballSeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"HandballLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 127484839
},
"week": {
"type": "object",
"example": "21"
},
"date": {
"type": "string",
"example": "2024-04-06T16:00:00.000Z"
},
"country": {
"$ref": "#/components/schemas/HandballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/HandballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/HandballMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/DetailedMatchVenueResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"HandballTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league-season.",
"example": 30
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league-season.",
"example": 20
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league-season.",
"example": 7
},
"draws": {
"type": "number",
"description": "Number of games team has played a draw during a specific league-season.",
"example": 3
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"HandballTeamTotalGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 935,
"description": "Number of goals team has scored during a specific league-season."
},
"received": {
"type": "number",
"example": 815,
"description": "Number of goals team has received during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"HandballTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamTotalGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored, and received during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamTotalGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HandballTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league-season.",
"example": 15
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league-season.",
"example": 12
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league-season.",
"example": 1
},
"draws": {
"type": "number",
"description": "Number of games team has played a draw as home team during a specific league-season.",
"example": 1
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"HandballTeamHomeGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of goals team has scored whilst playing as home team during a specific league-season.",
"example": 500
},
"received": {
"type": "number",
"description": "Number of goals team has received whilst playing as home team during a specific league-season.",
"example": 399
}
},
"required": [
"scored",
"received"
]
},
"HandballTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamHomeGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of points team has scored and received, during a specific league-season, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamHomeGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HandballTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league-season.",
"example": 15
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league-season.",
"example": 8
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league-season.",
"example": 6
},
"draws": {
"type": "number",
"description": "Number of games team has played a draw as home team during a specific league-season.",
"example": 1
}
},
"required": [
"played",
"wins",
"loses",
"draws"
]
},
"HandballTeamAwayGoalsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored as away team, during a specific league-season.",
"example": 435
},
"received": {
"type": "number",
"description": "Number of points team has received as away team, during a specific league-season.",
"example": 416
}
},
"required": [
"scored",
"received"
]
},
"HandballTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamAwayGameStatsResponseDto"
}
]
},
"goals": {
"description": "Number of goals team has scored and received as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamAwayGoalsStatsResponseDto"
}
]
}
},
"required": [
"games",
"goals"
]
},
"HandballTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/HandballTeamAwayStatsResponseDto"
}
]
},
"leagueId": {
"type": "number",
"example": 88437,
"description": "League id to which team statistics are associated."
},
"leagueName": {
"type": "string",
"example": "Liga ASOBAL",
"description": "League name to which team statistics are associated."
},
"season": {
"type": "number",
"example": 2023,
"description": "Season year to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueId",
"leagueName",
"season"
]
},
"HandballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Stake.com"
}
},
"required": [
"id",
"name"
]
},
"HandballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 1.7
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"HandballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 3
},
"bookmakerName": {
"type": "string",
"example": "22Bet"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Full Time Result"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"HandballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 123121762
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"HandballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"HandballStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2266146
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/2266146.png"
},
"name": {
"type": "string",
"example": "France"
}
},
"required": [
"id",
"name"
]
},
"HandballStandingsDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/HandballStandingsTeamDto"
},
"position": {
"type": "number",
"example": 1
},
"wins": {
"type": "number",
"example": 3
},
"draws": {
"type": "number",
"example": 1
},
"gamesPlayed": {
"type": "number",
"example": 4
},
"loses": {
"type": "number",
"example": 0
},
"scoredGoals": {
"type": "number",
"example": 111
},
"receivedGoals": {
"type": "number",
"example": 109
}
},
"required": [
"team",
"position",
"wins",
"draws",
"gamesPlayed",
"loses",
"scoredGoals",
"receivedGoals"
]
},
"HandballStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Regular Season"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"HandballStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 171835
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/171835.png"
},
"name": {
"type": "string",
"example": "Golden League - France"
},
"season": {
"type": "number",
"example": 2024
}
},
"required": [
"id",
"name",
"season"
]
},
"HandballStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandballStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/HandballStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"VolleyballCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "IT"
},
"name": {
"type": "string",
"example": "Italy"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/IT.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"VolleyballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 630524
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/630524.png"
},
"name": {
"type": "string",
"example": "Trentino"
}
},
"required": [
"id",
"name"
]
},
"VolleyballMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 83331
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "SuperLega"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/83331.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"VolleyballMatchScoreResponseDto": {
"type": "object",
"properties": {
"current": {
"type": "string",
"example": "3 - 1",
"description": "Home - Away score for the match."
},
"firstSet": {
"type": "string",
"example": "19 - 25",
"description": "Home - Away score for the first set."
},
"secondSet": {
"type": "string",
"example": "25 - 12",
"description": "Home - Away score for the second set."
},
"thirdSet": {
"type": "string",
"example": "22 - 17",
"description": "Home - Away score for the third set."
},
"fourthSet": {
"type": "string",
"example": "22 - 17",
"description": "Home - Away score for the fourth set."
},
"fifthSet": {
"type": "string",
"example": "25 - 19",
"description": "Home - Away score for the fifth set."
}
}
},
"VolleyballMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Not started",
"First set",
"Second set",
"Third set",
"Fourth set",
"Fifth set",
"Awarded",
"Postponed",
"Cancelled",
"Interrupted",
"Abandoned",
"Finished",
"Unknown",
"To be announced"
],
"example": "Second set",
"description": "State of the match."
},
"score": {
"$ref": "#/components/schemas/VolleyballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"VolleyballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 126347903
},
"week": {
"type": "string",
"example": "12"
},
"date": {
"type": "string",
"example": "2023-12-30T17:00:00.000Z"
},
"country": {
"$ref": "#/components/schemas/VolleyballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/VolleyballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/VolleyballMatchStateResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"VolleyballHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/1.png"
},
"title": {
"type": "string",
"example": "SuperLega: Trentino vs Cisterna"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/13efe2g4t542"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/13efe2g4t542"
},
"match": {
"$ref": "#/components/schemas/VolleyballMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"VolleyballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballSeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"season"
]
},
"VolleyballLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 83331
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/83331.png"
},
"name": {
"type": "string",
"example": "SuperLega"
},
"country": {
"$ref": "#/components/schemas/VolleyballCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballSeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"VolleyballLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 139134178
},
"week": {
"type": "string",
"example": "Semi-finals"
},
"date": {
"type": "string",
"example": "2024-04-06T14:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/VolleyballCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/VolleyballMatchLeagueResponseDto"
},
"state": {
"$ref": "#/components/schemas/VolleyballMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/DetailedMatchVenueResponseDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"date",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"VolleyballTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league-season.",
"example": 31
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league-season.",
"example": 13
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league-season.",
"example": 18
}
},
"required": [
"played",
"wins",
"loses"
]
},
"VolleyballTeamTotalPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 47,
"description": "Number of points team has scored during a specific league-season."
},
"received": {
"type": "number",
"example": 13,
"description": "Number of points team has received during a specific league-season."
}
},
"required": [
"scored",
"received"
]
},
"VolleyballTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamTotalGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored, and received during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamTotalPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"VolleyballTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league-season.",
"example": 14
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league-season.",
"example": 8
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league-season.",
"example": 6
}
},
"required": [
"played",
"wins",
"loses"
]
},
"VolleyballTeamHomePointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored whilst playing as home team during a specific league-season.",
"example": 26
},
"received": {
"type": "number",
"description": "Number of points team has received whilst playing as home team during a specific league-season.",
"example": 28
}
},
"required": [
"scored",
"received"
]
},
"VolleyballTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league-season, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamHomeGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received, during a specific league-season, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamHomePointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"VolleyballTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as away team during a specific league-season.",
"example": 17
},
"wins": {
"type": "number",
"description": "Number of games team has won as away team during a specific league-season.",
"example": 5
},
"loses": {
"type": "number",
"description": "Number of games team has lost as away team during a specific league-season.",
"example": 12
}
},
"required": [
"played",
"wins",
"loses"
]
},
"VolleyballTeamAwayPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored as away team, during a specific league-season.",
"example": 21
},
"received": {
"type": "number",
"description": "Number of points team has received as away team, during a specific league-season.",
"example": 45
}
},
"required": [
"scored",
"received"
]
},
"VolleyballTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamAwayGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received as away team, during a specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamAwayPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"VolleyballTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league-season.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league-season, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/VolleyballTeamAwayStatsResponseDto"
}
]
},
"leagueId": {
"type": "number",
"example": 83331,
"description": "League id to which team statistics are associated."
},
"leagueName": {
"type": "string",
"example": "SuperLega",
"description": "League name to which team statistics are associated."
},
"season": {
"type": "number",
"example": 2023,
"description": "Season year to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueId",
"leagueName",
"season"
]
},
"VolleyballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Stake.com"
}
},
"required": [
"id",
"name"
]
},
"VolleyballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 3.39
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"VolleyballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 2
},
"bookmakerName": {
"type": "string",
"example": "22Bet"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Match Winner"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"VolleyballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 138243181
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"VolleyballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"VolleyballStandingsTeamDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1148783
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/1148783.png"
},
"name": {
"type": "string",
"example": "Barkom"
}
},
"required": [
"id",
"name"
]
},
"VolleyballStandingsDto": {
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/VolleyballStandingsTeamDto"
},
"wins": {
"type": "number",
"example": 17
},
"loses": {
"type": "number",
"example": 1
},
"points": {
"type": "number",
"example": 51
},
"position": {
"type": "number",
"example": 1
},
"gamesPlayed": {
"type": "number",
"example": 18
},
"scoredPoints": {
"type": "number",
"example": 53
},
"receivedPoints": {
"type": "number",
"example": 10
}
},
"required": [
"team",
"wins",
"loses",
"points",
"position",
"gamesPlayed",
"scoredPoints",
"receivedPoints"
]
},
"VolleyballStandingsGroupsResponseDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Regular Season"
},
"standings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballStandingsDto"
}
}
},
"required": [
"name",
"standings"
]
},
"VolleyballStandingsLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 150560
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/150560.png"
},
"name": {
"type": "string",
"example": "Superleague"
},
"season": {
"type": "number",
"example": 2020
}
},
"required": [
"id",
"name",
"season"
]
},
"VolleyballStandingsResponseDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VolleyballStandingsGroupsResponseDto"
}
},
"league": {
"allOf": [
{
"$ref": "#/components/schemas/VolleyballStandingsLeagueResponseDto"
}
]
}
},
"required": [
"groups",
"league"
]
},
"CricketCountryResponseDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Country code specified by the ISO 3166 standard.",
"example": "AU"
},
"name": {
"type": "string",
"example": "Australia"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/country/AU.png"
}
},
"required": [
"code",
"name",
"logo"
]
},
"CricketCountryQueryParamDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Australia"
}
}
},
"CricketTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "17838627"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/17838627.png"
},
"name": {
"type": "string",
"example": "Melbourne Stars"
},
"abbreviation": {
"type": "string",
"example": "MS"
}
},
"required": [
"id",
"name",
"abbreviation"
]
},
"CricketMatchLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "48513362"
},
"season": {
"type": "number",
"example": 2023
},
"name": {
"type": "string",
"example": "Big Bash League"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/48513362.png"
}
},
"required": [
"id",
"season",
"name"
]
},
"CricketMatchScoreTeamAwayDto": {
"type": "object",
"properties": {
"info": {
"type": "string",
"example": "17.2/20 ov, T:138"
},
"score": {
"type": "string",
"example": "139/4"
}
}
},
"CricketMatchScoreTeamHomeDto": {
"type": "object",
"properties": {
"info": {
"type": "string",
"example": null
},
"score": {
"type": "string",
"example": "137/8"
}
}
},
"CricketMatchScoreTeamsDto": {
"type": "object",
"properties": {
"away": {
"$ref": "#/components/schemas/CricketMatchScoreTeamAwayDto"
},
"home": {
"$ref": "#/components/schemas/CricketMatchScoreTeamHomeDto"
}
},
"required": [
"away",
"home"
]
},
"CricketMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Finished",
"Unknown",
"No live coverage",
"In play",
"Stumps",
"Lunch",
"Innings break",
"Drinks",
"Timeout",
"Tea",
"Scheduled",
"Match delayed",
"Cancelled",
"Abandoned",
"Postponed"
],
"example": "Finished",
"description": "State of the match."
},
"report": {
"type": "string",
"example": "Renegades won by 6 wickets (with 16 balls remaining)",
"description": "Descriptive report of the match based on the match status."
},
"teams": {
"$ref": "#/components/schemas/CricketMatchScoreTeamsDto"
}
},
"required": [
"description",
"teams"
]
},
"CricketMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "48514657"
},
"endDate": {
"type": "string",
"example": "2024-01-13T00:00:00.000Z"
},
"startDate": {
"type": "string",
"example": "2024-01-13T00:00:00.000Z"
},
"startTime": {
"type": "string",
"example": "2024-01-13T14:30:00.000Z"
},
"country": {
"$ref": "#/components/schemas/CricketCountryResponseDto"
},
"awayTeam": {
"$ref": "#/components/schemas/CricketTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/CricketTeamResponseDto"
},
"league": {
"$ref": "#/components/schemas/CricketMatchLeagueResponseDto"
},
"format": {
"type": "string",
"example": "T20",
"description": "Cricket match format, e.g. T20, ODI, TEST"
},
"dayType": {
"type": "string",
"enum": [
"SINGLE",
"MULTI"
],
"example": "SINGLE",
"description": "Information that tells us whether the match will be played across multiple days"
},
"state": {
"$ref": "#/components/schemas/CricketMatchStateResponseDto"
}
},
"required": [
"id",
"endDate",
"startDate",
"country",
"awayTeam",
"homeTeam",
"league",
"state"
]
},
"CricketHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 75
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/75.png"
},
"title": {
"type": "string",
"example": "Big Bash League: Melbourne Renegades vs Melbourne Stars"
},
"description": {
"type": "string",
"example": "Game recap of the match."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/213123safas132e"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/213123safas132e"
},
"match": {
"$ref": "#/components/schemas/CricketMatchResponseDto"
},
"channel": {
"type": "string",
"example": "Ligue 1 Uber Eats",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"CricketHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CricketHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"CricketSeasonResponseDto": {
"type": "object",
"properties": {
"season": {
"type": "number",
"example": 2023
}
},
"required": [
"season"
]
},
"CricketLeagueResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "48513362"
},
"logo": {
"type": "string",
"example": "https://example.com/logos/league/1635.png"
},
"name": {
"type": "string",
"example": "Big Bash League"
},
"country": {
"$ref": "#/components/schemas/CricketCountryResponseDto"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CricketSeasonResponseDto"
}
}
},
"required": [
"id",
"name",
"country",
"seasons"
]
},
"CricketLeaguePaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CricketLeagueResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"CricketMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CricketMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"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"
}
},
"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"
]
},
"BaseballHighlightMatchTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 219
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/219.png"
},
"name": {
"type": "string",
"example": "Bears"
},
"displayName": {
"type": "string",
"example": "Baylor"
},
"abbreviation": {
"type": "string",
"example": "BAY"
}
},
"required": [
"id",
"displayName",
"abbreviation"
]
},
"BaseballHighlightMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 394
},
"round": {
"type": "string",
"example": "regular-season"
},
"date": {
"type": "string",
"example": "2024-03-06T00:30:00.000Z"
},
"league": {
"type": "string",
"example": "NCAA"
},
"season": {
"type": "number",
"example": 2024
},
"awayTeam": {
"$ref": "#/components/schemas/BaseballHighlightMatchTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/BaseballHighlightMatchTeamResponseDto"
}
},
"required": [
"id",
"round",
"date",
"league",
"season",
"awayTeam",
"homeTeam"
]
},
"BaseballHighlightResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 27
},
"type": {
"type": "string",
"example": "VERIFIED"
},
"imgUrl": {
"type": "string",
"description": "Preview picture of the highlight.",
"example": "https://example.com/images/preview/27.png"
},
"title": {
"type": "string",
"example": "NCAA: Bears vs Patriots"
},
"description": {
"type": "string",
"example": "Tom Poole sends one deep to right to give Dallas Baptist an insurance run over Baylor."
},
"url": {
"type": "string",
"description": "Url location of the video highlight.",
"example": "https://example.com/highlight/v23r23fds2cff"
},
"embedUrl": {
"type": "string",
"description": "Url of embeddable video highlight.",
"example": "https://example.com/embed/v23r23fds2cff"
},
"match": {
"$ref": "#/components/schemas/BaseballHighlightMatchResponseDto"
},
"channel": {
"type": "string",
"example": "MLB",
"description": "Channel title of a given highlight."
},
"source": {
"type": "string",
"example": "youtube",
"description": "Aggregation source from social media and other equivalent platforms."
}
},
"required": [
"id",
"type",
"title",
"url",
"match"
]
},
"BaseballHighlightPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballHighlightResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BaseballMatchTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 219
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/219.png"
},
"name": {
"type": "string",
"example": "Bears"
},
"displayName": {
"type": "string",
"example": "Baylor"
},
"abbreviation": {
"type": "string",
"example": "BAY"
}
},
"required": [
"id",
"displayName",
"abbreviation"
]
},
"BaseballMatchScore": {
"type": "object",
"properties": {
"hits": {
"type": "number",
"example": 4
},
"errors": {
"type": "number",
"example": 2
},
"innings": {
"example": [
0,
0,
1,
1,
0,
0,
1,
1,
1
],
"description": "Scores for each played inning.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"innings"
]
},
"BaseballMatchScoreResponseDto": {
"type": "object",
"properties": {
"home": {
"$ref": "#/components/schemas/BaseballMatchScore"
},
"away": {
"$ref": "#/components/schemas/BaseballMatchScore"
},
"current": {
"type": "string",
"example": "5 - 8"
}
},
"required": [
"home",
"away"
]
},
"BaseballMatchStateResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Finished",
"Postponed",
"Period End",
"Rain Delay",
"Scheduled",
"Half Time",
"In Progress",
"Canceled",
"Unknown",
"Suspended"
],
"example": "Finished"
},
"report": {
"type": "string",
"example": "Final",
"description": "Additional description of the match state."
},
"score": {
"$ref": "#/components/schemas/BaseballMatchScoreResponseDto"
}
},
"required": [
"description",
"score"
]
},
"BaseballMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 394
},
"round": {
"type": "string",
"example": "regular-season"
},
"date": {
"type": "string",
"example": "2024-03-06T00:30:00.000Z"
},
"league": {
"type": "string",
"example": "NCAA"
},
"season": {
"type": "number",
"example": 2024
},
"awayTeam": {
"$ref": "#/components/schemas/BaseballMatchTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/BaseballMatchTeamResponseDto"
},
"state": {
"$ref": "#/components/schemas/BaseballMatchStateResponseDto"
}
},
"required": [
"id",
"round",
"date",
"league",
"season",
"awayTeam",
"homeTeam",
"state"
]
},
"BaseballMatchPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballMatchResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BaseballMatchVenueResponseDto": {
"type": "object",
"properties": {
"city": {
"type": "string",
"example": "Waco"
},
"name": {
"type": "string",
"example": "Baylor Ballpark"
},
"state": {
"type": "string",
"example": "Texas"
}
},
"required": [
"city",
"name",
"state"
]
},
"BaseballDetailedMatchSingleStat": {
"type": "object",
"properties": {
"value": {
"type": "number",
"example": 8
},
"displayName": {
"type": "string",
"example": "Strikeouts"
}
},
"required": [
"value",
"displayName"
]
},
"BaseballDetailedMatchStats": {
"type": "object",
"properties": {
"batting": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchSingleStat"
}
},
"fielding": {
"example": [
null
],
"type": "array",
"items": {
"type": "string"
}
},
"pitching": {
"example": [
null
],
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BaseballDetailedMatchStatsResponseDto": {
"type": "object",
"properties": {
"homeTeam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchStats"
}
},
"awayTeam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchStats"
}
}
},
"required": [
"homeTeam",
"awayTeam"
]
},
"BaseballDetailedMatchPitch": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "CURVE"
},
"velocity": {
"type": "number",
"example": 78.2
},
"ballsCount": {
"type": "number",
"example": 0
},
"strikesCount": {
"type": "number",
"example": 0
}
}
},
"BaseballDetailedMatchResult": {
"type": "object",
"properties": {
"ballsCount": {
"type": "number",
"example": 1
},
"strikesCount": {
"type": "number",
"example": 2
}
}
},
"BaseballDetailedMatchScoreAtPlay": {
"type": "object",
"properties": {
"away": {
"type": "number",
"example": 1
},
"home": {
"type": "number",
"example": 2
}
}
},
"BaseballDetailedMatchPlaysDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "Start Inning"
},
"teamId": {
"type": "number",
"example": 229
},
"description": {
"type": "string",
"example": "Top of the 1st inning"
},
"currentOuts": {
"type": "number",
"example": 0
},
"period": {
"type": "string",
"example": "Top 1st Inning"
},
"pitch": {
"$ref": "#/components/schemas/BaseballDetailedMatchPitch"
},
"result": {
"$ref": "#/components/schemas/BaseballDetailedMatchResult"
},
"score": {
"$ref": "#/components/schemas/BaseballDetailedMatchScoreAtPlay"
}
},
"required": [
"type",
"teamId",
"description",
"currentOuts",
"period",
"pitch",
"result",
"score"
]
},
"BaseballDetailedMatchRefereesDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jonathan Parra"
},
"position": {
"type": "string",
"example": "Home Plate Umpire"
}
},
"required": [
"name",
"position"
]
},
"BaseballDetailedMatchRosterSingleDto": {
"type": "object",
"properties": {
"jersey": {
"type": "number",
"example": 1
},
"fullName": {
"type": "string",
"example": "Hunter Hines"
},
"position": {
"type": "string",
"example": "First Baseman"
},
"isStarter": {
"type": "boolean",
"example": true
}
},
"required": [
"fullName",
"position",
"isStarter"
]
},
"BaseballDetailedMatchRostersDto": {
"type": "object",
"properties": {
"awayTeam": {
"$ref": "#/components/schemas/BaseballDetailedMatchRosterSingleDto"
},
"homeTeam": {
"$ref": "#/components/schemas/BaseballDetailedMatchRosterSingleDto"
}
},
"required": [
"awayTeam",
"homeTeam"
]
},
"BaseballDetailedMatchResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 58348
},
"round": {
"type": "string",
"example": "regular-season"
},
"date": {
"type": "string",
"example": "2024-03-31T17:00:00.000Z"
},
"league": {
"type": "string",
"example": "NCAA"
},
"season": {
"type": "number",
"example": 2024
},
"awayTeam": {
"$ref": "#/components/schemas/BaseballMatchTeamResponseDto"
},
"homeTeam": {
"$ref": "#/components/schemas/BaseballMatchTeamResponseDto"
},
"state": {
"$ref": "#/components/schemas/BaseballMatchStateResponseDto"
},
"venue": {
"$ref": "#/components/schemas/BaseballMatchVenueResponseDto"
},
"stats": {
"$ref": "#/components/schemas/BaseballDetailedMatchStatsResponseDto"
},
"plays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchPlaysDto"
}
},
"referees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballDetailedMatchRefereesDto"
}
},
"rosters": {
"$ref": "#/components/schemas/BaseballDetailedMatchRostersDto"
},
"forecast": {
"$ref": "#/components/schemas/DetailedMatchForecastResponseDto"
}
},
"required": [
"id",
"round",
"date",
"league",
"season",
"awayTeam",
"homeTeam",
"state"
]
},
"BaseballTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 219
},
"logo": {
"type": "string",
"example": "https://example.com/logos/team/219.png"
},
"name": {
"type": "string",
"example": "Bears"
},
"displayName": {
"type": "string",
"example": "Baylor"
},
"abbreviation": {
"type": "string",
"example": "BAY"
},
"league": {
"type": "string",
"example": "NCAA"
}
},
"required": [
"id",
"displayName",
"abbreviation",
"league"
]
},
"BaseballTeamPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballTeamResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BaseballTeamTotalGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played during a specific league round.",
"example": 102
},
"wins": {
"type": "number",
"description": "Number of games team has won during a specific league round.",
"example": 43
},
"loses": {
"type": "number",
"description": "Number of games team has lost during a specific league round.",
"example": 59
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BaseballTeamTotalPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"example": 566,
"description": "Number of points team has scored during a specific league round."
},
"received": {
"type": "number",
"example": 600,
"description": "Number of points team has received during a specific league round."
}
},
"required": [
"scored",
"received"
]
},
"BaseballTeamTotalStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamTotalGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored, and received during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamTotalPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BaseballTeamHomeGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league round.",
"example": 49
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league round.",
"example": 21
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league round.",
"example": 28
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BaseballTeamHomePointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored whilst playing as home team during a specific league round.",
"example": 263
},
"received": {
"type": "number",
"description": "Number of points team has received whilst playing as home team during a specific league round.",
"example": 300
}
},
"required": [
"scored",
"received"
]
},
"BaseballTeamHomeStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Number of games team has played, won, and lost during a specific league round, whilst playing as home team.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamHomeGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received, during a specific league round, whilst playing as away team.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamHomePointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BaseballTeamAwayGameStatsResponseDto": {
"type": "object",
"properties": {
"played": {
"type": "number",
"description": "Number of games team has played as home team during a specific league round.",
"example": 53
},
"wins": {
"type": "number",
"description": "Number of games team has won as home team during a specific league round.",
"example": 22
},
"loses": {
"type": "number",
"description": "Number of games team has lost as home team during a specific league round.",
"example": 31
}
},
"required": [
"played",
"wins",
"loses"
]
},
"BaseballTeamAwayPointsStatsResponseDto": {
"type": "object",
"properties": {
"scored": {
"type": "number",
"description": "Number of points team has scored as away team, during a specific league round.",
"example": 303
},
"received": {
"type": "number",
"description": "Number of points team has received as away team, during a specific league round.",
"example": 300
}
},
"required": [
"scored",
"received"
]
},
"BaseballTeamAwayStatsResponseDto": {
"type": "object",
"properties": {
"games": {
"description": "Game related statistics team has played as away team, during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamAwayGameStatsResponseDto"
}
]
},
"points": {
"description": "Number of points team has scored and received as away team, during a specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamAwayPointsStatsResponseDto"
}
]
}
},
"required": [
"games",
"points"
]
},
"BaseballTeamStatisticsResponseDto": {
"type": "object",
"properties": {
"total": {
"description": "Total game and points statistics corresponding to specific league round.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamTotalStatsResponseDto"
}
]
},
"home": {
"description": "Game and point statistics corresponding to specific league round, where the team has played as a home team.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamHomeStatsResponseDto"
}
]
},
"away": {
"description": "Game and point statistics corresponding to specific league round, where the team has played as an away team.",
"allOf": [
{
"$ref": "#/components/schemas/BaseballTeamAwayStatsResponseDto"
}
]
},
"leagueName": {
"type": "string",
"example": "MLB",
"description": "League name to which team statistics are associated."
},
"round": {
"type": "string",
"example": "regular-season",
"description": "Round to which team statistics are associated."
}
},
"required": [
"total",
"home",
"away",
"leagueName",
"round"
]
},
"BaseballStandingsTeamStatsResponseDto": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "Number of Overtime Losses"
},
"abbreviation": {
"type": "string",
"example": "OTL"
},
"displayValue": {
"type": "string",
"example": "0"
}
},
"required": [
"description",
"abbreviation",
"displayValue"
]
},
"BaseballStandingsTeamResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 58
},
"logo": {
"type": "string",
"example": "https://example.com/baseball/images/teams/58.png"
},
"name": {
"type": "string",
"example": "Dodgers"
},
"stats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballStandingsTeamStatsResponseDto"
}
}
},
"required": [
"id",
"name",
"stats"
]
},
"BaseballStandingsResponseDto": {
"type": "object",
"properties": {
"leagueName": {
"type": "string",
"example": "Cactus League (MLB)"
},
"abbreviation": {
"type": "string",
"example": "CAC"
},
"year": {
"type": "number",
"example": 2024
},
"leagueType": {
"type": "string",
"example": "MLB"
},
"seasonType": {
"type": "string",
"example": "Spring Training"
},
"startDate": {
"type": "string",
"example": "2024-02-15T08:00:00.000Z"
},
"endDate": {
"type": "string",
"example": "2024-03-27T06:59:00.000Z"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballStandingsTeamResponseDto"
}
}
},
"required": [
"leagueName",
"abbreviation",
"year",
"leagueType",
"seasonType",
"startDate",
"endDate",
"data"
]
},
"BaseballStandingsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballStandingsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BaseballMarketSelectionResponseDto": {
"type": "object",
"properties": {
"odd": {
"type": "number",
"example": 2.8
},
"value": {
"type": "string",
"example": "Home"
}
},
"required": [
"odd",
"value"
]
},
"BaseballMarketResponseDto": {
"type": "object",
"properties": {
"bookmakerId": {
"type": "number",
"example": 53
},
"bookmakerName": {
"type": "string",
"example": "Megapari Sport"
},
"type": {
"type": "string",
"example": "prematch"
},
"market": {
"type": "string",
"example": "Odd or Even"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballMarketSelectionResponseDto"
}
}
},
"required": [
"bookmakerId",
"type",
"market",
"values"
]
},
"BaseballOddsResponseDto": {
"type": "object",
"properties": {
"matchId": {
"type": "number",
"example": 394
},
"odds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballMarketResponseDto"
}
}
},
"required": [
"matchId",
"odds"
]
},
"BaseballOddsPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballOddsResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
},
"BaseballBookmakerResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 53
},
"name": {
"type": "string",
"example": "Megapari Sport"
}
},
"required": [
"id",
"name"
]
},
"BaseballBookmakersPaginatedResponseDto": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseballBookmakerResponseDto"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationResponseDto"
},
"plan": {
"$ref": "#/components/schemas/PlanResponseDto"
}
},
"required": [
"data",
"pagination",
"plan"
]
}
}
}
}