Eve library

V2 Caster Overlay API

Other

Revision 1

On this page

The Caster Overlay API exposes tournament-safe match state to verified tournament organizers and approved third-party overlay developers.

Access#

Every event gets a short-lived API token issued by a verified tournament organizer account. Browser-source overlays should connect with a read-only token scoped to one eventId and one matchId.

Transports#

  • WebSocket: /v2/caster-api/ws
  • REST snapshot: /v2/caster-api/matches/{matchId}

Required Match State#

The schema covers per-player attributes, per-tick fighter position, per-tick combat meters, pose, current move data, match clock, ruleset, and damage events.

Reference Overlays#

The reference-overlays folder contains an OBS-compatible browser source with spectator, lower-thirds, bracket, health-bar, and combo-counter widgets. Each widget uses the same JSON match state shape documented in schema.json.

Submission Review#

Third-party overlay submissions must declare requested fields, token scopes, and capture-safe regions. Approved overlays can be surfaced in the in-game caster catalog.