Matches WyID
GET /v2/matches/{wyId}
Table of contents
Overview
Retrieves informations about a given match.
Request URL: https://apirest.wyscout.com/v2/matches/{wyId}
Parameters
( * parameters are mandatory)
| Name | Type | Default | Description |
|---|---|---|---|
| wyId * | integer | null | Unique ID for the required match |
| details | string | null | Objects to be detailed (separated by commas). See Notes(1) for available objects |
| useSides | boolean | false | Flag to change label (teamId –> home or teamId –> away) |
Output
| Property | Type | Condition | Value | Description |
|---|---|---|---|---|
| wyId | integer | always | Dynamic | Match Unique ID |
| label | string | always | Dynamic | Label for this match (homeTeam – awayTeam, homeScore-awayScore) |
| date | string | always | Dynamic | Local date and time for this match |
| dateutc | string | always | Dynamic | UTC date and time for this match |
| status | string | always | see Notes(2) | Status of this match |
| duration | string | always | see Notes(3) | Duration of the match |
| winner | integer | always | Dynamic | ID of the winning team. If no winner is present, value will be 0 |
| competitionId | integer | always | Dynamic | Competition Unique ID |
| seasonId | integer | always | Dynamic | Season Unique ID |
| roundId | integer | always | Dynamic | Round Unique ID |
| gameweek | integer | always | Dynamic | If appropriate, game week for the match (0 otherwise) |
| teamsData | object | always | Dynamic | Match Data |
– teamId |
integer | useSides=false | Dynamic | Data of this match related the team with ID teamId |
| — teamId | integer | always | Dynamic | Team Unique ID |
| — team | object | details=teams | Dynamic | Team details (see GET teams/{wyId} for more info) |
| — side | string | always | see Notes(4) | Team side in this match |
| — score | integer | always | Dynamic | Score at the end of the match (not counting penalties) |
| — scoreHT | integer | always | Dynamic | Score at half time |
| — scoreET | integer | always | Dynamic | Score at the end of extra time |
| — scoreP | integer | always | Dynamic | Score after penalties |
| — coachId | integer | always | Dynamic | Coach Unique ID |
| — coach | object | details=coaches | Dynamic | Coach details (see GET coaches/{wyId} for more info) |
| — hasFormation | integer | always | Dynamic | If no lineup is present, value will be 0 |
| — formation | object | hasFormation=1 | Dynamic | Team lineup, benched, substitutions |
| — lineup | array | always | Dynamic | Team lineup |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| —- shirtNumber | integer | always | Dynamic | Shirt Number |
| —- assists | integer | always | Dynamic | Number of assists in this match |
| — bench | array | always | Dynamic | Team benched players |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| —- shirtNumber | integer | always | Dynamic | Shirt Number |
| —- assists | integer | always | Dynamic | Number of assists in this match |
| — substitutions | array | always | Dynamic | Team substitutions |
| —- minute | integer | always | Dynamic | Minute of the substitution |
| —- playerIn | integer | always | Dynamic | Incoming player ID |
| —- playerOut | integer | always | Dynamic | Outgoing player ID |
| —- assists | integer | always | Dynamic | Number of assists in this match |
– home |
string | useSides=true | Dynamic | Data of this match related the team with ID teamId |
| — teamId | integer | always | Dynamic | team Unique ID |
| — team | object | details=teams | Dynamic | Team details (see GET teams/{wyId} for more info) |
| — side | string | always | see Notes(4) | Team side in this match |
| — score | integer | always | Dynamic | Score at the end of the match (not counting penalties) |
| — scoreHT | integer | always | Dynamic | Score at half time |
| — scoreET | integer | always | Dynamic | Score at the end of extra time |
| — scoreP | integer | always | Dynamic | Score after penalties |
| — coachId | integer | always | Dynamic | Coach Unique ID |
| — coach | object | details=coaches | Dynamic | Coach details (see GET coaches/{wyId} for more info) |
| — hasFormation | integer | always | Dynamic | if no lineup is present, value will be 0 |
| — formation | object | hasFormation=1 | Dynamic | Team lineup, benched, substitutions |
| — lineup | array | always | Dynamic | Team lineup |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| — bench | array | always | Dynamic | Team benched players |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| — substitutions | array | always | Dynamic | Team substitutions |
| —- minute | integer | always | Dynamic | Minute of the substitution |
| —- playerIn | integer | always | Dynamic | Incoming player ID |
| —- playerOut | integer | always | Dynamic | Outgoing player ID |
– away |
string | useSides=true | Dynamic | Data of this match related the team with ID teamId |
| — teamId | integer | always | Dynamic | Team Unique ID |
| — team | object | details=teams | Dynamic | Team details (see GET teams/{wyId} for more info) |
| — side | string | always | see Notes(4) | Team side in this match |
| — score | integer | always | Dynamic | Score at the end of the match (not counting penalties) |
| — scoreHT | integer | always | Dynamic | Score at half time |
| — scoreET | integer | always | Dynamic | Score at the end of extra time |
| — scoreP | integer | always | Dynamic | Score after penalties |
| — coachId | integer | always | Dynamic | Coach Unique ID |
| — coach | object | details=coaches | Dynamic | Coach details (see GET coaches/{wyId} for more info) |
| — hasFormation | integer | always | Dynamic | if no lineup is present, value will be 0 |
| — formation | object | hasFormation=1 | Dynamic | Team lineup, benched, substitutions |
| — lineup | array | always | Dynamic | Team lineup |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| — bench | array | always | Dynamic | Team benched players |
| —- playerId | integer | always | Dynamic | Player Unique ID |
| —- player | object | details=players | Dynamic | Player details (see GET players/{wyId} for more info) |
| —- goals | integer | always | Dynamic | Number of goals made by the player in this match |
| —- ownGoals | integer | always | Dynamic | Number of own goals made by the player in this match |
| —- yellowCards | integer | always | Dynamic | Minute of yellow cards picked up by the player in this match |
| —- redCards | integer | always | Dynamic | Minute of red cards picked up by the player in this match |
| — substitutions | array | always | Dynamic | Team substitutions |
| —- minute | integer | always | Dynamic | Minute of the substitution |
| —- playerIn | integer | always | Dynamic | Incoming player ID |
| —- playerOut | integer | always | Dynamic | Outgoing player ID |
| venue | string | always | Dynamic | Match venue |
| referees | array | always | Dynamic | Match referees |
| – refereeId | integer | always | Dynamic | Referee Unique ID |
| – referee | object | always | Dynamic | Referee details (see GET referees/{wyId} for more info) |
| – role | string | always | see Notes(5) | Referee role |
| competition | object | details=competition | Dynamic | Competition details (see GET competitions/{wyId} for more info) |
| season | object | details=season | Dynamic | Season details (see GET seasons/{wyId} for more info) |
| round | object | details=round | Dynamic | Round details |
Notes
1. Available objects for additional details
| Object | Description |
|---|---|
| coaches | Coach details (see GET coaches/{wyId} for more info) |
| players | Player details (see GET players/{wyId} for more info) |
| teams | Team details (see GET teams/{wyId} for more info) |
| competition | Competition details (see GET competitions/{wyId} for more info) |
| rounds | Round details |
| season | Season details (see GET seasons/{wyId} for more info) |
2. Available match statuses
| Status | Description |
|---|---|
| Cancelled | The match has been cancelled |
| Fixture | The match has yet to come |
| Played | The match has officially over |
| Playing | The match is currently underway |
| Postponed | The match has been postponed and no new date and time is available yet |
| Suspended | The match has been suspended and no new date and time is available yet |
| Awarded | The match has been awarded |
3. Available match durations
| Duration | Description |
|---|---|
| Regular | The match is over at regulation |
| GoldenGoal | The match is over with a golden goal during extra time |
| SilverGoal | The match is over after the first extra time period |
| ExtraTime | The match is over after extra time |
| Penalties | The match is over after penalties |
4. Available team sides
| Side | Description |
|---|---|
| home | The team was the home team for the match |
| away | The team was the away team for the match |
| none | No side was determined for this team in the match |
5. Available referee roles
| Role | Description |
|---|---|
| referee | Main referee |
| firstAssistant | First assistant (linesman) |
| secondAssistant | Second assistant (linesman) |
| fourthOfficial | Fourth official |
| firstAdditionalAssistant | First additional assistant |
| secondAdditionalAssistant | Second additional assistant |