GET/api/v1/matches/lineups/by-match

One global lineup for a match

LineupsBy matchactivebetacoreAvailable (scoped)

Description

Pass match_id (the platform match id); returns one lineup for the match (a confirmed one first), with the platform player id (gpid), Chinese and English names, position and starter / substitute.

Access

Request: GET https://api.sports.csap.ai/api/v1/matches/lineups/by-match
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 2

Parameter	Type	required	Example	Description
match_id	integer	required	`5179`	Platform match id (gmid); the gmid / id parameters are accepted too
limit	integer	optional	`2`	Default 100

Example request

curl "https://api.sports.csap.ai/api/v1/matches/lineups/by-match?limit=2&match_id=5179" \
  -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, 2 rows, 106 ms (data cut to 2 rows)

{
  "code": 0,
  "data": [
    {
      "confirmed": true,
      "gpid": null,
      "is_substitute": false,
      "logo": null,
      "match_source": "S3",
      "name_zh": null,
      "player_name": "拉瓦尼诺",
      "position": null,
      "shirt_number": null,
      "side": "away"
    },
    {
      "confirmed": true,
      "gpid": null,
      "is_substitute": false,
      "logo": null,
      "match_source": "S3",
      "name_zh": null,
      "player_name": "穆勒",
      "position": null,
      "shirt_number": null,
      "side": "away"
    }
  ],
  "message": "success",
  "success": true
}

Response fields 12

confirmedbooleanWhether the lineup is confirmedExample: true

gpidnullnullablePlatform player id

is_substitutebooleanWhether a substituteExample: false

logonullnullableLogo (image address on this platform; empty when there is none)

match_sourcestringSource code of this rowExample: "S3"

gmidintegernullablePlatform match id (gmid, unique across the platform)

name_ennullnullableEnglish name

name_zhnullnullableChinese name

player_namestringPlayer nameExample: "拉瓦尼诺"

positionnullnullablePosition

shirt_numbernullnullableShirt number

sidestringhome = home team / away = away teamExample: "away"

Errors

HTTP	message	When
401	`missing API key / unauthorized`	No X-API-Key, or the key is invalid or disabled
400	`bad param …`	Malformed parameter (e.g. id is neither a number nor u<uid>)
301	`match 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
404	`not found`	The match / team / competition does not exist, or is outside what this key can see (external keys see only matches inside the open coverage)
429	`rate limit exceeded / daily quota exceeded`	The key's per-minute rate or daily quota is exceeded
429	`server busy, retry later`	The server's concurrency slots are full (only 2 heavy requests at a time); retry after Retry-After seconds
500	`query error`	The query failed on the server; you may retry