Schedule & Results
Update Time: 2022-08-15 15:56
Introduction
• This API endpoint returns the results of a specified date, event or match.
• One of the three parameters "date", "leagueId", and "matchId" is required, and the three parameters cannot be used at the same time.
• You can use it with the Match Modify Record endpoint.
Related Plans
You can use this api by subscribing plans: Live Data.
Request
- Path: /sport/football/schedule
- Method: GET
- Calls: This interface is limited to 60 second/call;
- Recommend Calls: 12 hour/call
- Parameters: The request path needs at least one parameter (date, leagueId, and matchId ) to retrieve correct response. These three parameters can not be used at the same time.
| Parameter | Value | Required | Description |
|---|---|---|---|
| date | string | false | yyyy-mm-dd, e.g. 2019-08-01. Return the match data of the specified date, the range is GMT+0 0:00-23:59; The historical schedule data is limited to query the past month. |
| leagueId | string | false | Returns the schedule result of the specified event; Returns the current season by default. |
| season | string | false | Use with leagueId to get the specified season, e.g.2018-2019. Return to the current season by default |
| subLeagueId | string | false | Use with leagueId to get the specified sub league. |
| stageId | string | false | Use with leagueId to get the specified cup stage. |
| matchId | string | false | Multiple matches can be requested at the same time, and "matchId" is separated by ",", and a maximum of 100 matches can be queried at a time. |
Response
| Parameter | Value | Description | |
|---|---|---|---|
| matchId | string | ||
| leagueType | int | 1: League 2: Cup | |
| leagueId | string | ||
| leagueName | string | Full name, e.g. Brazil Serie A | |
| leagueShortName | string | Short name, e.g. BRA D1 | |
| leagueColor | string | ||
| subLeagueId | string | ||
| subLeagueName | string | The on-going sub league of the league, e.g. Western Paly Off | |
| matchTime | int | Match scheduled time, unix timestamp | |
| halfStartTime | int | The kick-off time of the first half or the second half, unix timestamp | |
| status | int | 0: Not started 1: First half 2: Half-time break 3: Second half 4: Extra time 5: Penalty -1: Finished -10: Cancelled -11: TBD -12: Terminated -13: Interrupted -14: Postponed | |
| homeId | string | ||
| homeName | string | ||
| awayId | string | ||
| awayName | string | ||
| homeScore | int | ||
| awayScore | int | ||
| homeHalfScore | int | First half score, home team | |
| awayHalfScore | int | First half score, away team | |
| homeRed | int | ||
| awayRed | int | ||
| homeYellow | int | ||
| awayYellow | int | ||
| homeCorner | int | ||
| awayCorner | int | ||
| homeRank | string | The ranking of the team in the league, home team | |
| awayRank | string | The ranking of the team in the league, away team | |
| season | string | e.g. 2019-2020 | |
| stageId | string | Matches with [Interface Cup Stage Profile] stageId; To distinguish the different stages of the cup, the league does not return this data. | |
| round | string | League round or cup stage, e.g. 10 | |
| group | string | Cup group, e.g. A | |
| location | string | e.g. Camp Nou | |
| weather | string | e.g. Clear | |
| temperature | string | e.g. 14℃～15℃ | |
| explain | string | Special case description of the match, e.g. Match end up with [0-3], due to (Torpedo-MAZ Minsk) withdraw from the match | |
| extraExplain | object | Return to Extra time, Penalty kicks, etc. | |
| kickOff | int | 1: Home kickoff 2: Away kickoff | |
| minute | int | How many minutes does the match have in regular time? | |
| homeScore | int | Regular time score, home team | |
| awayScore | int | Regular time score, away team | |
| extraTimeStatus | int | 1: Normal matches extratime ends, "extraHomeScore/extraAwayScore" includes the regular time score 2: Special matches (e.g. beach football, indoor football) extratime ends, "extraHomeScore/extraAwayScore" does not include the regular time score 3: The match in extra time | |
| extraHomeScore | int | Extra time score, home team | |
| extraAwayScore | int | Extra time score, away team | |
| penHomeScore | int | Penalty score, home team | |
| penAwayScore | int | Penalty score, away team | |
| twoRoundsHomeScore | int | ||
| twoRoundsAwayScore | int | ||
| winner | int | Winner of the match 1: Home 2: Away | |
| hasLineup | boolean | Is there Lineup data? | |
| neutral | boolean | Is it a neutral venue? | |
Example Request
Example Response
{}
