# Live Swiss Tournament Data for vMix

**Endpoint:** `GET /stream-info/swiss-groups/{tournament-name}`

### **Required Parameters**

* `divisionType` - Division type (automatically converted to uppercase)

### **Optional Parameters**

* `divisionNum` - Division number (defaults to 1 if not specified)
* `round` - Show specific round (defaults to latest round)

### **Available Division Types**

* `OPEN` - Open division
* `WOMEN` - Women's division (API handles internal mapping automatically)
* `MIXED` - Mixed division
* `MASTERS` - Masters division

### **Response Format**

Returns an array of team objects, sorted by playoff status (playoff teams first), then by rating (highest first).

### **JSON Fields**

* `position` (number) - Current ranking position (1-based)
* `division` (string) - Division name (e.g., "OPEN #1", "WOMEN #2")
* `teamTitle` (string) - Team name
* `teamCity` (string) - Team's club city
* `teamCountry` (string) - Team's club country
* `clubAvatarUrl` (string) - Team's club logo URL (400px version, empty if no logo)
* `rating` (number | empty string) - Swiss system calculated rating (empty string when no games played yet)
* `hasPlayoff` (boolean) - Whether team has qualified for playoffs

### **Playoff Behavior**

Teams with `hasPlayoff: true` always appear at the top of rankings regardless of rating. This reflects teams that have secured playoff positions in the Swiss system.

### **Pre-Tournament State**

When no games have been played, teams are listed in seed order with `rating: ""` (empty string) and `hasPlayoff: false`.

### **Usage with vMix**

This endpoint delivers JSON data containing team rankings, ratings, and playoff qualifications that can be imported into vMix as a data source for creating dynamic tournament overlays and graphics during live streams.

### **Examples**

* `https://api.ultie.org/stream-info/swiss-groups/windmill2025?divisionType=OPEN` (OPEN #1, latest round)
* `https://api.ultie.org/stream-info/swiss-groups/windmill2025?divisionType=WOMEN&divisionNum=2&round=3` (WOMEN #2, round 3)
* `https://api.ultie.org/stream-info/swiss-groups/windmill2025?divisionType=mixed&divisionNum=1` (MIXED#1, latest round)
* `https://api.ultie.org/stream-info/swiss-groups/windmill2025?divisionType=MIXED&round=2` (MIXED #1, round 2)

{% hint style="info" %}
Division types are case-insensitive and automatically converted to uppercase. Use "WOMEN" (the API handles the internal database mapping automatically).
{% endhint %}

### **Test Data**

Need sample data for **testing or setting things up?**\
Message us on [**Telegram**](https://t.me/ultieorg) or [**WhatsApp**](https://wa.me/447719564497) — we’ll quickly send you a working link with live examples.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ultie.org/live-swiss-tournament-data-for-vmix.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.