Overview
The Season Team Roster API returns the registered team rosters for a specific season. The response identifies the tournament and season, then provides each team’s players together with their names, positions, date of birth, shirt number, and roster membership dates. By default, the endpoint returns all available teams and players in the requested season. Supply the optionalteam_id parameter when only one team’s roster is required.
Roster records are season-specific. The join_date and leave_date fields describe the period during which a player belonged to that team’s season roster. A player whose leave_date is null has no recorded departure date for that roster entry.
Typical Use Cases
- Build season squad and roster pages.
- Retrieve all registered players across a competition season.
- Request the season roster of one specific team.
- Synchronize KoraStats team and player IDs with an external platform.
- Track when players joined or left a team during the season.
- Display player shirt numbers and primary or secondary positions.
Parameters
Fixed module name. Always use
api.Fixed API name. Always use
SeasonTeamRoster.The unique KoraStats ID of the season whose team rosters should be returned.
Optional KoraStats team ID. When supplied, the response is limited to that team’s roster within the requested season. Omit it to retrieve all teams.
API version. Use
V2.Language used for supported names and response values. Use
en for English or ar for Arabic. Defaults to English when omitted or unsupported.Response format. Use
json to receive a JSON response.Your KoraStats API key. Keep this value confidential and send it only over HTTPS.
Endpoint
GEThttps://premium.korastats.pro/api.php
Code Examples
Response Example
Response Fields
| Field | Type | Description |
|---|---|---|
result | boolean | Indicates whether the request was processed successfully. |
title | string | Short response title. |
message | string | Human-readable summary including the number of teams and players retrieved. |
object | object | Season roster payload. |
object._type | string | Object type discriminator. Returns SEASON_TEAM_ROSTER. |
object.tournament | object | Tournament associated with the requested season. |
object.tournament._type | string | Object type discriminator. Returns TOURNAMENT. |
object.tournament.id | integer | Unique KoraStats tournament ID. |
object.tournament.name | string | Tournament name in the requested language when available. |
object.season | object | Requested season identity. |
object.season._type | string | Object type discriminator. Returns SEASON. |
object.season.id | integer | Unique KoraStats season ID. |
object.season.name | string | Season name. |
object.teams | array | Teams returned for the season. Contains all teams unless team_id limits the request. |
object.teams[]._type | string | Object type discriminator. Returns TEAM. |
object.teams[].id | integer | Unique KoraStats team ID. |
object.teams[].name | string | Team name in the requested language when available. |
object.teams[].players | array | Player roster entries registered for the team in the season. |
object.teams[].players[]._type | string | Object type discriminator. Returns PLAYER. |
object.teams[].players[].id | integer | Unique KoraStats player ID. |
object.teams[].players[].position | object | Player’s primary and secondary positions. |
object.teams[].players[].position.primary.id | integer or null | KoraStats ID of the player’s primary position, or null when unknown. |
object.teams[].players[].position.primary.name | string | Abbreviation of the player’s primary position; may be empty when unknown. |
object.teams[].players[].position.secondary.id | integer or null | KoraStats ID of the player’s secondary position, or null when unknown. |
object.teams[].players[].position.secondary.name | string | Abbreviation of the player’s secondary position; may be empty when unknown. |
object.teams[].players[].nickname | string | Player’s commonly used or display name. |
object.teams[].players[].name | string | Player’s full name. |
object.teams[].players[].dob | string or null | Player’s date of birth in YYYY-MM-DD format, or null when unavailable. |
object.teams[].players[].shirt_number | integer or null | Player’s shirt number for the roster, when available. |
object.teams[].players[].join_date | string or null | Date the player joined the season roster, in YYYY-MM-DD format. |
object.teams[].players[].leave_date | string or null | Date the player left the season roster, or null when no departure is recorded. |
The
teams and players arrays are shortened in the example for readability. The actual response contains all available records matching the requested season_id and optional team_id.