NFL & college football play-by-play API by drive

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

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "insufficient_credits",
  "message": "Insufficient credits. Top up or subscribe to continue."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "x_api_unavailable",
  "message": "Xquik is busy right now. Retry shortly."
}

GET

sports

{league}

games

{id}

plays

NFL & college football play-by-play API by drive

curl --request GET \
  --url https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays

const options = {method: 'GET'};

fetch('https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "league": "<string>",
  "homeTeamId": "<string>",
  "awayTeamId": "<string>",
  "quarters": [
    {
      "id": "<string>",
      "number": 123,
      "sequence": 123,
      "drives": [
        {
          "id": "<string>",
          "sequence": 123,
          "offense": "<string>",
          "defense": "<string>",
          "startClock": "<string>",
          "endClock": "<string>",
          "startReason": "<string>",
          "endReason": "<string>",
          "playCount": 123,
          "firstDowns": 123,
          "netYards": 123,
          "scoring": true,
          "plays": [
            {
              "id": "<string>",
              "sequence": "<string>",
              "clock": "<string>",
              "type": "<string>",
              "direction": "<string>",
              "description": "<string>",
              "scoring": true,
              "homePoints": 123,
              "awayPoints": 123,
              "score": {},
              "start": {
                "down": 123,
                "yardsToGo": 123,
                "yardline": 123,
                "yardlineSide": "<string>",
                "possession": "<string>"
              },
              "onField": {},
              "details": [
                {
                  "sequence": 123,
                  "category": "<string>",
                  "description": "<string>",
                  "direction": "<string>",
                  "yards": 123,
                  "players": [
                    {}
                  ],
                  "penalty": {}
                }
              ],
              "post": {},
              "videoPostId": "<string>",
              "videoReplyPostId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "teams": {
    "id": "<string>",
    "name": "<string>",
    "shortName": "<string>",
    "abbreviation": "<string>",
    "alternateId": "<string>",
    "location": "<string>",
    "colors": [
      {}
    ],
    "logos": {},
    "xUserId": "<string>"
  },
  "players": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "shortName": "<string>",
    "jersey": "<string>",
    "position": "<string>",
    "college": "<string>",
    "birthPlace": "<string>",
    "birthDate": "<string>",
    "headshots": {},
    "xUser": {}
  }
}

1 credit per request · All plans from $0.00012/credit · Direct MPP at USD 0.00015 per call · Supports guest paid reads

curl "https://xquik.com/api/v1/x/sports/nfl/games/2055084502741811200/plays" \
  -H "x-api-key: xq_your_api_key_here" | jq

const gameId = "2055084502741811200";
const response = await fetch(`https://xquik.com/api/v1/x/sports/nfl/games/${gameId}/plays`, {
  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 quarter of game.quarters) {
  for (const drive of quarter.drives) {
    for (const play of drive.plays) {
      console.log(`Q${quarter.number} ${play.clock} ${play.description}`);
    }
  }
}

import requests

game_id = "2055084502741811200"
response = requests.get(
    f"https://xquik.com/api/v1/x/sports/nfl/games/{game_id}/plays",
    headers={"x-api-key": "xq_your_api_key_here"},
)
game = response.json()
if not response.ok:
    raise RuntimeError(game)

for quarter in game["quarters"]:
    for drive in quarter["drives"]:
        for play in drive["plays"]:
            print(f"Q{quarter['number']}", play["clock"], play["description"])

Read every drive & play of a game

Use GET /x/sports/{league}/games/{id}/plays for a game’s full play-by-play. Find the game ID with List football games.

quarters lists each quarter in order. Each quarter lists its drives, and each drive its plays.
A drive has its clock, how it started & ended, its first downs & its net yards.
A play has its clock, down & distance, description & the score after it.
details lists each step of a play, with its players, yards & any penalty.
post is the post X links to the play. videoPostId & videoReplyPostId point to its video.

Each player appears once in players, keyed by ID. Steps name players by playerId, with a playerRole such as Pass or Tackle. Pass a post ID to Get tweet to read it. A whole game fits 1 response, so there are no pages. quarters is empty before kickoff. NFL games name a side as Home or Away in offense, defense, possession & yardlineSide. College games name it by the team’s alternateId from teams.

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

The home team, a key of teams.

string

The away team, a key of teams.

object[]

The game’s quarters, in order. Empty before kickoff.

string

X’s ID for the quarter within the game.

number

The quarter’s number.

number

The quarter’s place in the game, from 1.

object[]

The quarter’s drives, in order.

string

X’s ID for the drive within the game.

number

The drive’s place in the game, from 1.

string

The team with the ball. Home or Away in NFL games, the team’s alternateId in college games.

string

The team on defense, named the way offense names it.

string

The game clock when the drive started, as HH:MM:SS.

string

The game clock when the drive ended, as HH:MM:SS.

string

How the drive started, such as Kickoff or Punt.

string

How the drive ended, such as Touchdown or Punt.

number

The drive’s plays.

number

The first downs the drive gained.

number

The yards the drive gained.

boolean

Whether the drive scored.

object[]

The drive’s plays, in order.

string

X’s ID for the play within the game.

string

The play’s place in its drive, as X writes it.

string

The game clock when the play started, as HH:MM:SS.

string

X’s kind of play, such as Pass, Rush, Punt or Conversion.

string

Where the play went, such as Left or Middle.

string

The play as the official play-by-play writes it.

boolean

Whether the play scored points.

number

The home team’s points after the play.

number

The away team’s points after the play.

object

For a scoring play, its points & the homePoints & awayPoints after it. Null otherwise.

object

Down & distance when the play started, or null.

number

The down, from 1 to 4.

number

The yards needed for a first down.

number

The yard line of the ball.

string

Whose half the ball was in. Home or Away in NFL games, the team’s alternateId in college games.

string

The team with the ball. Home or Away in NFL games, the team’s alternateId in college games.

object

Flags X shows on the field, or null. calledBack means a penalty called the play back. penaltyOnField means a flag was thrown. timeout means a timeout followed. underReview means officials were reviewing the play.

object[]

The play’s steps, in order, such as a pass, a tackle or a penalty.

number

The step’s place in the play, from 1.

string

X’s kind of step, such as Pass, Tackle or Penalty.

string

What happened in the step.

string

The direction X gives for the step.

number

The yards the step gained or lost.

object[]

The players in the step. Each has playerId, a key of players, & playerRole, such as Pass, Receive or Tackle.

object

The penalty this step called, or null. It has description, nextDown, result, yards & teamId, the penalized team.

object

The post X links to the play, with id & the author’s username. Null when X links none.

string

The ID of a post with the play’s video.

string

The ID of a reply with the play’s video.

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

{
  "error": "invalid_game_id",
  "message": "Send a numeric game ID, such as 2055084502741811200."
}

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

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

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.

{ "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

{ "error": "x_api_unavailable" }

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

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

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "insufficient_credits",
  "message": "Insufficient credits. Top up or subscribe to continue."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "x_api_unavailable",
  "message": "Xquik is busy right now. Retry shortly."
}

NFL & college football play-by-play API by drive

curl --request GET \
  --url https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays

const options = {method: 'GET'};

fetch('https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/x/sports/{league}/games/{id}/plays"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "league": "<string>",
  "homeTeamId": "<string>",
  "awayTeamId": "<string>",
  "quarters": [
    {
      "id": "<string>",
      "number": 123,
      "sequence": 123,
      "drives": [
        {
          "id": "<string>",
          "sequence": 123,
          "offense": "<string>",
          "defense": "<string>",
          "startClock": "<string>",
          "endClock": "<string>",
          "startReason": "<string>",
          "endReason": "<string>",
          "playCount": 123,
          "firstDowns": 123,
          "netYards": 123,
          "scoring": true,
          "plays": [
            {
              "id": "<string>",
              "sequence": "<string>",
              "clock": "<string>",
              "type": "<string>",
              "direction": "<string>",
              "description": "<string>",
              "scoring": true,
              "homePoints": 123,
              "awayPoints": 123,
              "score": {},
              "start": {
                "down": 123,
                "yardsToGo": 123,
                "yardline": 123,
                "yardlineSide": "<string>",
                "possession": "<string>"
              },
              "onField": {},
              "details": [
                {
                  "sequence": 123,
                  "category": "<string>",
                  "description": "<string>",
                  "direction": "<string>",
                  "yards": 123,
                  "players": [
                    {}
                  ],
                  "penalty": {}
                }
              ],
              "post": {},
              "videoPostId": "<string>",
              "videoReplyPostId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "teams": {
    "id": "<string>",
    "name": "<string>",
    "shortName": "<string>",
    "abbreviation": "<string>",
    "alternateId": "<string>",
    "location": "<string>",
    "colors": [
      {}
    ],
    "logos": {},
    "xUserId": "<string>"
  },
  "players": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "shortName": "<string>",
    "jersey": "<string>",
    "position": "<string>",
    "college": "<string>",
    "birthPlace": "<string>",
    "birthDate": "<string>",
    "headshots": {},
    "xUser": {}
  }
}

Overview

X API

X write

Trends

Radar

Account

API keys

Guest wallets

Credits

X accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

NFL & college football play-by-play API by drive

Read every drive & play of a game

Path parameters

Query parameters

Headers

Response

200 OK

400 Invalid game ID

404 Game not found

401 Unauthenticated

402 Payment required

502 X API unavailable

​Read every drive & play of a game

​Path parameters

​Query parameters

​Headers

​Response

​200 OK

​400 Invalid game ID

​404 Game not found

​401 Unauthenticated

​402 Payment required

​502 X API unavailable

Read every drive & play of a game

Path parameters

Query parameters

Headers

Response

200 OK

400 Invalid game ID

404 Game not found

401 Unauthenticated

402 Payment required

502 X API unavailable