Sports

Get football play-by-play

Changed on

Returns every drive & play of 1 game, by quarter. Each play has its clock, down & distance, details, penalties & linked posts. Each request costs 1 credit.

get/x/sports/{league}/games/{id}/plays

Request

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

Path parameters

league'nfl' | 'ncaafb' required
Example:nfl

nfl for the NFL or ncaafb for college football, in any case. Another value gets a free 400 invalid_league 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.

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

The game's drives & plays

idstring required

The ID of the game these plays come from.

league'nfl' | 'ncaafb' required

The league of the game these plays come from.

homeTeamIdstring nullable required

The home team, a key of teams.

awayTeamIdstring nullable required

The away team, a key of teams.

teamsobject required

The teams these plays name, by team ID.

playersobject required

The players these plays name, by player ID.

Example response

{
  "id": "2055084502741811200",
  "league": "nfl",
  "homeTeamId": "689566294702555136",
  "awayTeamId": "689566304366292992",
  "quarters": [
    {
      "id": "quarter-1",
      "number": 1,
      "sequence": 1,
      "drives": []
    }
  ],
  "teams": {},
  "players": {}
}

Changes

  • e29bc136a9ccRevision changes
    • breaking

      the response property const value changed from /dashboard/account to /dashboard/billing for the status

    • breaking

      the response property const value changed from /dashboard/account to /dashboard/billing for the status

    • breaking

      the response property const value changed from /dashboard/account to /dashboard/billing for the status

    • breaking

      the response property const value changed from Ask the user to top up at /dashboard/account. This key cannot open checkout. to Ask the user to top up at /dashboard/billing. This key cannot open checkout. for the status

  • d94eba2599ffRevision changes
    • info

      added the required property // to the response with the status