Skip to main content
GET
NFL & college football live scoreboard API
1 credit per request · All plans from $0.00012/credit · Direct MPP at USD 0.00015 per call · Supports guest paid reads

Read a football game’s live score

Use GET /x/sports/{league}/games/{id} for 1 game’s score, clock & situation. Find the game ID with List football games. Call it again to follow a live game.
  • home & away hold each team’s teamId, points & timeoutsLeft.
  • periods lists the points of each period, in order.
  • situation has the down, the yards to go & the team with the ball.
  • lastPlay is the latest play, with the fields Get football plays returns.
  • teams & players hold each team & player once, keyed by ID.
situation & lastPlay are null before kickoff. Fields such as teamId & playerId are keys of teams & players.

Path parameters

string
required
nfl for the NFL or ncaafb for college football, in any case. Another value gets a free 400 invalid_league.
string
required
Game ID, a number up to 19 digits, such as 2055084502741811200. List football games returns it as id. Another value gets a free 400 invalid_game_id.

Query parameters

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.
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

string
Full account key. Sessions and OAuth also work.
string
Bearer xq_your_guest_key_here for paid_reads.

Response

200 OK

string
The game ID from your request.
string
The league from your request, nfl or ncaafb.
string
X’s ID for the season. NFL games have one.
string
The part of the season, such as RegularSeason.
number
The week of the season.
string
The kickoff time in UTC. Null when X sends a time Xquik cannot read.
string
The stadium.
string
X’s game status, such as Scheduled, InProgress or Closed.
string
The game clock, as X writes it.
number
The current or last quarter.
object
Down & distance now, or null before kickoff.
number
The down, from 1 to 4.
number
The yards needed for a first down.
number
The yard line of the ball.
string
The team whose half the ball is in, a key of teams.
string
The team with the ball, a key of teams.
object
The home team’s teamId, a key of teams, its points & its timeoutsLeft.
object
The away team’s teamId, a key of teams, its points & its timeoutsLeft.
object[]
Points by period, in order. Each has type, such as Quarter, number, sequence from 1, homePoints & awayPoints.
object
The latest play, or null before kickoff. It has the play fields of Get football plays.
object
The teams this answer names, keyed by team ID.
string
The team ID that games & players refer to.
string
The team’s full name, such as San Francisco 49ers.
string
The team’s short name.
string
The team’s abbreviation, such as SF.
string
Another ID X keeps for the team. College plays & drives name a side by it.
string
The school or place a college team plays for. X sends it only in college schedules.
object[]
The team’s colors. Each has r, g & b, from 0 to 255.
object
The team’s logo links. default is the one X shows. light & dark suit light or dark backgrounds.
string
The user ID of the team’s X account. Pass it to Get user.
object
The players this answer names, keyed by player ID.
string
The player ID that plays & stats refer to.
string
The player’s team, a key of teams.
string
The player’s full name.
string
The name play descriptions use, such as B.Purdy.
string
The jersey number, as text.
string
The position, such as QB or DE.
string
The college the player came from.
string
Where the player was born.
string
The birth date, as YYYY-MM-DD.
object
Photo links in original, large, medium & small. Any of them can be null.
object
The player’s X account, with id, username & blueVerified. Null when the player has none.

400 Invalid game ID

The game ID is not a number. A league other than nfl or ncaafb gets invalid_league. Both answers are free.

404 Game not found

X knows no game with this ID in the league. This answer is free.

401 Unauthenticated

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

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

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