XQxquik-dev
Sports

Get the rosters of an NFL game

Changed on

Returns both teams' players for 1 NFL game. Each player has a jersey, position, headshot & X account. Each request costs 1 credit.

get/api/v1/x/sports/{league}/games/{id}/roster

Request

  • Base URL
    https://xquik.com
  • URL
    https://xquik.com/api/v1/x/sports/{league}/games/{id}/roster
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or none

Path parameters

league'nfl' required
Example:nfl

nfl, in any case. X has no college rosters or props, so ncaafb gets a free 400 unsupported_league. Another value gets a free 400 invalid_league. Both come before X is read.

idstring required
Example:2055084502741811200

Game ID, a number up to 19 digits. GET /x/sports/{league}/games lists them. Another value gets a free 400 invalid_game_id before X is read.

Query parameters

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with fields & omit.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

Both teams' rosters

idstring required

The ID of the game these rosters cover.

league'nfl' required

The league of the game these rosters cover.

teamsobject required

The 2 teams, by team ID.

playersobject required

Every rostered player, by player ID. Rosters carry no college or birth details & only a medium headshot, so the rest are null.

Example response

{
  "id": "2055084502741811200",
  "league": "nfl",
  "rosters": [
    {
      "teamId": "689566294702555136",
      "playerIds": [
        "1520565710329499648"
      ]
    }
  ],
  "teams": {},
  "players": {}
}

Changes