events.sub-participants.index
Resource information
URL | https://api.statscore.com/v2/events/{event_id}/sub-participants |
---|---|
Method | GET |
Description | Returns a list of sub-participants for the event |
Cache | 60 seconds |
Authorization required | Yes |
Method parameters
Name | Data type | Description |
---|---|---|
event_id | xsd:int | REQUIRED. The requested event identifier |
Query parameters
Name | Data type | Description |
---|---|---|
token | xsd:string | REQUIRED. More information concerning authorization in API introduction section |
lang | xsd:string | Determines language for the output data |
tz | xsd:string | Determines timezone for the output data |
Method calling examples
Link | Description |
---|---|
https://api.statscore.com/v2/events/6367/sub-participants?token={{YOUR_TOKEN}} | Returns a list of sub-participants for the event in JSON format |
Output elements
.sub_participants | |
---|---|
id | Unique identifier of the sub-participant (if the participant exist in the system) |
type | Participant type. Possible values:
|
name | Sub-participants name |
short_name | Participants' abbreviated name, max length: 20 characters |
acronym | Max 3 characters in length mini name, e.g. BAR, REA |
gender | Sub-participant gender. Possible value:
|
area_id | Unique identifier for the area represented by the sub-participant |
area_name | Area name represented by the sub-participant |
area_code | Max 3 characters in length for the abbreviated area name e.g. GER, POL, FRA |
sport_id | Unique identifier for the sport in which a sub-participant takes part |
sport_name | Name of the sport in which a sub-participant takes part |
national | Determines if sub-participant is a national team. Possible values:
|
website | Sub-participants official website |
ut | Information about the date and time of when the record was last updated. Format UNIX_TIMESTAMP |
old_participant_id | Deprecated. The attribute will be removed in the next API version |
slug | Friendly URL for sub-participant |
logo | Attribute for internal purposes |
virtual | Determines if the participant is a virtual (not real team or player). Possible values:
|
shirt_nr | Shirt number for the player |
details | Detailed data for participant |
team_id | Identifier of participant id (team) |
lineup_id | Unique identifier of the sub-participant in the event |
position | Position's name for selected sub-participant in the event. More detailed than the position_type parameter. Possible values:
|
position_type | Position type of selected position. Recommended for distinguishing starting lineups. Possible values:
|
position_reason_code | Code of player's absence reason. Appear only if 'position_type' field is 'will not play'. Possible values:
|
position_reason | Player's absence reason. Appear only if 'position_type' field is 'will not play'. Possible values:
|
position_reason_id | Unique identifier of the position reasons |
...stats | |
id | Unique identifier for the statistic |
name | Name of the statistic. Possible values are different depending on the sport |
short_name | Abbreviated name of the result. |
value | Value related to the statistic |
data_type | Defines type of field generated on front (internal purpose only)
|