Overview

The Match Formation API returns the home and away player arrangements for a specific match. Each formation entry contains the player profile, match-specific shirt number, team, assigned match position, normalized pitch coordinates, and starting-lineup status. The response separates the two teams into arrFormation.home and arrFormation.away. Use boolLineup to distinguish starters from non-starters:
  • true: the player is part of the starting lineup.
  • false: the player is a non-starter or substitute included in the formation data.
The player’s registered position and match assignment are intentionally separate. objPlayer.position describes the player’s master profile positions, while strPosition describes the position assigned for this match. Similarly, objPlayer.number is the player-profile number, whereas intShirtNumber is the shirt number used in this match and should be preferred for lineup displays. The payload does not repeat the requested match identifier inside object. Consumers should associate the response with the match_id used in the request.

Typical Use Cases

  • Render home and away formations on a football pitch.
  • Display starting lineups and substitutes.
  • Build broadcast lineup graphics.
  • Show match-specific positions and shirt numbers.
  • Compare registered player positions with match assignments.
  • Populate match-center formation views.
  • Power tactical lineup and pre-match presentation screens.

Parameters

module
string
required
The API module. This value is fixed and must always be api.
api
string
required
The endpoint name. This value is fixed and must always be MatchFormation.
version
string
required
The API version. Use V3.
match_id
integer
required
The unique KoraStats match identifier. In this example, use 129958.
lang
string
required
The response language code. Use en for English.
response
string
required
The response format. Use json.
key
string
required
Your KoraStats API key. Keep this value secure and do not expose it in public or client-side applications.

Endpoint

GET https://premium.korastats.pro/api.php
https://premium.korastats.pro/api.php?module=api&api=MatchFormation&version=V3&response=json&lang=en&match_id=129958&key=YOUR_API_KEY

Code Examples

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

Response Example

{
  "result": true,
  "title": "Success",
  "message": "Match formation retrieved successfully.",
  "object": {
    "arrFormation": {
      "home": [
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674136,
            "name": "Artem Belyi",
            "nickname": "Artem Belyi",
            "dob": "1997-04-28",
            "number": 97,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 1,
                "name": "GK"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 1,
                "name": "GK"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 18,
              "name": "Belarus"
            }
          },
          "intShirtNumber": 97,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "GK",
          "decX": 9.0755,
          "decY": 51.3962,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674137,
            "name": "Almazbek Malikov",
            "nickname": "Almazbek Malikov",
            "dob": "1996-06-19",
            "number": 21,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 21,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CB",
          "decX": 30.7244,
          "decY": 67.8819,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674138,
            "name": "Akram Umarov",
            "nickname": "Akram Umarov",
            "dob": "1994-02-07",
            "number": 27,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 27,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CB",
          "decX": 31.4184,
          "decY": 35.8367,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674140,
            "name": "Haruki Yamamura",
            "nickname": "Haruki Yamamura",
            "dob": "2001-04-20",
            "number": 30,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 5,
                "name": "LB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 5,
                "name": "LB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 91,
              "name": "Japan"
            }
          },
          "intShirtNumber": 30,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "LB",
          "decX": 55.4792,
          "decY": 15.1458,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674141,
            "name": "Yuriy Gavrilov",
            "nickname": "Yuriy Gavrilov",
            "dob": "2002-05-29",
            "number": 88,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 152,
              "name": "Russia"
            }
          },
          "intShirtNumber": 88,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CM",
          "decX": 46.7568,
          "decY": 47.1689,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674143,
            "name": "Timurlan Nurmatov",
            "nickname": "Timurlan Nurmatov",
            "dob": "2005-11-17",
            "number": 23,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 6,
                "name": "DM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 6,
                "name": "DM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 23,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "RW",
          "decX": 51.8788,
          "decY": 78.6364,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674144,
            "name": "Dadakhon Yusupov",
            "nickname": "Dadakhon Yusupov",
            "dob": "1997-03-31",
            "number": 14,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 6,
                "name": "DM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 6,
                "name": "DM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 199,
              "name": "Uzbekistan"
            }
          },
          "intShirtNumber": 14,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "DM",
          "decX": 45.9545,
          "decY": 52.5974,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674146,
            "name": "Abrorbek Askarov",
            "nickname": "Abrorbek Askarov",
            "dob": "1999-08-20",
            "number": 19,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 18,
                "name": "RM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 18,
                "name": "RM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 19,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "RB",
          "decX": 45.0273,
          "decY": 82.7727,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674147,
            "name": "Sarvar Ablaev",
            "nickname": "Sarvar Ablaev",
            "dob": "2001-11-07",
            "number": 5,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 8,
                "name": "AM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 8,
                "name": "AM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 199,
              "name": "Uzbekistan"
            }
          },
          "intShirtNumber": 5,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "AM",
          "decX": 59.2979,
          "decY": 42.1631,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674148,
            "name": "Dastanbek Toktosunov",
            "nickname": "Dastanbek Toktosunov",
            "dob": "2002-09-02",
            "number": 9,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 9,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CF",
          "decX": 66.1967,
          "decY": 48.3115,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674149,
            "name": "Javokhir Alizhonov",
            "nickname": "Javokhir Alizhonov",
            "dob": "2000-01-28",
            "number": 17,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 199,
              "name": "Uzbekistan"
            }
          },
          "intShirtNumber": 17,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "LW",
          "decX": 62.4627,
          "decY": 15.5672,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674151,
            "name": "Valeriy Stepanenko",
            "nickname": "Valeriy Stepanenko",
            "dob": "1998-10-19",
            "number": 4,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 195,
              "name": "Ukraine"
            }
          },
          "intShirtNumber": 4,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CB",
          "decX": 48.5965,
          "decY": 18,
          "boolLineup": false
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674152,
            "name": "Bayaman Subanaliev",
            "nickname": "Bayaman Subanaliev",
            "dob": "2006-05-26",
            "number": 20,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 20,
          "objTeam": {
            "_type": "TEAM",
            "id": 37079,
            "name": "Neftchi Kochkor-ata"
          },
          "strPosition": "CF",
          "decX": 61.9038,
          "decY": 77.5577,
          "boolLineup": false
        }
      ],
      "away": [
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 39405,
            "name": "Alexander Mishchenko",
            "nickname": "Alexander Mishchenko",
            "dob": "1997-07-30",
            "number": 14,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 31,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "RB",
          "decX": 44.1008,
          "decY": 82.8908,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 53130,
            "name": "Ernaz Abilov",
            "nickname": "Ernaz Abilov",
            "dob": "2001-03-30",
            "number": 21,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 10,
                "name": "LW"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 9,
                "name": "RW"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 9,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "LW",
          "decX": 61.209,
          "decY": 22.8806,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 85186,
            "name": "Adil Kadyrzhanov",
            "nickname": "Adil Kadyrzhanov",
            "dob": "2000-07-14",
            "number": 4,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 14,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "DM",
          "decX": 46.1593,
          "decY": 53.4248,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 437881,
            "name": "Giorgi Gabadze",
            "nickname": "Giorgi Gabadze",
            "dob": "1995-03-02",
            "number": 5,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 4,
                "name": "RB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 68,
              "name": "Georgia"
            }
          },
          "intShirtNumber": 27,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "CB",
          "decX": 33.8702,
          "decY": 72.374,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 465080,
            "name": "Ilya Gulko",
            "nickname": "Ilya Gulko",
            "dob": "2002-11-17",
            "number": 0,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 6,
                "name": "DM"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 195,
              "name": "Ukraine"
            }
          },
          "intShirtNumber": 88,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "CM",
          "decX": 50.9293,
          "decY": 57.3737,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674108,
            "name": "Adilet Abdyrayymov",
            "nickname": "Adilet Abdyrayymov",
            "dob": "2006-09-09",
            "number": 1,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 1,
                "name": "GK"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 1,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "GK",
          "decX": 14.4082,
          "decY": 51.6122,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674120,
            "name": "Salim Mambetov",
            "nickname": "Salim Mambetov",
            "dob": "2006-07-31",
            "number": 5,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 4,
                "name": "RB"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 5,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "RB",
          "decX": 62.5,
          "decY": 46.25,
          "boolLineup": false
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674124,
            "name": "Vladyslav Kobylyanskyi",
            "nickname": "Vladyslav Kobylyanskyi",
            "dob": "2002-01-02",
            "number": 8,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 195,
              "name": "Ukraine"
            }
          },
          "intShirtNumber": 8,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "RW",
          "decX": 56.213,
          "decY": 73.1944,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674125,
            "name": "Tamirlan Dzhamalutdinov",
            "nickname": "Tamirlan Dzhamalutdinov",
            "dob": "1996-07-28",
            "number": 71,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 7,
                "name": "CM"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 152,
              "name": "Russia"
            }
          },
          "intShirtNumber": 71,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "CM",
          "decX": 63.9155,
          "decY": 38.493,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674127,
            "name": "Dmytro Semeniv",
            "nickname": "Dmytro Semeniv",
            "dob": "1998-06-24",
            "number": 20,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 10,
                "name": "LW"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 195,
              "name": "Ukraine"
            }
          },
          "intShirtNumber": 20,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "LB",
          "decX": 40.4175,
          "decY": 17.1456,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674129,
            "name": "Ernist Batyrkanov",
            "nickname": "Ernist Batyrkanov",
            "dob": "1998-02-21",
            "number": 7,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 12,
                "name": "CF"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 7,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "CF",
          "decX": 65.0811,
          "decY": 59.5676,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674135,
            "name": "Denys Prytykovskyi",
            "nickname": "Denys Prytykovskyi",
            "dob": "1994-04-04",
            "number": 44,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              },
              "secondary": {
                "_type": "POSITION",
                "id": 3,
                "name": "CB"
              }
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 195,
              "name": "Ukraine"
            }
          },
          "intShirtNumber": 44,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "CB",
          "decX": 30.6992,
          "decY": 34.4634,
          "boolLineup": true
        },
        {
          "objPlayer": {
            "_type": "PLAYER",
            "id": 674158,
            "name": "Islam Badalov",
            "nickname": "Islam Badalov",
            "dob": null,
            "number": 95,
            "position": {
              "primay": {
                "_type": "POSITION",
                "id": 4,
                "name": "RB"
              },
              "secondary": null
            },
            "nationality": {
              "_type": "NATIONALITY",
              "id": 100,
              "name": "Kyrgyzstan"
            }
          },
          "intShirtNumber": 95,
          "objTeam": {
            "_type": "TEAM",
            "id": 37072,
            "name": "Dordoi Bishkek"
          },
          "strPosition": "RB",
          "decX": 45.7273,
          "decY": 10.7727,
          "boolLineup": false
        }
      ]
    }
  }
}

Response Fields

Response Envelope

FieldTypeDescription
resultbooleanIndicates whether the request completed successfully.
titlestringShort response status title.
messagestringHuman-readable result message.
objectobjectFormation payload for the requested match.

Formation Container

FieldTypeDescription
object.arrFormationobjectContainer holding the home and away formation entries.
object.arrFormation.homearray(object)Home-team formation entries.
object.arrFormation.awayarray(object)Away-team formation entries.

Formation Entry

The same schema is used for every item in the home and away arrays. Paths below use [side] to represent either array.
FieldTypeDescription
object.arrFormation.[side][].objPlayerobjectPlayer profile associated with the formation entry.
object.arrFormation.[side][].intShirtNumberintegerMatch-specific shirt number. Prefer this value when displaying the lineup.
object.arrFormation.[side][].objTeamobjectTeam represented by the player in this match.
object.arrFormation.[side][].strPositionstringMatch-specific position code, such as GK, CB, LB, RB, DM, CM, AM, LW, RW, or CF.
object.arrFormation.[side][].decXnumberPlayer’s normalized horizontal pitch coordinate. Values in this response use a 0100 pitch scale.
object.arrFormation.[side][].decYnumberPlayer’s normalized vertical pitch coordinate. Values in this response use a 0100 pitch scale.
object.arrFormation.[side][].boolLineupbooleantrue for a starting player; false for a non-starter or substitute.

Player Object

FieldTypeDescription
objPlayer._typestringObject discriminator. The value is PLAYER.
objPlayer.idintegerUnique player identifier.
objPlayer.namestringPlayer’s full display name.
objPlayer.nicknamestring | nullPlayer’s nickname or preferred display name.
objPlayer.dobstring | nullDate of birth in YYYY-MM-DD format.
objPlayer.numberinteger | nullShirt number stored on the player’s profile. This can differ from intShirtNumber.
objPlayer.positionobjectPlayer’s registered primary and secondary positions.
objPlayer.nationalityobject | nullPlayer’s nationality when available.

Player Position Object

FieldTypeDescription
objPlayer.position.primayobject | nullPlayer’s registered primary position. The API currently returns the field name as primay.
objPlayer.position.primay._typestringObject discriminator. The value is POSITION.
objPlayer.position.primay.idintegerUnique position identifier.
objPlayer.position.primay.namestringPrimary position code.
objPlayer.position.secondaryobject | nullPlayer’s registered secondary position.
objPlayer.position.secondary._typestringObject discriminator. The value is POSITION.
objPlayer.position.secondary.idintegerUnique secondary-position identifier.
objPlayer.position.secondary.namestringSecondary position code.

Team Object

FieldTypeDescription
objTeam._typestringObject discriminator. The value is TEAM.
objTeam.idintegerUnique team identifier.
objTeam.namestringTeam name.

Nationality Object

FieldTypeDescription
objPlayer.nationality._typestringObject discriminator. The value is NATIONALITY.
objPlayer.nationality.idintegerUnique nationality identifier.
objPlayer.nationality.namestringNationality name.
Use strPosition for the player’s role in this match. Do not assume it matches objPlayer.position.primay.name, which describes the player’s registered profile position.
Use intShirtNumber for match lineup displays. objPlayer.number is profile-level data and can contain a different value.
The response currently spells the primary-position key as primay. Consumers must read position.primay exactly unless a future API version corrects the field name.
A non-starter can still have decX, decY, and strPosition values. Always use boolLineup—not the presence of coordinates—to determine whether the player started.

Error Response

If match_id is missing, the API returns a bad-request response using the standard KoraStats error envelope.
{
  "result": false,
  "title": "Bad Request",
  "message": "Match id not sent."
}