​
Overview

The Match Squad API returns the registered squad for both teams in a specific match. The response includes match, tournament, season, venue, officiating crew, match status, and player-level squad information. Each player record contains the player’s KoraStats ID, full name, nickname, shirt number, position, and flags indicating whether the player is in the starting lineup or on the bench. Use this endpoint when building lineup screens, match centers, broadcast graphics, team sheets, or other integrations that require the players selected for a particular match.

​
Typical Use Cases

  • Display the starting lineup and substitutes for both teams.
  • Generate a match-day team sheet.
  • Populate live match centers and broadcast graphics.
  • Link squad members to KoraStats player profiles using their player IDs.
  • Identify starters and bench players before or during a match.
  • Retrieve match officials, venue details, and match status alongside the squads.

​
Parameters

​
module
string
required
Fixed module name. Always use api.
​
api
string
required
Fixed API name. Always use MatchSquad.
​
version
string
required
API version. Use V2.
​
response
string
required
Response format. Use json to receive a JSON response.
​
lang
string
required
Language code used to localize supported response values and names, such as en for English.
​
match_id
integer
required
The unique KoraStats ID of the match whose squad should be returned.
​
key
string
required
Your KoraStats API key. Keep this value confidential and send it only over HTTPS.

​
Endpoint

GET https://premium.korastats.pro/api.php

​
Code Examples

curl --get "https://premium.korastats.pro/api.php" \
  --data-urlencode "module=api" \
  --data-urlencode "api=MatchSquad" \
  --data-urlencode "version=V2" \
  --data-urlencode "response=json" \
  --data-urlencode "lang=en" \
  --data-urlencode "match_id=MATCH_ID" \
  --data-urlencode "key=YOUR_API_KEY"

​
Response Example

{
  "result": true,
  "title": "Success",
  "message": "Squad retrieved successfully.",
  "object": {
    "_type": "MATCH SUMMARY",
    "match": {
      "_type": "MATCH",
      "id": 125793,
      "name": "Senegal U17 x Tanzania U17"
    },
    "tournament": {
      "_type": "TOURNAMENT",
      "id": 9,
      "name": "AFCON U17"
    },
    "season": {
      "_type": "SEASON",
      "id": 2047,
      "name": "Morocco 2026"
    },
    "round": 1,
    "stadium": {
      "_type": "STADIUM",
      "id": 4827,
      "name": "Stade Prince Moulay Hassan"
    },
    "referee": {
      "_type": "REFEREE",
      "id": 4212,
      "name": "Mohamed Rafiq Aouina",
      "dob": null,
      "nationality": {
        "_type": "NATIONALITY",
        "id": 4,
        "name": "Algeria"
      }
    },
    "assistant1": {
      "_type": "ASSISTANT RFFEREE",
      "id": 1105,
      "name": "Tomaz Klancnik",
      "dob": "1982-11-30",
      "gender": "MALE",
      "nationality": {
        "_type": "NATIONALITY",
        "id": 168,
        "name": "Slovenia"
      }
    },
    "assistant2": {
      "_type": "ASSISTANT RFFEREE",
      "id": 1284,
      "name": "Andraz Kovacic",
      "dob": "1985-10-24",
      "gender": "MALE",
      "nationality": {
        "_type": "NATIONALITY",
        "id": 168,
        "name": "Slovenia"
      }
    },
        "home": {
      "_type": "TEAM",
      "team": {
        "_type": "TEAM",
        "id": 782,
        "name": "Senegal U17"
      },
      "squad": [
        {
          "_type": "PLAYER",
          "id": 267417,
          "name": "Assane Sarr",
          "nick_name": "Assane Sarr",
          "shirt_number": 16,
          "position": {
            "_type": "POSITION",
            "id": 1,
            "name": "GK"
          },
          "lineup": true,
          "bench": false
        },
        {
          "_type": "PLAYER",
          "id": 656370,
          "name": "Thierno Sow",
          "nick_name": "Thierno Sow",
          "shirt_number": 15,
          "position": {
            "_type": "POSITION",
            "id": 4,
            "name": "RB"
          },
          "lineup": true,
          "bench": false
        }
      ]
    },
    "away": {
      "_type": "TEAM",
      "team": {
        "_type": "TEAM",
        "id": 776,
        "name": "Tanzania U17"
      },
      "squad": [
        {
          "_type": "PLAYER",
          "id": 656400,
          "name": "Haji Ally Abdalah",
          "nick_name": "Haji Ally Abdalah",
          "shirt_number": 18,
          "position": {
            "_type": "POSITION",
            "id": 1,
            "name": "GK"
          },
          "lineup": true,
          "bench": false
        },
        {
          "_type": "PLAYER",
          "id": 378808,
          "name": "Elick Shaban Yusuph",
          "nick_name": "Elick Shaban Yusuph",
          "shirt_number": 12,
          "position": {
            "_type": "POSITION",
            "id": 4,
            "name": "RB"
          },
          "lineup": true,
          "bench": false
        }
      ]
    },
    "dateTime": "2026-06-02 18:00:00",
    "lastUpdateDateTime": "2026-06-03 17:55:01",
    "status": {
      "id": 10,
      "status": "Approved"
    }
  }
}

​
Response Fields

FieldTypeDescription
resultbooleanIndicates whether the request was processed successfully.
titlestringShort response title.
messagestringHuman-readable description of the response result.
objectobjectMatch summary and squad payload.
object._typestringKoraStats object type discriminator.
object.matchobjectBasic match identity, including its KoraStats ID and display name.
object.tournamentobjectTournament identity associated with the match.
object.seasonobjectSeason identity associated with the match.
object.roundintegerTournament round number for the match.
object.dateTimestringScheduled match date and time in YYYY-MM-DD HH:mm:ss format.
object.lastUpdateDateTimestringDate and time when the match data was last updated, in YYYY-MM-DD HH:mm:ss format.
object.stadiumobjectStadium ID, name, and object type.
object.refereeobjectMain referee details, including date of birth and nationality when available.
object.assistant1objectFirst assistant referee details.
object.assistant2objectSecond assistant referee details.
object.homeobjectHome team identity and selected squad.
object.awayobjectAway team identity and selected squad.
object.home.team, object.away.teamobjectTeam ID, name, and object type.
object.home.squad, object.away.squadarrayPlayers registered in the respective match squad.
squad[].idintegerUnique KoraStats player ID.
squad[].namestringPlayer’s full name.
squad[].nick_namestringPlayer’s commonly used or display name.
squad[].shirt_numberintegerShirt number assigned to the player for the match.
squad[].positionobjectPlayer position ID, abbreviation, and object type.
squad[].lineupbooleantrue when the player is named in the starting lineup.
squad[].benchbooleantrue when the player is named among the substitutes.
object.statusobjectMatch status ID and display value.
The squad arrays in the example are shortened for readability. A successful response returns all available squad members for each team. Some official or player fields may be unavailable depending on the match data.