> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NFL game roster API with player X accounts

> Get both teams' rosters for 1 NFL game from X, with each player's jersey, position, headshot & X account, plus each team's name, colors & logos. 1 credit.

**200**

```json theme={null}
{
  "id": "2055084502741811200",
  "league": "nfl",
  "rosters": [
    {
      "teamId": "689566294702555136",
      "playerIds": [
        "1520565710329499648"
      ]
    }
  ],
  "teams": {},
  "players": {}
}
```

**400**

```json theme={null}
{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}
```

**401**

```json theme={null}
{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}
```

**402**

```json theme={null}
{
  "error": "insufficient_credits",
  "message": "Insufficient credits. Top up or subscribe to continue."
}
```

**404**

```json theme={null}
{
  "error": "not_found",
  "message": "Resource not found."
}
```

**424**

```json theme={null}
{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}
```

**429**

```json theme={null}
{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}
```

**502**

```json theme={null}
{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}
```

**503**

```json theme={null}
{
  "error": "x_api_unavailable",
  "message": "Xquik is busy right now. Retry shortly."
}
```

> For the complete documentation index, see [llms.txt](https://docs.xquik.com/llms.txt).

**1 credit per request** · [All plans](https://xquik.com/#pricing) from \$0.00012/credit · Direct [MPP](https://docs.xquik.com/mpp/machine-payments-protocol.md) at USD 0.00015 per call · Supports [guest paid reads](https://docs.xquik.com/guides/guest-wallets.md)

```bash cURL theme={null}
curl "https://xquik.com/api/v1/x/sports/nfl/games/2055084502741811200/roster" \
  -H "x-api-key: xq_your_api_key_here" | jq
```

```javascript Node.js theme={null}
const gameId = "2055084502741811200";
const response = await fetch(`https://xquik.com/api/v1/x/sports/nfl/games/${gameId}/roster`, {
  headers: { "x-api-key": "xq_your_api_key_here" },
});
const game = await response.json();
if (!response.ok) throw new Error(JSON.stringify(game));
for (const roster of game.rosters) {
  console.log(game.teams[roster.teamId]?.name);
  for (const playerId of roster.playerIds) {
    const player = game.players[playerId];
    console.log(`#${player?.jersey} ${player?.name} ${player?.position}`);
  }
}
```

```python Python theme={null}
import requests

game_id = "2055084502741811200"
response = requests.get(
    f"https://xquik.com/api/v1/x/sports/nfl/games/{game_id}/roster",
    headers={"x-api-key": "xq_your_api_key_here"},
)
game = response.json()
if not response.ok:
    raise RuntimeError(game)
for roster in game["rosters"]:
    print(game["teams"].get(roster["teamId"], {}).get("name"))
    for player_id in roster["playerIds"]:
        player = game["players"].get(player_id, {})
        print(f"#{player.get('jersey')}", player.get("name"), player.get("position"))
```

## Read both rosters

Use `GET /x/sports/{league}/games/{id}/roster` for the players of both teams. Find the game ID with
[List football games](https://docs.xquik.com/api-reference/x/sports-games.md).

* `rosters` holds each team's `teamId` & its `playerIds`, in X's order.
* `players` holds each player once, keyed by ID, with jersey, position, headshot & X account.
* A player's `xUser` also says whether the account is `protected`, can offer subscriptions & has a
  highlighted label.

Rosters carry no college, birth details or large photos, so those fields are null. The
[box score](https://docs.xquik.com/api-reference/x/sports-game-box-score.md) has them for players who recorded stats.

## Path parameters

**league** `string` *required*

`nfl`, in any case. X has no college rosters, so `ncaafb` gets a free `400 unsupported_league`.
Another value gets a free `400 invalid_league`.

**id** `string` *required*

Game ID, a number up to 19 digits, such as `2055084502741811200`. [List football
games](https://docs.xquik.com/api-reference/x/sports-games.md) returns it as `id`. Another value gets a free `400
    invalid_game_id`.

## Query parameters

**fields** `string`

Fields to keep in each row, comma-separated, such as `id,text,author.username`. Use dots for nested fields. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name returns `400 unknown_field` with the valid names, before any read. The price stays the same.

**omit** `string`

Fields to drop from each row, comma-separated, such as `entities,media`. It takes the same names as `fields`. With `fields`, it drops from the kept fields.

## Headers

**x-api-key** `string`

Full account key. Sessions and OAuth also work.

**Authorization** `string`

`Bearer xq_your_guest_key_here` for `paid_reads`.

## Response

### 200 OK

**id** `string`

The game ID from your request.

**league** `string`

Always `nfl`.

**rosters** `object[]`

Each team's roster, in X's order.

**teamId** `string`

The team, a key of `teams`.

**playerIds** `string[]`

The team's players in X's order, keys of `players`.

**teams** `object`

The 2 teams, keyed by team ID.

**id** `string`

The team ID that games & players refer to.

**name** `string`

The team's full name, such as `San Francisco 49ers`.

**shortName** `string`

The team's short name.

**abbreviation** `string`

The team's abbreviation, such as `SF`.

**alternateId** `string`

Another ID X keeps for the team. College plays & drives name a side by it.

**location** `string`

The school or place the team plays for. College schedules & a game's audience send it.

**colors** `object[]`

The team's colors. Each has `r`, `g` & `b`, from 0 to 255.

**logos** `object`

The team's logo links. `default` is the one X shows. `light` & `dark` suit light or dark
backgrounds.

**xUserId** `string`

The user ID of the team's X account. Pass it to [Get
user](https://docs.xquik.com/api-reference/x/twitter-profile-lookup.md).

**record** `object`

The team's `wins`, `losses` & `ties` this season. X sends it only in college football games.

**recentGames** `object[]`

The team's recent games, newest first. Games without a kickoff time come last. Each has `id`,
`startsAt`, `venue`, `status`, `clock`, `quarter`, `home` & `away`. `home` & `away` hold `teamId`
& `points`. X sends them only with the teams of a college football game. The list is empty
elsewhere.

**players** `object`

Every rostered player, keyed by player ID.

**id** `string`

The player ID that plays & stats refer to.

**teamId** `string`

The player's team, a key of `teams`.

**name** `string`

The player's full name.

**shortName** `string`

The name play descriptions use, such as `B.Purdy`.

**jersey** `string`

The jersey number, as text.

**position** `string`

The position, such as `QB` or `DE`.

**college** `string`

The college the player came from.

**birthPlace** `string`

Where the player was born. X sends it only for NFL players.

**birthDate** `string`

The birth date, as `YYYY-MM-DD`.

**headshots** `object`

Photo links in `original`, `large`, `medium` & `small`. Any of them can be null.

**xUser** `object`

The player's X account, with `id`, `username` & `blueVerified`. Null when the player has none.
Rosters also fill `protected`, `superFollowEligible` & the highlighted `labelType`, such as
`BusinessLabel`. Other answers send them as null.

### 400 Unsupported league

```json theme={null}
{
  "error": "unsupported_league",
  "message": "Rosters & player props cover nfl only. Send nfl as the league."
}
```

Send `nfl` as the league. A game ID that is not a number gets `invalid_game_id`. Both answers are
free.

### 404 Game not found

```json theme={null}
{
  "error": "game_not_found",
  "message": "Game not found. Find game IDs with GET /x/sports/nfl/games."
}
```

X knows no NFL game with this ID. This answer is free.

### 401 Unauthenticated

Anonymous requests get `WWW-Authenticate: Bearer` and a guest wallet checkout action. This is not a Payment challenge.

```json theme={null}
{ "error": "unauthenticated" }
```

### 402 Payment required

Account keys get account options. Guest keys get guest top-up only.
No checkout starts automatically. Confirm any payment action.

### 502 X API unavailable

```json theme={null}
{ "error": "x_api_unavailable" }
```

The read service returned an error. Retry after a short delay.

> [!NOTE]
>
> **Related.** [List football games](https://docs.xquik.com/api-reference/x/sports-games.md) · [Get football box
> score](https://docs.xquik.com/api-reference/x/sports-game-box-score.md) · [Get NFL player
> props](https://docs.xquik.com/api-reference/x/sports-game-player-props.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.