Sports

Get a football scoreboard

Changed on

Returns 1 game's scoreboard. It has the teams, the score by period, the status & clock, down & distance, the venue & the latest play. Each request costs 1 credit.

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

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/sports/{league}/games/{id}
  • 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 scoreboard

idstring required

The game ID from your request.

league'nfl' | 'ncaafb' required

The league from your request.

seasonIdstring nullable required

X's ID for the season. NFL games have one.

seasonTypestring nullable required

The part of the season, such as RegularSeason.

weekinteger nullable required

The week of the season.

startsAtstring date-time nullable required

The kickoff time in UTC, or null when X sends none Xquik can read.

venuestring nullable required

The stadium.

statusstring nullable required

X's game status, such as Scheduled, InProgress or Closed.

clockstring nullable required

The game clock, as X writes it.

quarterinteger nullable required

The current or last quarter.

teamsobject required

The teams this answer names, by team ID.

playersobject required

The players this answer names, by player ID.

Example response

{
  "id": "2055084502741811200",
  "league": "nfl",
  "seasonId": "2039131233582546945",
  "seasonType": "RegularSeason",
  "week": 6,
  "startsAt": "2026-10-20T00:15:00.000Z",
  "venue": "Levi's Stadium",
  "status": "Closed",
  "clock": "00:00:00",
  "quarter": 4,
  "situation": {
    "down": 3,
    "yardsToGo": 22,
    "yardline": 40,
    "yardlineTeamId": "689566294702555136",
    "possessionTeamId": "689566304366292992"
  },
  "home": {
    "teamId": "689566294702555136",
    "points": 23,
    "timeoutsLeft": 2
  },
  "away": {
    "teamId": "689566304366292992",
    "points": 17,
    "timeoutsLeft": 0
  },
  "periods": [
    {
      "number": 1,
      "type": "Quarter",
      "sequence": 1,
      "homePoints": 13,
      "awayPoints": 3
    }
  ],
  "lastPlay": null,
  "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