Tournaments API
Below, you'll find all endpoints needed to fetch all available data about tournaments in a guild.
info
For these endpoints, there is an exception from our API Rules:
You MAY store leaderboard data permanently in your systems as that would be required to build power rankings or similar things, and share it with users of your systems. All other rules remain unchanged.
warning
Note that these endpoints require a separate Authorization scope, so you might have to re-authorize existing guilds.
GET
Get list of tournaments
https://yunite.xyz/api/v3/guild/{guildId}/tournaments- Request
- Response
Path Parameters
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
- Schema
- Example
{
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"id": {
"type": "string/UUIDv4",
"value": "A unique tournament ID"
},
"name": {
"type": "string",
"value": "public name of the tournament"
},
"description": {
"type": "string",
"value": "public description of the tournament"
},
"queueSize": {
"type": "integer",
"value": "how many players per team"
},
"pointSystem": {
"type": "object",
"properties": {
"pointsPerKill": {
"type": "integer",
"value": "amount of points awared per kill"
},
"pointsPerPlacement": {
"type": "object",
"value": "keys: placement, value: points for this placement"
}
}
},
"consensusMin": {
"type": "integer",
"value": "how many player per match to get the match counted"
},
"requireAllMembersOnDiscord": {
"type": "boolean",
"value": "wether or not all players must be on discord and linked"
},
"resetPointsOnTeamChange": {
"type": "boolean",
"value": "wether only points played on the latest team config are counted"
},
"allowFillOnlySessions": {
"type": "boolean",
"value": "wether Yunite should try to count additional sessions that have not been announced to it on game start"
},
"allowRankDuplicates": {
"type": "boolean",
"value": "true if tiebreaking should be disabled"
},
"allowTeamMateSwap": {
"type": "boolean",
"value": "wether the TO allowd mid-tournament team changes"
},
"maxGamesScored": {
"type": "integer",
"value": "max. amount of games that should be counted per team; best matches will be used"
},
"maxGamesPlayable": {
"type": "integer",
"value": "max. amount of games that a team should be allowed to play"
},
"tiebreakers": {
"type": "array",
"itemSchema": {
"type": "string",
"value": "tiebreakers in order they are used; options: WINS, AVERAGE_ELIMINATIONS, SUM_ELIMINATIONS, AVERAGE_PLACEMENT, SCORE_PER_MATCH, SUM_TIME_SURVIVED, AVERAGE_TIME_SURVIVED"
}
},
"startDate": {
"type": "string",
"value": "ISO timestamp of the tournament start"
},
"endDate": {
"type": "string",
"value": "ISO timestamp of the tournament end"
},
"matchTemplate": {
"type": "object",
"properties": {
"type": {
"type": "string",
"value": "selected mode"
},
"region": {
"type": "string",
"value": "selected region as short code"
},
"ruleText": {
"type": "string",
"value": "user defined rules"
},
"leakDetectionEnabled": {
"type": "boolean",
"value": "wether or not leak detection is enabled"
},
"useComplexCode": {
"type": "boolean",
"value": "wether or not a complex custom code will be used"
},
"priorityLevels": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"itemSchema": {
"type": "string",
"value": "ids of roles of this level"
}
},
"timeout": {
"type": "int",
"value": "timeout in seconds"
}
}
}
},
"allowedPlatforms": {
"type": "array",
"itemSchema": {
"type": "string",
"value": "one of ['PC', 'PS4', 'XB1', 'SWITCH', 'MOBILE']. Note: PS4/XB1 may include next gen console players"
}
},
"roleToPing": {
"type": "string?",
"value": "role that will be pinged if sign up phase opened"
},
"resultChannelID": {
"type": "string?",
"value": "channel for matchmaking results"
},
"signUpChannelID": {
"type": "string",
"value": "channel for the sign up message"
},
"leakDetectionChannelID": {
"type": "string?",
"value": "channel for potential leak notifications"
},
"liveTrackingChannelID": {
"type": "string?",
"value": "channel in which Yunite posts the live tracking embed"
},
"maxPlayers": {
"type": "int",
"value": "amount of max players receiving the code (note: not parties or signed up users, we mean overall ingame players)"
}
}
}
}
}
}[
{
"id": "12345-1234-1234-123456",
"name": "My tournament",
"description": "This is an awesome tournament",
"queueSize": 3,
"pointSystem": {
"pointsPerKill": 1,
"pointsPerPlacement": {
"1": 30,
"2": 20,
"3": 10,
"5": 5,
"10": 2
}
},
"requireAllMembersOnDiscord": true,
"resetPointsOnTeamChange": false,
"allowFillOnlySessions": false,
"allowRankDuplicates": false,
"consensusMin": 25,
"allowTeamMateSwap": false,
"maxGamesScored": 6,
"maxGamesPlayable": 10,
"tiebreakers": [
"WINS",
"AVERAGE_ELIMINATIONS",
"AVERAGE_PLACEMENT"
],
"startDate": "2021-02-04T19:00:00Z",
"endDate": "2021-02-04T23:00:00Z",
"matchTemplate": {
"type": "ARENA_SOLO",
"region": "EU",
"ruleText": "Don't W key",
"leakDetectionEnabled": true,
"useComplexCode": true,
"priorityLevels": [
{
"roles": [
"123",
"456"
],
"timeout": 30
}
],
"allowedPlatforms": [
"PC",
"PS4",
"XB1"
],
"roleToPing": "8738320394",
"resultChannelID": "1234567890123",
"signUpChannelID": "1234567890123",
"leakDetectionChannelID": "1234455678765434",
"liveTrackingChannelID": "345678976545678987654",
"maxPlayers": 120
}
}
]GET
Get leaderboard of tournament
https://yunite.xyz/api/v3/guild/{guildId}/tournaments/{tournamentId}/leaderboard- Request
- Response
Path Parameters
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
| tournamentId | UUIDv4 | The ID of the tournament you want to access |
- Schema
- Example
{
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"teamId": {
"type": "UUIDv4",
"value": "ID of the team"
},
"users": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"value": "internal team player index"
},
"discordId": {
"type": "string",
"value": "discord ID of the player, if present, null otherwise"
},
"epicId": {
"type": "string",
"value": "epic ID of the player"
}
}
}
},
"placement": {
"type": "integer",
"value": "the placement of the team"
},
"kills": {
"type": "integer",
"value": "kills of the team"
},
"games": {
"type": "integer",
"value": "amount of games played"
},
"wins": {
"type": "integer",
"value": "amount of wins"
},
"score": {
"type": "integer",
"value": "amount of points"
},
"kpm": {
"type": "double",
"value": "kills per match (avg)"
},
"averagePlacement": {
"type": "double",
"value": "average placement"
},
"gameList": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"placement": {
"type": "integer",
"value": "placement in this single match"
},
"kills": {
"type": "integer",
"value": "kills in this single match"
}
}
}
}
}
}
}[
{
"users": [
{
"discordId": "12345678901234",
"epicId": "abcdef1234567890abcdef"
}
],
"placement": 1,
"kills": 21,
"games": 3,
"wins": 2,
"score": 234,
"kpm": 7,
"averagePlacement": 1.33,
"gameList": [
{
"placement": 1,
"kills": 7
},
{
"placement": 1,
"kills": 7
},
{
"placement": 2,
"kills": 7
}
]
}
]GET
Get list of matches in tournament
https://yunite.xyz/api/v3/guild/{guildId}/tournaments/{tournamentId}/matches- Request
- Response
Path Parameters
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
| tournamentId | UUIDv4 | The ID of the tournament you want to access |
- Schema
- Example
{
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"value": "epic games hex session id of the match"
},
"timestamp": {
"type": "string",
"value": "ISO timestamp of match start"
},
"scoreCount": {
"type": "integer",
"value": "number of replay submissions"
},
"players": {
"type": "integer",
"value": "player count of this match"
},
"ignored": {
"type": "boolean",
"value": "true if the TO decided to ignore this match; it will not count towards the leaderboard"
},
"status": {
"type": "string",
"value": "one of ['NOT_SCORED', 'PARTIALLY_SCORED', 'SCORED']"
}
}
}
}[
{
"sessionId": "1234567890abcdef123456",
"timestamp": "2021-02-04T19:00:00Z",
"scoreCount": 3,
"players": 93,
"ignored": false,
"status": "SCORED"
}
]GET
Get leaderboard of single match
https://yunite.xyz/api/v3/guild/{guildId}/tournaments/{tournamentId}/matches/{sessionId}- Request
- Response
Path Parameters
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
| tournamentId | UUIDv4 | The ID of the tournament you want to access |
| sessionId | string | The ID of the match you want to access |
- Schema
- Example
{
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"team": {
"type": "object",
"properties": {
"id": {
"type": "string",
"value": "internal team id"
},
"players": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"value": "internal team player index"
},
"discordId": {
"type": "string",
"value": "discord id of the player, if present, may be null"
},
"epicId": {
"type": "string",
"value": "epic id of the player"
}
}
}
},
"sessionPlayers": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"discordId": {
"type": "string",
"value": "discord id of one of the players that played this match for this session only, may be null"
},
"epicId": {
"type": "string",
"value": "epic id of one of the players that played this match for this session only"
}
}
}
}
}
},
"placement": {
"type": "integer",
"value": "placement of this team in this match"
},
"kills": {
"type": "integer",
"value": "kills of this team in this match"
},
"score": {
"type": "integer",
"value": "score of this team in this match"
}
}
}
}[
{
"team": {
"id": "12345-1234-1234-1234567",
"players": [
{
"index": 0,
"discordId": "123456678891231",
"epicId": "abcdef1234567890abcdef"
},
{
"index": 1,
"discordId": "123456678891231",
"epicId": "abcdef1234567890abcdef"
}
],
"sessionPlayers": [
{
"discordId": "123456678891231",
"epicId": "1234567890abcdef123456789"
},
{
"discordId": "123456678891231",
"epicId": "1234567890abcdef123456789"
}
]
},
"placement": 1,
"kills": 10,
"score": 234
}
]GET
Get all teams
https://yunite.xyz/api/v3/guild/{guildId}/tournaments/{tournamentId}/teams- Request
- Response
Path Parameters
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
| tournamentId | UUIDv4 | The ID of the tournament you want to access |
- Schema
- Example
{
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"id": {
"type": "UUIDv4",
"value": "ID of the team"
},
"players": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"value": "internal team player index"
},
"discordId": {
"type": "string",
"value": "discord ID of the player, if present, null otherwise"
},
"epicId": {
"type": "string",
"value": "epic ID of the player"
}
}
}
},
"disqualified": {
"type": "boolean",
"value": "wether or not the team has been disqualified"
}
}
}
}[
{
"id": "825cea40-8cbc-4952-b3d5-40db7fb701eb",
"players": [
{
"index": 0,
"discordId": "112345678901234",
"epicId": "abcdef1234567890abcdef"
},
{
"index": 1,
"discordId": "112345678901234",
"epicId": "abcdef1234567890abcdef"
}
],
"disqualified": false
},
{
"id": "d08bf9d2-e7ec-40ad-8390-f56ed4b587e8",
"players": [
{
"index": 0,
"discordId": "112345678901234",
"epicId": "abcdef1234567890abcdef"
},
{
"index": 1,
"discordId": null,
"epicId": "abcdef1234567890abcdef"
}
],
"disqualified": true
}
]POST
Add or update team
https://yunite.xyz/api/v3/guild/{guildId}/tournaments/{tournamentId}/teams- Request
- Response
Path Parameters
Request Body
| Name | Value type | Description |
|---|---|---|
| guildId | Guild ID Snowflake | The ID of the guild you want to access |
| tournamentId | UUIDv4 | The ID of the tournament you want to access |
- Schema
- Example
{
"type": "object",
"properties": {
"id": {
"type": "UUIDv4",
"value": "ID of the team if you want to edit an existing team; omit or 'null' if you want to create a new team",
"optional": true
},
"players": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"discordId": {
"type": "string",
"value": "discord ID of the player (at least one of discordId and epicId required; will be overridden if epicId present)",
"optional": true
},
"epicId": {
"type": "string",
"value": "epic ID of the player (at least one of discordId and epicId required)",
"optional": true
}
}
},
"optional": true
},
"disqualified": {
"type": "boolean",
"value": "wether or not the team has been disqualified; if you want to disqualify a team, change this field (and leave the players array as 'null'); will be ignored on team creation",
"optional": true
}
}
}{
"id": null,
"players": [
{
"epicId": "abcdef1234567890abcdef"
},
{
"discordId": "112345678901234"
}
]
}- Schema
- Example
{
"type": "object",
"properties": {
"id": {
"type": "UUIDv4",
"value": "ID of the team"
},
"players": {
"type": "array",
"itemSchema": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"value": "internal team player index"
},
"discordId": {
"type": "string",
"value": "discord ID of the player, if present, null otherwise"
},
"epicId": {
"type": "string",
"value": "epic ID of the player"
}
}
}
},
"disqualified": {
"type": "boolean",
"value": "wether or not the team has been disqualified"
}
}
}{
"id": "825cea40-8cbc-4952-b3d5-40db7fb701eb",
"players": [
{
"index": 0,
"discordId": "112345678901234",
"epicId": "abcdef1234567890abcdef"
},
{
"index": 1,
"discordId": "112345678901234",
"epicId": "abcdef1234567890abcdef"
}
],
"disqualified": false
}