← Back to API docs

GET/api/v1/matches/lineups/detail

Get a team's squad
World Cup packageactivebetacoreAvailable (scoped)

Description

Returns the squad for the given team id (suggested rate: up to 60 requests/min)

Access

Request
GET https://api.sports.csap.ai/api/v1/matches/lineups/detail
Auth
Header X-API-Key: <your key> (Authorization: Bearer <key> also works; ?key= is still accepted but discouraged, because the key ends up in URLs and logs)
External keys
Available (scoped)External keys can call it, but only data inside the open scope is returned.
Rate limits
3000 per minute · 200000 per day · Set per key (rate_per_min and quota_daily returned by /api/v1/account are authoritative; the numbers above are a trial key's). Beyond them the answer is 429. In addition, heavy requests such as whole-table snapshots and statistics lists without a match id are processed 2 at a time for the whole platform; a request that cannot get a slot receives 429 with Retry-After. Responses do not carry X-RateLimit-* headers for now. See the general guide

Request parameters 1

ParameterTyperequiredExampleDescription
idsstringrequiredSeveral ids, comma separated, 200 at most

Example request

curl "https://api.sports.csap.ai/api/v1/matches/lineups/detail" \
  -H "X-API-Key: YOUR_API_KEY"

Try it

Example response

Real response with an external key at 09/11/2026, 14:28 UTC: HTTP 200, 1000 rows, 439 ms (data cut to 2 rows)

{
  "code": 0,
  "data": [
    {
      "confirmed": false,
      "gpid": 138,
      "has_shirt_number": null,
      "id": 1,
      "is_captain": null,
      "is_substitute": false,
      "match_source": "S4",
      "name_zh": "菲尔马林",
      "player_id": "1195101",
      "player_name": "Cristopher Fiermarín",
      "player_zh": null,
      "position": "11",
      "shirt_number": "25",
      "side": "home",
      "squad": null,
      "updated_at": 1794081802175,
      "name": "Cristopher Fiermarín"
    },
    {
      "confirmed": false,
      "gpid": 139,
      "has_shirt_number": null,
      "id": 2,
      "is_captain": null,
      "is_substitute": false,
      "match_source": "S4",
      "name_zh": "卡斯特里隆",
      "player_id": "739740",
      "player_name": "Nilson Castrillón",
      "player_zh": null,
      "position": "32",
      "shirt_number": "6",
      "side": "home",
      "squad": null,
      "updated_at": 1794081802176,
      "name": "Nilson Castrillón"
    }
  ],
  "message": "success",
  "success": true
}

Response fields 18

confirmedbooleanWhether the lineup is confirmedExample: false
gpidintegerPlatform player idExample: 138
has_shirt_numbernullnullableHas a shirt number: 1 yes, 0 no
idintegerRecord id; paging cursor (the id parameter returns records >= this value). In match endpoints it is the platform match id (gmid)Example: 1
is_captainnullnullableCaptain: 1 yes, 0 no
is_substitutebooleanWhether a substituteExample: false
match_sourcestringSource code of this rowExample: "S4"
gmidintegernullablePlatform match id (gmid, unique across the platform)
name_enstringEnglish nameExample: "Cristopher Fiermarín"
name_zhstringnullableChinese nameExample: "菲尔马林"
player_idstringPlayer idExample: "1195101"
player_namestringPlayer nameExample: "Cristopher Fiermarín"
player_zhnullnullablePlayer's Chinese name
positionstringnullablePositionExample: "11"
shirt_numberstringShirt numberExample: "25"
sidestringhome = home team / away = away teamExample: "home"
squadnullnullableSquad
updated_atintegerLast update time (UTC, ISO 8601; incremental sync with the time parameter goes by it)Example: 1794081802175

Errors

HTTPmessageWhen
401missing API key / unauthorizedNo X-API-Key, or the key is invalid or disabled
400bad param …Malformed parameter (e.g. id is neither a number nor u<uid>)
301match merged into <gmid>Queried by an old match id that has been merged into a new gmid: Location points to the new address and the body carries moved_to
404not foundThe match / team / competition does not exist, or is outside what this key can see (external keys see only matches inside the open coverage)
429rate limit exceeded / daily quota exceededThe key's per-minute rate or daily quota is exceeded
429server busy, retry laterThe server's concurrency slots are full (only 2 heavy requests at a time); retry after Retry-After seconds
500query errorThe query failed on the server; you may retry