Rocket League Stats API

This document outlines capabilities of the Rocket League Game Data API. First, players must ask the game to enable this feature by editing their DefaultStatsAPI.ini, explained below. Once active, this feature will open a web socket on the player's machine that emits gameplay data and events. Third party programs can ingest this data to power a variety of applications, such as custom broadcaster HUDs.

Overview

The Stats API broadcasts JSON messages over a local socket while a match is in progress. Messages are sent both at a configurable periodic rate and when specific match events occur. Event data is always emitted on the same tick that the event occurs, regardless of the user's PacketSendRate.

Note: All configuration must be done before the client starts — changes to the ini while the client is running require a restart.

Field visibility:

Fields marked CONDITIONAL are only present when relevant.
Fields marked SPECTATOR are only present if the client is spectating or on the player's team.

Configuration

Edit <Install Dir>\TAGame\Config\DefaultStatsAPI.ini before launching the client.

Setting	Type	Default	Description
PacketSendRate	float	0 (disabled)	Number of UpdateState packets broadcast per second. Must be > 0 to enable the websocket. Capped at 120.
Port	int	49123	Local port the socket listens on.

Message Format

Every message follows this envelope structure:

{
  "Event": "EventName",
  "Data":  { /* event-specific payload */ }
}

Tick

Sent X amount of times per second based on the player's PacketSendRate preference.

Example

{
  "Event": "UpdateState",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "Players": [
      {
        "Name": "PlayerA",
        "PrimaryId": "Steam|123|0",
        "Shortcut": 1,
        "TeamNum": 0,
        "Score": 125,
        "Goals": 1,
        "Shots": 2,
        "Assists": 0,
        "Saves": 1,
        "Touches": 14,
        "CarTouches": 3,
        "Demos": 0,
        "bHasCar": true,
        "Speed": 1200,
        "Boost": 45,
        "bBoosting": true,
        "bOnGround": true,
        "bOnWall": false,
        "bPowersliding": false,
        "bDemolished": true,
        "Attacker": {
          "Name": "PlayerB",
          "Shortcut": 2,
          "TeamNum": 1
        },
        "bSupersonic": true
      }
    ],
    "Game": {
      "Teams": [
        {
          "Name": "Blue",
          "TeamNum": 0,
          "Score": 1,
          "ColorPrimary": "0000FF",
          "ColorSecondary": "0000AA"
        }
      ],
      "TimeSeconds": 180,
      "bOvertime": false,
      "Frame": 120,
      "Elapsed": 50.2,
      "Ball": {
        "Speed": 850.5,
        "TeamNum": 0
      },
      "bReplay": false,
      "bHasWinner": true,
      "Winner": "Blue",
      "Arena": "Stadium_P",
      "bHasTarget": true,
      "Target": {
        "Name": "PlayerA",
        "Shortcut": 1,
        "TeamNum": 0
      }
    }
  }
}

Field	Type	Description
Players	array	One entry per player in the match.
Name	string	Display name.
PrimaryId	string	Platform identifier in the format Platform\|Uid\|Splitscreen (e.g. "Steam\|123\|0", "Epic\|456\|0").
Shortcut	int	Spectator shortcut number.
TeamNum	int	Team index (0 = Blue, 1 = Orange).
Score	int	Total match score.
Goals	int	Goals scored this match.
Shots	int	Shot attempts this match.
Assists	int	Assists earned this match.
Saves	int	Saves made this match.
Touches	int	Total ball touches.
CarTouches	int	Touches by the car body (not ball).
Demos	int	Demolitions inflicted.
bHasCar	bool	SPECTATORTrue if the player currently has a vehicle.
Speed	float	SPECTATORVehicle speed in Unreal Units/second.
Boost	int	SPECTATORBoost amount 0–100.
bBoosting	bool	SPECTATORTrue if the player is currently boosting.
bOnGround	bool	SPECTATORTrue if at least 3 wheels are touching the world.
bOnWall	bool	SPECTATORTrue if the vehicle is on a wall.
bPowersliding	bool	SPECTATORTrue if the player is holding handbrake.
bDemolished	bool	SPECTATORTrue if the vehicle is currently destroyed.
bSupersonic	bool	SPECTATORTrue if the vehicle is at supersonic speed.
Attacker	object	CONDITIONALThe player who demolished this player. Present only when demolished.
Name	string	Name of the player who demolished this player.
Shortcut	int	Spectator shortcut of the attacker.
TeamNum	int	Team index of the attacker.
Game	object	Match metadata.
Teams	array	One entry per team, ordered by TeamNum.
Name	string	Team name.
TeamNum	int	Team index.
Score	int	Team goal count.
ColorPrimary	string	Hex color code (no #) for the team’s primary color.
ColorSecondary	string	Hex color code for the team’s secondary color.
TimeSeconds	int	Seconds remaining in the match.
bOvertime	bool	True if the match is in overtime.
Ball	object	Current ball state.
Speed	float	Current ball speed in Unreal Units/second.
TeamNum	int	Index of the last team to touch the ball. 255 if the ball has not been touched.
bReplay	bool	True if a goal replay or history replay is active.
bHasWinner	bool	True if a team has won.
Winner	string	Name of the winning team. Empty string if no winner yet.
Arena	string	Asset name of the current map (e.g. "Stadium_P").
bHasTarget	bool	True if the client is currently viewing a specific vehicle.
Target	object	CONDITIONALPlayer currently being viewed. Members are an empty string or 0 if the player does not have a spectator target.
Name	string	Name of the player being viewed.
Shortcut	int	Spectator shortcut of the viewed player.
TeamNum	int	Team index of the viewed player.
Frame	int	CONDITIONALCurrent frame number if a replay is active.
Elapsed	float	CONDITIONALSeconds elapsed since game start if a replay is active.

Events

Sent one frame after the ball is hit.

Example

{
  "Event": "BallHit",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "Players": [
      {
        "Name": "PlayerA",
        "Shortcut": 1,
        "TeamNum": 0
      }
    ],
    "Ball": {
      "PreHitSpeed": 0,
      "PostHitSpeed": 1450.2,
      "Location": {
        "X": -512,
        "Y": 100,
        "Z": 200
      }
    }
  }
}

Field	Type	Description
Players	array	Players that hit the ball that frame.
Name	string	Display name.
Shortcut	int	Spectator shortcut.
TeamNum	int	Team index (0 = Blue, 1 = Orange).
Ball	object	Ball state at the moment of the hit.
PreHitSpeed	float	Ball speed before the hit (Unreal Units/second).
PostHitSpeed	float	Ball speed after the hit (Unreal Units/second).
Location	vector	World position (X, Y, Z) of the ball at impact.
MatchGuid	string	Only set for online or LAN matches.

Sent when the in-game clock has changed.

Example

{
  "Event": "ClockUpdatedSeconds",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "TimeSeconds": 180,
    "bOvertime": false
  }
}

Field	Type	Description
TimeSeconds	int	Seconds remaining in the match.
bOvertime	bool	True if the game is in overtime.
MatchGuid	string	Only set for online or LAN matches.

Sent at the start of each round when the countdown starts.

Example

{
  "Event": "CountdownBegin",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the ball hits a crossbar.

Example

{
  "Event": "CrossbarHit",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "BallLocation": {
      "X": 120,
      "Y": -2944,
      "Z": 320
    },
    "BallSpeed": 870.3,
    "ImpactForce": 127.5,
    "BallLastTouch": {
      "Player": {
        "Name": "PlayerA",
        "Shortcut": 1,
        "TeamNum": 0
      },
      "Speed": 120
    }
  }
}

Field	Type	Description
BallSpeed	float	Ball speed on impact.
ImpactForce	float	Impact force of the ball relative to the crossbar normal.
BallLastTouch	object	The last touch of the ball before the crossbar hit.
Player	object	The player who made the last touch.
Name	string	Display name.
Shortcut	int	Spectator shortcut.
TeamNum	int	Team index (0 = Blue, 1 = Orange).
Speed	float	Speed of the ball resulting from this hit.
BallLocation	vector	World position (X, Y, Z) of the ball when the impact occurred.
MatchGuid	string	Only set for online or LAN matches.

Sent when a goal replay ends.

Example

{
  "Event": "GoalReplayEnd",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when a goal replay starts.

Example

{
  "Event": "GoalReplayStart",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the ball explodes during a goal replay. If the replay is skipped this event will not fire.

Example

{
  "Event": "GoalReplayWillEnd",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when a goal is scored.

Example

{
  "Event": "GoalScored",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "GoalSpeed": 87.3,
    "GoalTime": 127.5,
    "ImpactLocation": {
      "X": 0,
      "Y": -2944,
      "Z": 320
    },
    "Scorer": {
      "Name": "PlayerA",
      "Shortcut": 1,
      "TeamNum": 0
    },
    "Assister": {
      "Name": "PlayerC",
      "Shortcut": 3,
      "TeamNum": 0
    },
    "BallLastTouch": {
      "Player": {
        "Name": "PlayerA",
        "Shortcut": 1,
        "TeamNum": 0
      },
      "Speed": 125
    }
  }
}

Field	Type	Description
GoalSpeed	float	Speed of the ball (Unreal Units/second) when it crossed the goal line.
GoalTime	float	Length of the previous round in seconds.
ImpactLocation	vector	World position (X, Y, Z) of the ball when the goal was scored.
Scorer	object	The player who scored the goal.
Name	string	Display name of the scorer.
Shortcut	int	Spectator shortcut.
TeamNum	int	Team index of the scorer.
BallLastTouch	object	The last touch of the ball before the goal.
Player	object	The player who made the last touch.
Name	string	Name of the player who last touched the ball.
Shortcut	int	Spectator shortcut.
TeamNum	int	Team index.
Speed	float	Speed of the ball resulting from this touch.
Assister	object	CONDITIONALSame shape as Scorer. Present only when an assist was recorded.
MatchGuid	string	Only set for online or LAN matches.

Sent when all teams are created and replicated.

Example

{
  "Event": "MatchCreated",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the first countdown starts.

Example

{
  "Event": "MatchInitialized",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when leaving the game.

Example

{
  "Event": "MatchDestroyed",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the match ends and a winner is chosen.

Example

{
  "Event": "MatchEnded",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "WinnerTeamNum": 0
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.
WinnerTeamNum	int	Team index of the winning team.

Sent when the game is paused by a match admin.

Example

{
  "Event": "MatchPaused",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the game is unpaused by a match admin.

Example

{
  "Event": "MatchUnpaused",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the game enters the podium state after the match ends.

Example

{
  "Event": "PodiumStart",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when a replay is initialized. Does not pertain to goal replays, only replays you load via the Match History menu.

Example

{
  "Event": "ReplayCreated",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when the game enters the active state (after the countdown finishes).

Example

{
  "Event": "RoundStarted",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"
  }
}

Field	Type	Description
MatchGuid	string	Only set for online or LAN matches.

Sent when someone earns a stat.

Example

{
  "Event": "StatfeedEvent",
  "Data": {
    "MatchGuid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
    "EventName": "Demolish",
    "Type": "Demolition",
    "MainTarget": {
      "Name": "PlayerA",
      "Shortcut": 1,
      "TeamNum": 0
    },
    "SecondaryTarget": {
      "Name": "PlayerB",
      "Shortcut": 2,
      "TeamNum": 1
    }
  }
}

Field	Type	Description
EventName	string	Asset name of the StatEvent (e.g. "Demolish", "Save").
Type	string	Localized display label for the stat (e.g. "Demolition").
MainTarget	object	Player who earned the stat.
Name	string	Display name.
Shortcut	int	Spectator shortcut.
TeamNum	int	Team index (0 = Blue, 1 = Orange).
MatchGuid	string	Only set for online or LAN matches.
SecondaryTarget	object	CONDITIONALPlayer involved in the stat (e.g. the demolished player). Same shape as MainTarget.

Rocket League Stats API

Overview

Configuration

Message Format

Tick

UpdateState▾

UpdateState

Example

Events

BallHit▾

BallHit

Example

ClockUpdatedSeconds▾

ClockUpdatedSeconds

Example

CountdownBegin▾

CountdownBegin

Example

CrossbarHit▾

CrossbarHit

Example

GoalReplayEnd▾

GoalReplayEnd

Example

GoalReplayStart▾

GoalReplayStart

Example

GoalReplayWillEnd▾

GoalReplayWillEnd

Example

GoalScored▾

GoalScored

Example

MatchCreated▾

MatchCreated

Example

MatchInitialized▾

MatchInitialized

Example

MatchDestroyed▾

MatchDestroyed

Example

MatchEnded▾

MatchEnded

Example

MatchPaused▾

MatchPaused

Example

MatchUnpaused▾

MatchUnpaused

Example

PodiumStart▾

PodiumStart

Example

ReplayCreated▾

ReplayCreated

Example

RoundStarted▾

RoundStarted

Example

StatfeedEvent▾

StatfeedEvent

Example

`UpdateState`

`BallHit`

`ClockUpdatedSeconds`

`CountdownBegin`

`CrossbarHit`

`GoalReplayEnd`

`GoalReplayStart`

`GoalReplayWillEnd`

`GoalScored`

`MatchCreated`

`MatchInitialized`

`MatchDestroyed`

`MatchEnded`

`MatchPaused`

`MatchUnpaused`

`PodiumStart`

`ReplayCreated`

`RoundStarted`

`StatfeedEvent`