Ultie.org Docs
For OrganizersEventsSuggest Feature
  • 🥏For players
    • Sign Up
    • Joining a Team
    • Extended Registration Form & Liability Waiver
    • Player Fees & Payments
    • What is a Liability Waiver & Why should I use one in the world of sport events?
    • Group calculation rules
  • 👬For team managers
    • Creating a Team
    • How to Add Players to Your Team
    • Accepting a Player into Your Team
    • Registering a Team for an Event
    • Sending a Roster
    • Changing a Roster for an Event
    • Extended Registration Form & Liability Waiver
    • Fees & Payments
      • Pay by Manager
      • Pay by Player
    • Entering Spirit Scores
    • Withdrawing from an Event
  • 👩‍💻 For staff
    • Introduction
    • Managing the Game
      • Starting the Game
      • Adding Points
      • Editing Points
      • Cancelling Points
      • Taking a Timeout
      • Starting Halftime
      • How to Pause a Game
      • Editing Rosters
      • Forcefully Ending a Game
      • Regulating Game Time
      • How to Find the Regulations
      • What to do if you lose the internet
    • SOTG Monitoring
  • 💼For Organizers
    • Introduction
    • Creating an Event
    • Editing an Event Information
      • Event Information
      • Event Format
      • Dates
      • Venues
      • Rules & Regulations
    • Tournament / League
      • Extended Team Registration Form
      • Extended Player Registration Form & Liability Waiver
      • Fees & Payments
        • Fees Management
        • Payment Methods
        • Payment Tracking
      • Accepting Team Applications
      • Editing Accepted Teams
      • Editing Rosters
    • Hat Event
      • Extended Player Registration
      • Accepting Players' Applications
      • Create Team
      • Distribute Players
    • Bracket and Schedule
    • Staff Management
    • Ending Event
    • FAQ
  • Live Game Data Feed for OBS & vMix
  • 🚫Site Policy
    • Privacy Policy
    • Terms of Service
    • Cookie Policy
    • Return Policy
    • How to Delete Your Account
  • 🧭About
    • Roadmap
Powered by GitBook
On this page
  • Getting the Feed URL
  • Understanding the Data Fields
  • How to Use It in OBS & vMix
  • Using in vMix (via Data Source Input)
  • Quick Mapping Tips
  • Test Data

Was this helpful?

Live Game Data Feed for OBS & vMix

PreviousFAQNextPrivacy Policy

Last updated 4 days ago

Was this helpful?

Getting the Feed URL

For every field at your tournament, there's a live data feed you can use in real-time overlays for OBS, vMix, or other broadcasting tools. Feeds are available in CSV or JSON formats — use whatever works best for your workflow.

Examples:

  • CSV: https://api.ultie.org/export/game-on-the-field/spring2025/1/csv

  • JSON: https://api.ultie.org/export/game-on-the-field/spring2025/1/json

URL Structure:

  • {tournament_URL} — Tournament URL ID like spring2025, windmill2025, etc.

  • {field_number} — the field number: 1, 2, 3, etc.

  • {format} — either csv or json

Understanding the Data Fields

Each feed provides a snapshot of the current game state. Here’s what the fields mean:

Field
Description

status

Game status: NOT_STARTED, IN_PROGRESS, or FINISHED

field

Field number

homeTeamScore

Score for the team on the left (home team)

visitorTeamScore

Score for the team on the right (visiting team)

homeTeamTitle

Full name of the left (home) team

visitorTeamTitle

Full name of the right (visitor) team

homeTeamAlias

Short version of the home team name (up to 5 characters)

visitorTeamAlias

Short version of the visitor team name (up to 5 characters)

homeTeamCity

Full name of the home team’s city

visitorTeamCity

Full name of the visitor team’s city

remainTimeText

Time remaining, in MM:SS format (e.g. 23:59)

timePassedText

Game time elapsed, in MM:SS format

isPaused

true if the game clock is currently paused

timePassedSec

Time elapsed in seconds

remainTimeSec

Time remaining in seconds

durationSec

Total match duration in seconds

startedAt

Game start timestamp (server time)

Note: homeTeamAlias and visitorTeamAlias are custom short codes (max 5 characters) used in overlays. These need to be sent to the tournament organizer or to us in advance, so we can register them in the system.

How to Use It in OBS & vMix

Using in OBS (via Text GDI+ & Auto-Updating File)

  1. Add a new Text (GDI+) source in OBS

  2. Check “Read from file”

  3. Point it to a local .txt file

  4. Use a script or automation tool (e.g. Touch Portal, NodeCG, Stream Deck plugin) that pulls the data from the feed and writes specific values (like score or timer) into that text file on a loop.

Use your overlay design to decide what fields to show: team names, scores, clock, etc.

Using in vMix (via Data Source Input)

  1. In vMix, go to Add Input > Data Source

  2. Choose CSV or JSON, depending on your feed format

  3. Paste the feed URL (e.g. https://api.ultie.org/export/game-on-the-field/spring2025/1/json)

  4. Set the refresh interval (every 1–2 seconds recommended)

  5. Add a Title Input, then link your text fields to the correct data columns — for example, score, team name, or timer.

Quick Mapping Tips

  • Score: homeTeamScore and visitorTeamScore

  • Timer: use timePassedText for time elapsed or remainTimeText for time left

  • Pause status: check isPaused — you may want to freeze or hide the timer

  • Team names: use homeTeamAlias and visitorTeamAlias for short displays, or homeTeamTitle / visitorTeamTitle for full names

Test Data

Need sample data for testing or setting things up? Message us on or — we’ll quickly send you a working link with live examples.

https://api.ultie.org/export/game-on-the-field/{tournament_URL}/{field_number}/{format}
Telegram
WhatsApp