Client API
Documentation
API Reference
Definitions
CompetitionStageSettings
Fields
Name
Description
competitionStageId: UUID!
The id of the competition stage.
IErrorDetails
Subtypes:
Base class for mutation error responses.CantLeaveRunningCup ErrorDetails GameAccountNotConnected GameAccountNotLinked InvalidTeamSize NotFound PlayerInOtherTeam
Fields
Name
Description
errorCode: PublicApiErrorCode!
The error that ocurred. See ~/developers/docs/error-codes for details.
errorCodeDescription: String!
Error code description.
message: String!
Detailed error message.
IGameAccount
Represents a game account that a user is using to participate in game activities.
Most competition formats, such as a Tournaments etc, require the user to have a game account added to their profile for the corresponding game title.
Fields
Name
Description
user: UserProfile!
The user that this game account belongs to.
gameTitle: GameTitle!
The game title that this game account is associated with.
id: String!
The ID that identifies this account outside the platform, unique within the game's own ID domain.
Depending on the game title, this ID may often be used in other external APIs or services related to the game title.
ILeaderboardActivityNúcleo
A activity that acts as a contribution to a leaderboard, such as tournaments or individual matches etc.
Fields
Name
Description
type: LeaderboardActivityType!
The type of this activity.
score: Float!
The calculated score associated with this activity.
picked: Boolean!
Whether this activity was picked to be included in the total score in the leaderboard.
ITournamentContext
The tournament context of an entity. For match-specific context, see TournamentMatchContext.
Fields
Name
Description
tournament: Tournament
Reference to the tournament.
LeaderboardParticipantNúcleo
Represents a participant in a leaderboard and contains their score and placement in the leaderboard. A participant can be either a single user or a team; use the ... on syntax to query subtypes.
Fields
Name
Description
allActivities: AllActivitiesConnection
List of all activities related to this participation.
Arguments for allActivities
first: Intafter: Stringlast: Intbefore: StringpickedActivities: [ILeaderboardActivity!]!
List of activities that was picked to contribute to total score and placement in the leaderboard.
leaderboard: Leaderboard!
The leaderboard that this entry belongs to.
placement: Int
The participant's current placement in the leaderboard. 1-indexed, null if they have no placement yet.
displayScore: String!
Formatted string representing the participant's current score in the leaderboard. Suitable for visualizing.
score: Float
The participant's current score in the leaderboard. Null if they have no score yet.
banned: Boolean!
Whether the participant is banned from the leaderboard.
bannedAt: DateTime
If the user is banned in the leaderboard, the time at which they were banned.
playingAsTeam: Boolean!
Whether the participant is a team or a solo user. Note that if a single user is playing representing a persistent team, the their participation is considered as a team participation.
playingSolo: Boolean!
Whether the participant is playing solo.
totalActivitiesCount: Int!
The total number of activities this participant has that are related to this leaderboard.
MatchResults
Represents the results of a match or match series.
Fields
Name
Description
final: Boolean!
Whether the results are final and will propagate within the competition.
draw: Boolean!
Whether the match ended in a draw.
lineupResults: [MatchResult!]!
The results of the each of lineups in the match.
Statistic
A single piece of data that is part of a result. Note that the .. syntax allows you to retrieve subclasses of this type that has relationships to it's corresponding entity.
Fields
Name
Description
name: String!
The name of the statistic. This identifier is unique for each entity type it relates to, e.g a statistic for a lineup.
displayName: String
The display name of the statistic. This is a human readable name for the statistic.
serializedValue: String
The value of the statistic. Use the DataType field for deserialization to most common data types.
dataType: StatisticDataType!
Stream
A Stream which covers a something in an event, such as a Match in a Tournament.
Fields
TournamentStage
Tournaments consist of one or more stages (similar to brackets). Stages are played consecutively.
Fields
Name
Description
lineupCount: Int!
The number of lineups in this stage.
index: Int!
The index of the stage within the tournament. 0-indexed.
format: TournamentBracketFormat!
The format of the stage.
AcceptMatchmakingOfferResponseNúcleo
The result of a user accepting a matchmaking offer.
Fields
Name
Description
success: Boolean!
Whether the user accepted the matchmaking offer successfully.
AddSubscriptionCorrectionCreditResponse
Fields
Name
Description
addSubscriptionCorrectionCreditSuccess: AddSubscriptionCorrectionCreditSuccess
AddSubscriptionCorrectionCreditSuccess
Successfully force added credit to a user's subscription
Fields
Name
Description
ok: Boolean!
AllActivitiesConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [AllActivitiesEdge!]
A list of edges.
nodes: [ILeaderboardActivity!]
A flattened list of the nodes.
AllActivitiesEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: ILeaderboardActivity!
The item at the end of the edge.
Attendance
Provides an overview of participation/attendance in a competition, including details of the lineups involved, the rosters, and the waiting list.
Fields
Name
Description
signups: Signups!
List of lineups that have signed up for the competition.
roster: Roster
List of lineups that are confirmed to participate in the competition. This is null until the competition has started.
lineupCount: Int!
The number of lineups that have signed up for the competition.
confirmedSlotCount: Int
The number of lineups that have confirmed their participation in the competition.
readyLineupCount: Int!
The number of lineups that are ready.
maxLineupCount: Int
The maximum number of lineups that the competition supports. Null if unlimited.
availableSlotCount: Int
The number of remaining available lineup slots before the competition is full. Null if unlimited.
BroadcastEmpresa
A stream Broadcast which covers an event such as a Tournament.
Fields
Name
Description
name: String
The public name of the broadcast.
description: String
The public description of the broadcast.
streams: [Stream!]!
The Streams scheduled for this broadcast.
id: UUID!
The ID of the broadcast.
url: String!
The URL where the broadcast is available.
CancelCupResponseEmpresa
Response from cancelling a cup successfully.
Fields
CantLeaveRunningCupEmpresa
Can't leave a running cup without explicitly confirming action. Use the optional 'confirmLeaveRunningCup' flag, to allow the user or team to forfeit from a running cup.
Fields
CompetitionContext
The context of an entity (e.g match, result, lineup etc) within a competition.
Fields
Name
Description
tournamentContext: ITournamentContext
If the context is within a Tournament, this property will provide the tournament context.
CompetitionLineup
A lineup in a competition.
Fields
Name
Description
The list of members in this lineup.
name: String!
The name of the lineup.
isReady: Boolean!
isConfirmed: Boolean!
CompetitionParticipant
Fields
Name
Description
gameAccountId: String
The ID of the user's game account.
user: UserProfile!
The user profile of this member.
captain: Boolean!
CompetitionRestrictions
Lists restrictions that users must meet to be eligible to participate in the competition.
Fields
Name
Description
restrictions: [CompetitionRestriction!]!
CompetitorStatistic
A statistic which is part of a competitor result.
Fields
Name
Description
competitor: MatchMember!
Get the competitor (match member) that the statistic is for.
name: String!
The name of the statistic. This identifier is unique for each entity type it relates to, e.g a statistic for a lineup.
displayName: String
The display name of the statistic. This is a human readable name for the statistic.
serializedValue: String
The value of the statistic. Use the DataType field for deserialization to most common data types.
dataType: StatisticDataType!
CompetitorStatisticsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [CompetitorStatisticsEdge!]
A list of edges.
nodes: [CompetitorStatistic!]
A flattened list of the nodes.
CompetitorStatisticsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: CompetitorStatistic!
The item at the end of the edge.
ConfirmMatchParticipationResponse
The result of a confirming a tournament match participation.
Fields
Name
Description
success: Boolean!
Whether the user successfully confirmed their participation in the tournament match.
ConfirmTournamentParticipationResponse
The result of a user confirming their participation in a tournament.
Fields
Name
Description
success: Boolean!
Whether the user confirmed their participation in the tournament successfully.
errorCode: PublicApiErrorCode
ConnectedAccount
A connected external account that a user has connected to their account, typically through OAuth.
Fields
Name
Description
provider: ExternalAccountProvider!
The external account provider.
id: String
The external account public account ID.
CreateCupResponseEmpresa
Response from creating a cup successfully.
Fields
CupEmpresa
Cups gather a large number of teams to match them into smaller, pre-configured tournaments with opponents of similar skill.
Fields
Name
Description
id: UUID!
The cup's unique ID.
name: String!
Name of the cup.
description: String!
Description of the cup.
hosts: Hosts!
List of hosts that are hosting the cup.
state: CupState!
The current state of the cup.
schedule: Schedule!
Key timestamps related to the cup, such as when the cup is scheduled to start.
restrictions: CompetitionRestrictions!
List of restrictions users must meet to be eligible to participate in the cup.
links: Links!
Links to external resources related to the cup.
settings: CupSettings!
Settings for the cup.
attendance: Attendance!
Provides an overview of participation in a cup.
idSuffix: String
CupSettingsEmpresa
Settings related to a cup.
Fields
Name
Description
competitionStageSettings: [CompetitionStageSettings!]!
Competition settings for each stage of the cup. Expected length 1.
maxLineupSize: Int
The maximum number of players in each lineup.
minLineupSize: Int
The minimum number of players in each lineup.
minLineupCount: Int
The minimum number of lineups required for the cup to start.
CupTournamentStageSettingsEmpresa
The settings for a tournament stage of a cup. These settings will be used to create one or many tournaments for the cup participants in this stage.
Fields
Name
Description
competitionStageId: UUID!
The ID of the competition stage.
settings: TournamentSettingsGroup!
The settings for the tournament.
template: Tournament!
The tournament template for this stage. This tournament will not contain any teams but will be copied and used to create multiple tournaments.
CupsForGameConnectionEmpresa
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [CupsForGameEdge!]
A list of edges.
nodes: [Cup!]
A flattened list of the nodes.
CupsForGameEdgeEmpresa
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: Cup!
The item at the end of the edge.
DeactivateSubscriptionResponse
Fields
Name
Description
deactivateSubscriptionSuccess: DeactivateSubscriptionSuccess
errors: [DeactivateSubscriptionError!]
DeactivateSubscriptionSuccess
Successfully deactivated a subscription.
Fields
Name
Description
ok: Boolean!
DeclineMatchmakingOfferResponseNúcleo
The result of a user declining a matchmaking offer.
Fields
Name
Description
success: Boolean!
Whether the user declined the matchmaking offer successfully.
EditCupResponseEmpresa
Response from creating a cup successfully.
Fields
Embed
A resource that can be embedded on an external website or application.
Fields
Name
Description
embedUrl: String!
The embed url.
ErrorDetails
Fields
GameAccount
Fields
Name
Description
user: UserProfile!
The user that this game account belongs to.
gameTitle: GameTitle!
The game title that this game account is associated with.
id: String!
The ID that identifies this account outside the platform, unique within the game's own ID domain.
Depending on the game title, this ID may often be used in other external APIs or services related to the game title.
GameAccountNotConnected
The player does not have a game account linked in the specified game.
Fields
GameAccountNotLinked
The specific game account could not be associated with any user.
Fields
Name
Description
gameAccountId: String!
The external game account ID which is not associated with any user.
errorCode: PublicApiErrorCode!
errorCodeDescription: String!
message: String!
GameAccountsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [GameAccountsEdge!]
A list of edges.
nodes: [IGameAccount!]
A flattened list of the nodes.
totalCount: Int!
Identifies the total count of items in the connection.
GameAccountsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: IGameAccount!
The item at the end of the edge.
GameSession
Represents the in-game game session that is associated with an activity (e.g a match).
Fields
Name
Description
match: Match!
The match that corresponds to this game session.
statistics: GameSessionStatisticsCollection!
Statistics relating to the game session, such as results that scoring is based upon.
lobbyInformation: LobbyInformation!
Information about the game session lobby.
GameSessionStatistic
A statistic which is part of a global result of a game session.
Fields
Name
Description
gameSession: GameSession!
Get the game session that the statistic is for.
name: String!
The name of the statistic. This identifier is unique for each entity type it relates to, e.g a statistic for a lineup.
displayName: String
The display name of the statistic. This is a human readable name for the statistic.
serializedValue: String
The value of the statistic. Use the DataType field for deserialization to most common data types.
dataType: StatisticDataType!
GameSessionStatisticsCollection
Statistics of a game session. This includes all the results of the game session, including team and competitor results. This is includes the base data that is was to calculate the scoring and match results.
Fields
Name
Description
match: Match!
Get the match that the game session statistics are for.
gameSession: GameSession!
Get the in-game game session that the statistics are for.
globalStatistics: GlobalStatisticsConnection
Statistics relating to the game session global results.
Arguments for globalStatistics
first: Intafter: Stringlast: Intbefore: StringlineupStatistics: LineupStatisticsConnection
Get the statistics items relating to the game session lineup results.
Arguments for lineupStatistics
first: Intafter: Stringlast: Intbefore: StringcompetitorStatistics: CompetitorStatisticsConnection
Get the statistics items relating to the game session competitor results.
Arguments for competitorStatistics
first: Intafter: Stringlast: Intbefore: StringGameSessionTag
The game session tag describes information about how to find a a game session, including it's in-game game session ID.
Fields
Name
Description
gameSessionId: String
The in-game game session ID. This is determined by the game and is unique per game session.
lobbyName: String
The name of the lobby that the game session is in. This may be null for some game titles.
GameSpecificSettings
Game specific settings that will be used in the tournament. These settings are unique for each game title and emitted as json.
Note that this may in some cases vary throughout the tournament.
Fields
Name
Description
value: String!
JSON stored as an escaped string value holding game-title specific game settings.
jsonValue: JsonString!
JSON formatted value holding game-title specific game settings.
GameTitle
A game title.
Fields
Name
Description
id: UUID!
The ID of the game title. This ID is persistent and suitable for programmatic applications.
Tip: to find the ID of a game, enable developer mode on the platform.
slug: String!
The slug of the game title. This identifier might change, so prefer using the ID for programmatic use cases.
title: String!
The public name of the space.
GlobalStatisticsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [GlobalStatisticsEdge!]
A list of edges.
nodes: [GameSessionStatistic!]
A flattened list of the nodes.
GlobalStatisticsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: GameSessionStatistic!
The item at the end of the edge.
Hosts
List of hosts of a competition.
Fields
Name
Description
spaces: [Space!]!
List of space hosts.
Image
An image resource.
Fields
Name
Description
url: String!
The url where the image is hosted.
width: Int!
The image width.
height: Int!
The image height.
InvalidTeamSize
The number of team members is invalid for this competition.
Fields
Name
Description
teamSize: Int
The team size used.
minSize: Int
The minimum team size.
maxSize: Int
The maximum team size.
errorCode: PublicApiErrorCode!
errorCodeDescription: String!
message: String!
JoinCupResponseEmpresa
The response of the join cup mutation, indicating whether the player successfully joined and now has a participation in the cup.
Fields
Name
Description
participation: OwnCupParticipation
The user's own participation in a cup.
errors: [JoinCupError!]
JoinLadderResponse
The result of a joining a ladder.
Fields
Name
Description
success: Boolean!
Whether the user signed up to the ladder successfully.
JoinLeaderboardResponseNúcleo
Fields
JoinLeaderboardSuccessNúcleo
The result of trying to join a leaderboard.
Fields
Name
Description
leaderboard: Leaderboard!
The leaderboard that was successfully joined.
JoinMatchmakingQueueResponseNúcleo
The result of a user joining a matchmaking queue.
Fields
Name
Description
success: Boolean
Whether the user joined the matchmaking queue successfully.
dateJoined: DateTime
If successful, the timestamp when the user joined the matchmaking queue.
errors: [JoinMatchmakingQueueError!]
Ladder
A ladder is a competition that ranks players based on their best performances over a set period of time.
Fields
Name
Description
placements: [LadderPlacement!]!
The current placement entries in the ladder.
placementsPage: PlacementsPageConnection
The current placement entries in the ladder.
Arguments for placementsPage
after: Stringfirst: Intname: String!
The name of the ladder.
description: String!
Description of the ladder.
state: LadderState!
The current state of the ladder.
startDate: DateTime!
The time when the ladder starts.
endDate: DateTime!
The time when the ladder ends.
matchCount: Int!
How many matches count towards a user's position in the ladder.
LadderMatch
A match that the player participated in, that is associated with a specific Ladder. The results of the match may count towards their placement in the ladder.
Fields
Name
Description
score: Float!
The score of the match.
includedInScoring: Boolean!
Whether the match counts towards the placement in the ladder. If this is false, player likely played other games with higher scores that are included in their placement.
LadderPlacement
A users placement in a ladder.
Fields
Name
Description
gameAccountId: String!
The in-game game account id of the corresponding user.
Since this is game-title specific the format might vary.
The list of matches that counts towards this placement.
Arguments for matches
includeNonContributing: Boolean!matchesPage: MatchesPageConnection
The list of matches that counts towards this placement.
Arguments for matchesPage
after: Stringfirst: IntincludeNonContributing: Boolean!placement: Int!
The 1-indexed placement in the ladder.
score: Float!
The score of this placement, accumulated from the matches that counts towards the placement.
user: UserProfile!
The user profile of this placement.
LeaderboardNúcleo
A leaderboard is an asynchronous competition format that ranks players based on their best performances over a set period of time.
Fields
Name
Description
participants: ParticipantsConnection
All participants and their entries in the leaderboard.
Arguments for participants
first: Intafter: Stringlast: Intbefore: Stringid: UUID!
The ID of the leaderboard.
name: String!
The name of the leaderboard.
description: String!
Description of the leaderboard.
state: LeaderboardState!
The current state of the leaderboard.
startDate: DateTime!
The time when the leaderboard starts.
endDate: DateTime!
The time when the leaderboard ends.
settings: LeaderboardSettings!
The settings for this leaderboard, including scoring settings and restrictions.
totalParticipantCount: Int!
Total number of competitors participating in the leaderboard.
LeaderboardActivityNúcleo
A activity that acts as a contribution to a leaderboard.
Fields
Name
Description
type: LeaderboardActivityType!
score: Float!
The calculated score associated with this activity.
picked: Boolean!
Whether this activity was picked to be included in the total score in the leaderboard.
LeaderboardSettingsNúcleo
Settings for a leaderboard, such as scoring rules etc.
Fields
Name
Description
restrictions: CompetitionRestrictions
Restrictions that users must meet to be eligible to participate in the leaderboard.
minContributions: Int!
The minimum number of scoring contributions (e.g games) required to be placed in the leaderboard.
maxContributions: Int!
The maximum number of scoring contributions (e.g games) that will be counted towards your final leaderboard placement.
LeaderboardTeamNúcleo
A team participating in a leaderboard.
Fields
Name
Description
allActivities: AllActivitiesConnection
List of all activities related to this participation.
Arguments for allActivities
first: Intafter: Stringlast: Intbefore: StringpickedActivities: [ILeaderboardActivity!]!
List of activities that was picked to contribute to total score and placement in the leaderboard.
leaderboard: Leaderboard!
The leaderboard that this entry belongs to.
playingAsTeam: Boolean!
playingSolo: Boolean!
members: [UserProfile!]!
The team members' user profiles.
placement: Int
The participant's current placement in the leaderboard. 1-indexed, null if they have no placement yet.
displayScore: String!
Formatted string representing the participant's current score in the leaderboard. Suitable for visualizing.
score: Float
The participant's current score in the leaderboard. Null if they have no score yet.
banned: Boolean!
Whether the participant is banned from the leaderboard.
bannedAt: DateTime
If the user is banned in the leaderboard, the time at which they were banned.
totalActivitiesCount: Int!
The total number of activities this participant has that are related to this leaderboard.
LeaderboardTournamentActivityNúcleo
A contribution from participating in a tournament.
Fields
Name
Description
tournament: Tournament!
The tournament this contribution comes from.
lineup: TournamentLineup!
The lineup that played for this contribution.
type: LeaderboardActivityType!
score: Float!
The calculated score associated with this activity.
picked: Boolean!
Whether this activity was picked to be included in the total score in the leaderboard.
LeaderboardUserNúcleo
A solo user who is participating in the leaderboard.
Fields
Name
Description
allActivities: AllActivitiesConnection
List of all activities related to this participation.
Arguments for allActivities
first: Intafter: Stringlast: Intbefore: StringpickedActivities: [ILeaderboardActivity!]!
List of activities that was picked to contribute to total score and placement in the leaderboard.
leaderboard: Leaderboard!
The leaderboard that this entry belongs to.
playingAsTeam: Boolean!
playingSolo: Boolean!
user: UserProfile!
The user's profile.
placement: Int
The participant's current placement in the leaderboard. 1-indexed, null if they have no placement yet.
displayScore: String!
Formatted string representing the participant's current score in the leaderboard. Suitable for visualizing.
score: Float
The participant's current score in the leaderboard. Null if they have no score yet.
banned: Boolean!
Whether the participant is banned from the leaderboard.
bannedAt: DateTime
If the user is banned in the leaderboard, the time at which they were banned.
totalActivitiesCount: Int!
The total number of activities this participant has that are related to this leaderboard.
LeaderboardsConnectionNúcleo
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [LeaderboardsEdge!]
A list of edges.
A flattened list of the nodes.
totalCount: Int!
Identifies the total count of items in the connection.
LeaderboardsEdgeNúcleo
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
The item at the end of the edge.
LeaveCupResponseEmpresa
Fields
LeaveLadderResponse
The result of a user leaving a ladder.
Fields
Name
Description
success: Boolean!
Whether the user successfully left the ladder.
LeaveLeaderboardResponseNúcleo
Fields
LeaveLeaderboardSuccessNúcleo
Leaderboard leave action success response.
Fields
Name
Description
leaderboard: Leaderboard!
The leaderboard that was left.
LeaveMatchmakingQueueResponseNúcleo
The result of a user leaving a matchmaking queue.
Fields
Name
Description
success: Boolean!
Whether the user successfully left the matchmaking queue.
LeaveTournamentResponse
The result of a user leaving a tournament.
Fields
Name
Description
success: Boolean!
Whether the user successfully left the tournament.
LineupStatistic
A statistic which is part of a lineup result.
Fields
Name
Description
lineup: MatchLineup!
Get the match lineup that the statistic is for.
name: String!
The name of the statistic. This identifier is unique for each entity type it relates to, e.g a statistic for a lineup.
displayName: String
The display name of the statistic. This is a human readable name for the statistic.
serializedValue: String
The value of the statistic. Use the DataType field for deserialization to most common data types.
dataType: StatisticDataType!
LineupStatisticsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [LineupStatisticsEdge!]
A list of edges.
nodes: [LineupStatistic!]
A flattened list of the nodes.
LineupStatisticsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: LineupStatistic!
The item at the end of the edge.
LineupsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [LineupsEdge!]
A list of edges.
nodes: [CompetitionLineup!]
A flattened list of the nodes.
totalCount: Int!
Identifies the total count of items in the connection.
LineupsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: CompetitionLineup!
The item at the end of the edge.
Links
List of resources related to a competition, such as links to an overview page or image resources.
Fields
Name
Description
banner: Image
Competition banner image.
Arguments for banner
size: BannerSize! (default MEDIUM)thumbnail: Image
Competition thumbnail image.
Arguments for thumbnail
size: ThumbnailSize! (default MEDIUM)overviewUrl: String!
Link to the competition's overview page.
LobbyInformation
The game session tag describes information about how to find a a game session, including it's in-game game session ID.
Fields
Name
Description
gameSessionId: String
The in-game game session ID. This is determined by the game and is unique per game session.
lobbyName: String
The name of the lobby that the game session is in. This may be null for some game titles.
LolGameAccount
Represents a League of Legends game account that a user is using to participate in LoL competition activities.
Fields
Name
Description
user: UserProfile!
The user that this game account belongs to.
gameTitle: GameTitle!
The game title that this game account is associated with.
realm: LolGameRealm!
The League of Legends game realm this summoner is for.
id: String!
The ID that identifies this account outside the platform, unique within the game's own ID domain.
Depending on the game title, this ID may often be used in other external APIs or services related to the game title.
Match
A match, either standalone or part of a larger competition format such as a tournament.
Fields
Name
Description
lineups: [MatchLineup!]!
The list of lineups in the match.
results: MatchResults!
The results of the match.
tournamentContext: TournamentMatchContext
The tournament context of the match, if the match is part of a tournament.
id: UUID!
The unique identifier of the match.
state: MatchState!
The current state of the match.
name: String!
The public name of the match.
maximumLobbyMinutes: Int!
Numbers of minutes the players have to go to the match lobby after the match starts.
If set to 0 the match will start without players going to the match screen.
maximumGoToGameMinutes: Int!
If not set to 0, players must join the in-game lobby during this period to avoid losing on walkover.
gameSessionTag: GameSessionTag!
Information about how to find a a game session, including it's in-game game session ID.
gameSession: GameSession!
The in-game game session corresponding to this match.
statistics: MatchStatisticsCollection!
Statistics for this match, including game session statistics.
context: CompetitionContext!
The competition context of the match.
MatchLineup
A lineup is one or many players playing together in this match.
Fields
Name
Description
members: [MatchMember!]!
The members in this match lineup.
statistics: StatisticsConnection
Get statistics corresponding to this lineup.
Arguments for statistics
first: Intafter: Stringlast: Intbefore: Stringnumber: Int!
The lineup number, 0-indexed.
missedReadyCheck: Boolean!
Whether the lineup missed the ready check.
lineupName: String!
The lineup name.
position: Int
If determined, the resulting position of the lineup in the match.
score: Int
If determined, the resulting score of the lineup in the match.
MatchMember
A member of a match lineup.
Fields
Name
Description
gameAccountId: String!
The in-game game account id of the member.
Since this is game-title specific the format might vary.
statistics: StatisticsConnection
Get statistics corresponding to this lineup.
Arguments for statistics
first: Intafter: Stringlast: Intbefore: Stringcontext: CompetitionContext!
The competition context for the memeber, e.g the match and their lineup etc.
user: UserProfile!
The user profile of this member.
confirmedParticipation: Boolean!
Whether the user has confirmed their participation in the match.
MatchResult
Represents match results, such as score and position, associated with a user or lineup within a competition.
Fields
Name
Description
final: Boolean!
Whether the score is final, propagating the competition.
score: Int
The score value.
position: Int
If determined, the resulting position of the lineup in the match. 1 corresponds to first place.
lineupNumber: Int!
The lineup number that the result belongs to. A user is always assigned a team number, even if they are playing solo.
See TournamentMatchContext for additional info. 0-indexed.
context: CompetitionContext!
The competition context of the result, e.g the match, which team it belongs to etc.
MatchSeries
A series of matches between the same lineups or players, typically describing when a competition has a best-of-N setup. If a match is cancelled, a match series can be extended with additional matches.
Fields
Name
Description
matches: [Match!]!
Ordered list of matches in this match series.
Arguments for matches
includeFailed: Boolean!gameSettings: GameSpecificSettings
Specific game settings used for this match series. This can differ from the default game settings configured on the tournament.
gameSessionSettings: JSON
Specific game settings used for this match series. This can differ from the default game settings configured on the tournament.
The tournament that this match series is a part of.
context: CompetitionContext!
The competition context of the match series.
lineups: [TournamentLineup]!
List of lineups in the match series.
results: MatchResults!
The results of the match series.
title: String!
labels: [TournamentNodeLabel!]!
streams: [Stream!]!
The streams covering this series.
id: UUID!
ordinal: Int!
The ordinal number of the match series in the tournament.
state: MatchSeriesState!
The current state of the match series.
lineupCount: Int!
The number of lineups in each match of the match series.
startedAt: DateTime
The time when the match series started. Null if the match series has not started yet.
bestOf: Int!
The best-of setting used for this match series. For example, "best of 3" means that the first team to win 2 matches wins the match series.
scheduledStartTimeAt: DateTime
The scheduled start time of the first match of the series. May be null.
MatchSeriesPageConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [MatchSeriesPageEdge!]
A list of edges.
nodes: [MatchSeries!]
A flattened list of the nodes.
MatchSeriesPageEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: MatchSeries!
The item at the end of the edge.
MatchSeriesStream
A Stream which covers a MatchSeries in a Tournament.
Fields
Name
Description
matchSeries: MatchSeries!
broadcast: Broadcast!
The broadcast that this stream is a part of.
type: StreamType!
MatchStatisticsCollection
Statistics of a match, including the statistics of it's corresponding in-game session.
Fields
Name
Description
match: Match!
Get the match that the game session statistics are for.
gameSessionStatistics: GameSessionStatisticsCollection!
Statistics for the corresponding in-game session.
MatchesPageConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [MatchesPageEdge!]
A list of edges.
nodes: [LadderMatch!]
A flattened list of the nodes.
MatchesPageEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: LadderMatch!
The item at the end of the edge.
MatchmakingOfferNúcleo
An offer for an available match or tournament, resulting from a matching in a matchmaking queue.
The user should be prompted to either accept or decline the offer. If enough players accept, the offer then points to the competition (e.g tournament) that is created as a result.
Fields
Name
Description
tournament: Tournament
The tournament that can be created when the offer is accepted by all.
match: Match
The match that can be created when the offer is accepted by all.
responseDeadlineAt: DateTime!
The offer needs to be accepted by.
state: MatchmakingOfferState!
The state of this offer, when this is Open the offer needs to be accepted.
acceptedParticipantCount: Int!
The number of people that has accepted this offer.
participantCount: Int!
Total number of people that needs to accept the offer.
MatchmakingQueueNúcleo
A match or tournament matchmaking queue.
Fields
Name
Description
settings: MatchmakingSettings!
The settings of the matchmaking queue, configurable by the organizer.
The current users participation in the queue. This can be used to render a personal view of the queue.
id: UUID!
The matchmaking queue unique identifier.
name: String!
The public name of the queue.
description: String
Description of the queue.
open: Boolean!
Whether the queue is open for users to join.
waitingCount: Int!
Number of users currently in waiting the queue.
queueType: MatchmakingQueueType!
The type of competitions that the matchmaking queue produces once players are matched together.
idSuffix: String
MatchmakingSettingsNúcleo
Various settings related to matchmaking queue, including the game settings.
Fields
Name
Description
getTournamentQueueSettings: TournamentSettingsGroup
In the case of tournament matchmaking queues, the default settings of the resulting tournaments.
matchQueueSettings: String
gameSessionSettings: JSON
MatchmakingSummaryNúcleo
A summary of a user's current matchmaking activity. Can be used to find if the user is currently active in a matchmaking queue or has any active matchmaking offers.
Fields
Name
Description
joinedQueue: MatchmakingQueue
Return the matchmaking queue the user is either queueing or participating in a competition as a result of matchmaking. If the user is not part of any matchmaking activity, this will be null.
Lists all active matchmaking offers for the user. Only active offers, that are not concluded or failed, are not included.
idSuffix: String
Me
Contains information relating to the current user.
Fields
Name
Description
matchmaking: MatchmakingSummary
Get info about matchmaking queues user is part of
Arguments for matchmaking
filter: OwnMatchmakingFilterInputownTournaments: [Tournament!]!
Get tournaments which the current user is part of.
Arguments for ownTournaments
filter: OwnTournamentsInputownTournamentParticipations: [OwnTournamentParticipation!]!
Get get tournament participations for current tournaments.
Arguments for ownTournamentParticipations
filter: OwnTournamentsInputtournaments: TournamentsConnection
Get get tournament participations for current tournaments.
leaderboards: LeaderboardsConnection
Get user's own leaderboard participations.
Arguments for leaderboards
first: Intafter: Stringlast: Intbefore: StringownLadders: [Ladder!]!
Get Ladders which the current user is part of.
Arguments for ownLadders
filter: OwnLaddersInputownCupParticipation: [OwnCupParticipation!]!
Get participation in cups which the current user is part of.
currentCups: [OwnCupParticipation!]!
Get cups which the current user is part of.
Search among this user's cups.
user: UserProfile!
The profile of the current user.
MultiTeamMatchResults
The result of a multi-team (N vs N) match.
Fields
Name
Description
final: Boolean!
Whether the results are final and will propagate within the competition.
draw: Boolean!
Whether the match ended in a draw.
lineupResults: [MatchResult!]!
The results of the each of lineups in the match.
NotFound
Resource not found.
Fields
Name
Description
resourceId: String
The ID of the resource.
errorCode: PublicApiErrorCode!
errorCodeDescription: String!
message: String!
OwnCupParticipationEmpresa
The user's own participation in a cup.
Fields
Name
Description
ownTeam: CompetitionLineup
The team the user is participating in the cup with.
currentTournamentParticipation: OwnTournamentParticipation
The user's own participation in the current tournament within the cup, in case one is created. If the cup is not for tournaments, this property will be null.
tournamentParticipation: OwnTournamentParticipation
The user's tournament participation within the cup, if the tournament is created.
Null if the tournament is not created, or the cup is configured to create other competition types.
cup: Cup
The cup that the user is participating in.
eligibility: OwnEligibility
Description of whether the user is eligible to join the competition.
OwnEligibility
A summary of whether a user meets the requirements (restrictions) to participate in a competition.
If a user is not eligible to play, please refer to the documentation of each unmet restriction to determine a course of action. For example, if the user does not have a game account linked, the user must connect and verify their game account.
Fields
Name
Description
metRestrictions: [CompetitionRestriction!]!
List of restrictions that the user has met.
unmetRestrictions: [CompetitionRestriction!]!
List of restrictions that the user has not met. Refer to the documentation of each restriction to determine a course of action. Some restrictions may require redirecting the user to Challengermode to meet them.
eligible: Boolean!
Whether the user is eligible to participate in the competition. If false, see the list of unmet restrictions for details.
idSuffix: String
OwnLeaderboardParticipationNúcleo
Represents a user's own participation in a leaderboard.
Fields
Name
Description
participation: LeaderboardParticipant!
The leaderboard participation (entry) of this user.
leaderboard: Leaderboard!
The leaderboard that the user is participating in.
user: UserProfile!
The user's profile.
OwnMatchmakingQueueParticipationNúcleo
A users participation in a matchmaking queue. This can be used to render a personal view of the queue.
Fields
Name
Description
The users active offers, if any are available.
This can both be used to render when a new offer is available and to find the corresponding competition if one has been created (e.g a tournament).
queueing: Boolean!
Whether the user is currently queueing. Note that receiving an offer sets this to false while awaiting the player's answer. If the offer fails, players that accepted it will automatically queue again.
joinedAt: DateTime
The time the user joined the queue.
OwnTournamentParticipation
A user's own participation in a tournament. This can be used to render personal views of a tournament.
Fields
Name
Description
signedUp: Boolean!
Whether the user has signed up for the tournament.
confirmed: Boolean!
Whether the user has confirmed their participation in the tournament.
To let the user confirm their participation, use confirmTournamentParticipation.
For all available actions, refer to lobbyFeedback.
matchRunning: Boolean!
Whether the user has a tournament match running.
currentMatch: Match
The current match user is playing in, if any.
matchseries: [MatchSeries!]!
The matchseries that your lineup has played in or is currently playing in.
participationComplete: Boolean!
Whether the users participation in the tournament is completed. If this is null, the user has upcoming matches.
waitingForNextMatch: Boolean!
Whether the user is currently waiting for their next match.
lobbyFeedback: TournamentLobbyFeedback!
Personalized feedback for the current user, detailing the available actions that the user can currently perform in the tournament e.g sign up to the tournament or confirm their participation.
gameAccountId: String
The in-game ID of the player which the current user is participating with in the tournament. This is game-title specific so the format may vary.
onWaitingList: Boolean!
Whether the user is currently on the waiting list of the tournament.
placement: TournamentLineupPlacement
If available, the final placement of the user's lineup in this tournament. This is only available if the tournament is completed.
context: CompetitionContext!
The competition context of the user's participation in the tournament.
eligibility: OwnEligibility
Description of whether the user is eligible to join the competition.
tournamentId: UUID!
PageInfo
Information about pagination in a connection.
Fields
Name
Description
hasNextPage: Boolean!
Indicates whether more edges exist following the set defined by the clients arguments.
hasPreviousPage: Boolean!
Indicates whether more edges exist prior the set defined by the clients arguments.
startCursor: String
When paginating backwards, the cursor to continue.
endCursor: String
When paginating forwards, the cursor to continue.
ParticipantsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [ParticipantsEdge!]
A list of edges.
nodes: [LeaderboardParticipant!]
A flattened list of the nodes.
ParticipantsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: LeaderboardParticipant!
The item at the end of the edge.
PlacementsPageConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [PlacementsPageEdge!]
A list of edges.
nodes: [LadderPlacement!]
A flattened list of the nodes.
PlacementsPageEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: LadderPlacement!
The item at the end of the edge.
PlayerInOtherTeam
The player is a member of another team.
Fields
Name
Description
gameAccountId: String!
The external game account ID of the player.
errorCode: PublicApiErrorCode!
errorCodeDescription: String!
message: String!
PreSeedLineupResponse
Response for successfully pre-seeding a lineup in a tournament.
Fields
Name
Description
affectedLineupIds: [UUID!]!
List of lineup IDs that were successfully pre-seeded.
Roster
List of lineups that are going to play or have played in the competition.
Fields
Name
Description
lineups: LineupsConnection
If seeded the teams that are playing will be returned, otherwise the list of teams that are ready to play will be returned.
Arguments for lineups
first: Intafter: Stringlast: Intbefore: StringSchedule
Key timestamps related to the competition, such as registration windows, confirmation windows and scheduled start times.
Fields
Name
Description
scheduledStartTimeAt: DateTime
When the competition is scheduled to start.
scheduledStartTimePassed: Boolean!
Whether the competition scheduled start time has passed.
started: Boolean!
Whether the competition has started.
ended: Boolean!
Whether the competition has ended.
registrationOpensAt: DateTime
When registrations open. If null, the registration start time is considered open ended.
registrationClosesAt: DateTime
When registrations close. If null, the close time is considered open ended.
registrationWindowOpen: Boolean!
Whether the registration window is currently open. Registration refers to the process of signing up i.e registering to a competition.Deternmined by the values of RegistrationOpensAt and RegistrationClosesAt.
confirmationNeeded: Boolean!
Whether the competition requires teams confirm their participation to secure their spot in the competition.
confirmationWindowOpenAt: DateTime
When the confirmation window opens.
confirmationWindowCloseAt: DateTime
When the confirmation window closes.
confirmationWindowOpen: Boolean!
Whether the confirmation window is currently open.Determined by the values of ConfirmationNeeded, ConfirmationWindowOpenAt and ConfirmationWindowCloseAt.
readyWindowOpenAt: DateTime
When the competition allows players to ready up. If null, the start time is considered open-ended and players may ready up at any point until the close time.
readyWindowCloseAt: DateTime
When the competition no longer allows players to ready up. If null, the close time is considered open-ended and players may join at any time after the start time.
readyWindowOpen: Boolean!
Whether the ready-up window is currently open. Determined by the values of ReadyWindowOpenAt and ReadyWindowCloseAt.
startedAt: DateTime
When the competition actually started.
endedAt: DateTime
When the competition ended.
automaticReady: Boolean!
When true, teams will automatically be marked as ready (and checked-in if applicable) when they join the competition.
SetTournamentPreSeedResponse
Fields
SignupTournamentResponse
The result of a user signing up to a tournament.
Fields
Name
Description
success: Boolean!
Whether the user signed up to the tournament successfully.
errorCode: PublicApiErrorCode
Signups
List of all lineups that signed up for the competition.
Fields
Name
Description
lineups: LineupsConnection
The lineups that signed up for this competition.
Arguments for lineups
first: Intafter: Stringlast: Intbefore: StringSpace
A community.
Fields
Name
Description
banner: Image
Space banner image.
Arguments for banner
size: BannerSize! (default MEDIUM)broadcasts: [Broadcast!]!
The list of Broadcasts that are managed through this Space.
id: UUID!
Public ID of the space. This is permanent and suitable for automation purposes, e.g creating a competition hosted within a specific space.
name: String!
The public name of the space.
description: String!
Description of the space.
slug: String!
The slug of the space.
verified: Boolean!
Whether the space is verified.
StartCupResponseEmpresa
Response from starting a cup successfully.
Fields
StatisticsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [StatisticsEdge!]
A list of edges.
nodes: [CompetitorStatistic!]
A flattened list of the nodes.
StatisticsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
node: CompetitorStatistic!
The item at the end of the edge.
Team
A persistent team.
Fields
Name
Description
banner: Image
The team banner image.
Arguments for banner
size: BannerSize! (default MEDIUM)id: UUID!
The ID of the team.
name: String!
The public name of the team.
description: String!
The public description of the team.
verified: Boolean!
Whether the team is verified.
Tournament
Tournaments have players or teams compete directly against each other in a series of matches typically arranged in a bracket format.
Fields
Name
Description
description: String!
A description of the current tournament.
stages: [TournamentStage!]!
The stages of this tournament, played consecutively. This provides the overall structure of the tournament.
Arguments for stages
fromIndex: InttoIndex: IntAll match series that are a part of the tournament.
hosts: Hosts!
List of the Spaces hosting this tournament.
attendance: TournamentAttendance!
Provides an overview of participation in a tournament, including details of the players and teams involved, the roster, and the waiting list.
schedule: TournamentSchedule!
Key timestamps related to the tournament, such as the start time and the opening of the confirmation window.
competitionRestrictions: CompetitionRestrictions!
Lists restrictions that users must meet to be eligible to participate in the competition.
List of restrictions for joining the tournament.
links: TournamentLinks!
Links to external resources related to the tournament.
ownParticipation: OwnTournamentParticipation
The participation status of the current user.
streams: [Stream!]!
The streams covering this tournament.
gameTitle: GameTitle!
Get which game title this tournament is for.
id: UUID!
The tournament's unique ID.
name: String
The name of the tournament.
state: TournamentState!
Current state of the tournament.
contactUrl: String!
The contact address for the organiser.
settings: TournamentSettingsGroup!
Settings for how the current tournament and matches are run.
idSuffix: String
TournamentAttendance
Provides a overview of participation/attendance in a tournament, including details of the players and teams involved, the roster, and the waiting list.
Fields
Name
Description
availableSlotCount: Int!
The number of remaining available lineup slots before tournament is full. For total number of slots, see TournamentSettings
confirmedLineupCount: Int!
The number of confirmed lineups. This is the number of lineups that confirmed their participation.
signups: TournamentSignup!
Lists lineups and users who have signed up to tournament.
roster: TournamentRoster
Lists lineups and users who is confirmed to participate in tournament. This is null before the tournament is started.
waitingList: TournamentWaitingList!
Lists lineups and users who are on the waiting list.
TournamentBracket
A bracket consists of multiple rounds of match series and creates the structure of a tournament.
Fields
Name
Description
title: String!
A descriptive name for the bracket.
labels: [TournamentNodeLabel!]!
A list of labels that describe the bracket.
roundCount: Int!
The number of rounds in the bracket.
rounds: [TournamentRound!]!
The list of rounds in the bracket.
The tournament that the bracket belongs to.
context: CompetitionContext!
The tournament context of the bracket.
stage: TournamentStage
The stage that the bracket belongs to.
TournamentContext
The tournament context of an entity. For match-specific context, see TournamentMatchContext.
Fields
Name
Description
tournament: Tournament
Reference to the tournament.
TournamentEliminationStage
In elimination stages, such as single and double elimination, teams get eliminated from the competition after a set number of losses.
Fields
Name
Description
brackets: [TournamentBracket!]!
The brackets in this stage.
lineupCount: Int!
The number of lineups in this stage.
index: Int!
The index of the stage within the tournament. 0-indexed.
format: TournamentBracketFormat!
The format of the stage.
TournamentFormatSettings
Settings related to the format of the tournament and its stages and brackets.
Fields
Name
Description
bracketFormats: [TournamentBracketFormat!]!
The list of bracket formats the tournament consists of.
description: String!
A descriptive name for the tournament format.
TournamentGroup
A group within a tournament's group stage.
Fields
Name
Description
title: String!
A descriptive name for the group.
state: TournamentGroupState!
The current state of the group.
matchSeries: [MatchSeries!]!
List of all match series in this group.
matchSeriesPage: MatchSeriesPageConnection
Arguments for matchSeriesPage
after: Stringfirst: Intnumber: Int!
The group number. 1-indexed.
lineupCount: Int!
The number of lineups in this group.
encounterCount: Int!
Number of encounters played in this group.
advancingLineupCount: Int!
The number of lineups advancing to the next tournament stage.
TournamentGroupStage
Group stages divide the participants into groups to compete against each other, typically in a round-robin format.
Fields
Name
Description
groupCount: Int!
The number of groups in the group stage.
groups: [TournamentGroup!]!
The groups in the group stage.
lineupCount: Int!
The number of lineups in this stage.
index: Int!
The index of the stage within the tournament. 0-indexed.
format: TournamentBracketFormat!
The format of the stage.
TournamentLineup
A lineup consists of one or many players playing together in a tournament.
Fields
Name
Description
logo: Image
The team logo for this lineup. This will be available primarily if the lineup has a registered Team.
Arguments for logo
size: LogoSize!banner: Image
The team banner image.
Arguments for banner
size: BannerSize! (default MEDIUM)team: Team
Get the persistent team that the lineup is playing as, if any.
All members of this lineup.
placement: TournamentLineupPlacement
The placement in the tournament for this lineup.
If no results are available yet this will be null.
participationStatus: TournamentLineupParticipation!
The participation status of the lineup.
id: UUID!
The ID of the lineup.
name: String!
The name of the tournament lineup. It may be sourced from a Challengermode team or party.
The value returned here is a snapshot, but it is not immutable - it might be adjusted when the name of a team changes globally, or it might not.
disqualified: Boolean!
Denotes if a lineup has been disqualified from the tournament. A disqualified lineup will concede all matches, and disappear from the bracket entirely.
seed: Int
A team's tournament seed is its ranking or placement in the tournament bracket, determined by automatic factors or manual input, to ensure fair and balanced matchups.This number is 0-indexed where lower means better. A team will always have if they are part of the rooster and tournament has started.
preSeed: Int
A manual seed value that can be used during manual seeding to set the teams actual seed.
TournamentLineupMember
A member of a tournament lineup.
Fields
Name
Description
gameAccountId: String!
The in-game game account id of the member.
Since this is game-title specific the format might vary.
lobbyFeedback: TournamentLobbyFeedback!
A summary of member current status and available actions.
captain: Boolean!
Whether the member is captain of the team.
role: String!
The lineup role of the member
confirmedTournamentParticipation: Boolean!
Whether the user has confirmed their participation.
user: UserProfile!
The user profile of this member.
TournamentLineupParticipation
A lineups current participation status in a tournament.
Fields
Name
Description
matchRunning: Boolean!
Whether the lineup has a ongoing match in the tournament.
participationComplete: Boolean!
Whether the lineups participation in the tournament is complete.
waitingForNextMatch: Boolean!
Whether the lineup is waiting for their next match in the tournament.
nextMatchScheduledAt: DateTime
The start time of the next match scheduled for the lineup in the tournament.
TournamentLineupPlacement
Placement for a team in the tournament.
Depending on the resolution of the tournament this is a range. E.g. If the tournament doesn't have bronze medal match, the semifinalist loosers will both have placement 3-4.
Fields
Name
Description
bestPlacement: Int!
The best placement in the placement range.
worstPlacement: Int!
The worst placement in the placement range.
displayPlacement: String!
A display text showing the placement range in which the team performed.
TournamentLinks
List of resources related to a tournament, such as links to the tournament overview page or image resources.
Fields
Name
Description
thumbnail: Image
A thumbnail image.
Arguments for thumbnail
size: ThumbnailSize!banner: Image
Tournament banner image.
Arguments for banner
size: BannerSize! (default MEDIUM)overviewUrl: String!
Link to the tournament overview page.
overviewEmbed: Embed!
An embed for a tournament overview.
matchesOverviewEmbed: Embed!
An embed for vizualising matches.
TournamentLobbyFeedback
Description of lobby feedback for a user in a tournament.
Use this to determine what feedback to show to the user if they view a tournament.
Fields
Name
Description
allowedActions: [AllowedTournamentAction!]!
The current updated list of available actions for the user in the tournament.
feedbackTranslationKey: String!
Translation key that can be used to describe the current state.
timer: DateTime
If the first action has a deadline, this time shows when it will expire.
TournamentMatchContext
The tournament context of a match , such as its position in the tournament.
Fields
Name
Description
stageNumber: Int!
The stage number of this match in the tournament.
roundNumber: Int!
The round number of this match in the tournament.
lineup: MatchLineup
If relevant, the specific lineup in this context.
member: MatchMember
If relevant, the member specific in this context.
tournament: Tournament
Reference to the tournament.
TournamentParticipationUpdate
Description of when a users participation in a tournament is updated.
This data can be used to inform the user that their participation in the tournament is updated, for example when it is time for them to confirm their participation.
Fields
Name
Description
ownParticipation: OwnTournamentParticipation
The updated participation status of the current user.
tournamentId: UUID!
idSuffix: String
TournamentRestrictions
Lists restrictions that are required in order to participate in a tournament.
Fields
Name
Description
restrictions: [TournamentRestriction!]!
TournamentRoster
Lists lineups and members that are confirmed to be playing in tournament.
Fields
Name
Description
userCount: Int!
The number of users participating in the tournament.
lineupCount: Int!
The number of lineups participating in the tournament.
lineups: [TournamentLineup!]!
The lineups participating in the tournament.
Arguments for lineups
limit: IntTournamentRound
A round in a tournament, consisting of a number of match series. Rounds appear in elimination brackets, as well as in round-robin groups and swiss stages.
Fields
Name
Description
roundNumber: Int!
The round number. 0-indexed.
matchCount: Int!
Number of matches in round. May be a placeholder number for format types such as swiss where the number of matches is variable.
List of all match series in this round.
matchSeries: [MatchSeries!]!
List of all match series in this round.
matchSeriesPage: MatchSeriesPageConnection
Gets a page of matchseries for this round.
Arguments for matchSeriesPage
after: Stringfirst: IntlineupCount: Int!
The number of lineups in this round.
advancingLineupCount: Int!
The number of advancing teams in this round.
isLastRound: Boolean!
Whether this is the last round in its stage or bracket.
title: String!
A descriptive name for the bracket.
labels: [TournamentNodeLabel!]!
A list of labels that describe the round.
TournamentSchedule
Fields
Name
Description
scheduledStartTimeAt: DateTime
When the tournament is scheduled to start.
confirmationWindowOpenAt: DateTime
When the tournament confirmation window opens.
earlyConfirmationWindowOpenAt: DateTime
When the tournament confirmation window opens for players who has fast pass.
allowEarlyConfirmation: Boolean!
Shows if the tournament allows for early confirmation when available.
startedAt: DateTime
When the tournament actually started.
endedAt: DateTime
When the tournament concluded.
TournamentSettingsGroup
List of settings related to the tournament.
These settings are configurable by the tournament organizer.
Fields
Name
Description
tournamentSettings: TournamentSpecificSettings!
Settings relating to the tournament itself, such as the number of available slots in the tournament.
Game specific settings that will be used in the tournament. Note that this may in some cases vary throughout the tournament.
gameSessionSettings: JSON
JSON formatted value holding game-title specific game settings.
TournamentSignup
Overview of the players and lineups that have signed up to this tournament.
Fields
Name
Description
userCount: Int!
The number of players that have signed up to this tournament.
lineupCount: Int!
The number of lineups that have signed up to this tournament.
lineups: [TournamentLineup!]!
The lineups that have signed up to this tournament.
Arguments for lineups
limit: Intskip: IntTournamentSpecificSettings
Tournament settings, configurable by the tournament organizer.
Fields
Name
Description
formatSettings: TournamentFormatSettings!
maxLineupCount: Int!
The maximum number of lineups that the tournament supports.
maxLineupSize: Int!
The maximum number of players in each lineup.
format: TournamentFormat!
The tournament bracket format.
TournamentSwissStage
Swiss is a non-elimination format where participants of similar record face each other in a number of rounds.
Fields
Name
Description
roundCount: Int!
The number of rounds in the Swiss stage. Note that this number may be variable.
rounds: [TournamentRound!]!
The created rounds in the Swiss stage. *Note that advancing teams count is not yet supported.
lineupCount: Int!
The number of lineups in this stage.
index: Int!
The index of the stage within the tournament. 0-indexed.
format: TournamentBracketFormat!
The format of the stage.
TournamentWaitingList
Lists the lineups that have signed up but that do not yet have a confirmed spot in the tournament.
Fields
Name
Description
lineupCount: Int!
The number of lineups on the waiting list.
lineups: [TournamentLineup!]!
The list of lineups on the waiting list.
Arguments for lineups
limit: IntTournamentsConnection
A connection to a list of items.
Fields
Name
Description
pageInfo: PageInfo!
Information to aid in pagination.
edges: [TournamentsEdge!]
A list of edges.
A flattened list of the nodes.
totalCount: Int!
Identifies the total count of items in the connection.
TournamentsEdge
An edge in a connection.
Fields
Name
Description
cursor: String!
A cursor for use in pagination.
The item at the end of the edge.
UnmetRestriction
Object representing a competition restriction that a specific user did not meet when trying to perform an action related to a competition.
Fields
Name
Description
userId: UUID!
The user ID that did not meet the restriction.
restriction: CompetitionRestriction!
The restriction that was not met by the user.
UserActiveSubscriptionsByPerkResponse
UserProfile
A user profile.
Fields
Name
Description
bot: Boolean!
Whether this is a BOT user.
createdAt: DateTime!
When the user joined the platform.
biography: String!
The user's own description of themselves.
username: String!
The user's username.
profilePicture: Image
The user's profile picture.
Arguments for profilePicture
size: LogoSize! (default MEDIUM)statistics: UserStatistics
User statistics of their platform activity.
connectedAccounts: [ConnectedAccount!]!
A list of the external accounts that the user has connected to their account. Note that the user may decide to hide specific connected accounts.
gameAccounts: GameAccountsConnection
List of all the game accounts that the user has added to their account and is ready to participate in competitions in.
Arguments for gameAccounts
first: Intafter: Stringlast: Intbefore: Stringbanned: Boolean!
Whether or not the user is banned.
id: UUID!
The user's user ID.
The user's user ID.
profileUrl: String!
The user's profile URL.
UserStatistics
Global statistics about the user's platform activity. This is helpful to infer overall commitment and reliability.
Fields
Name
Description
totalPlayedChallenges: Int!
Total number of competitive matches played. This is helpful to infer overall commitment.
playWinRate: Float!
Ratio of number of played games to number of won games.
placementRate: Float!
Average placement in multi-team games.
playRate: Float!
The ratio of number of games signed up for to number of games played. This is helpful to infer reliability.
VersusMatchResults
A versus (1v1) match result.
Fields
Name
Description
leftSideResult: MatchResult
The result of the left side lineup, corresponding to team number 0.
rightSideResult: MatchResult
The result of the right side lineup, corresponding to team number 1.
final: Boolean!
Whether the results are final and will propagate within the competition.
draw: Boolean!
Whether the match ended in a draw.
lineupResults: [MatchResult!]!
The results of the each of lineups in the match.
AddSubscriptionCorrectionCreditError
CancelCupErrorEmpresa
CreateCupErrorEmpresa
DeactivateSubscriptionError
EditCupErrorEmpresa
JoinCupErrorEmpresa
JoinLeaderboardErrorNúcleo
JoinMatchmakingQueueErrorNúcleo
LeaveCupErrorEmpresa
LeaveLeaderboardErrorNúcleo
SetTournamentPreSeedError
StartCupErrorEmpresa
AcceptMatchmakingOfferInputNúcleo
Fields
Name
Description
queueId: UUID!
AddSubscriptionCorrectionCreditInput
CanPlayInCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to check.
CanPlayInTournamentInput
Fields
Name
Description
tournamentId: UUID!
The ID of the tournament to check.
CancelCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to cancel.
CompletedTournamentSelectorInput
Returns only completed tournaments.
Fields
Name
Description
tournamentsAfter: DateTime!
Returns only tournaments completed after this date.
ConfirmMatchParticipationInput
Fields
Name
Description
matchId: UUID!
ConfirmTournamentParticipationInput
Fields
Name
Description
tournamentId: UUID!
CreateCupInputEmpresa
Fields
Name
Description
name: String!
The public name of the cup. By default minimum length of 3 and maximum length of 100.
description: String
The public description of the cup. By default maximum length of 4000.
externalId: String
An external ID can be used to guarantee idempotency (strongly recommended).
competitionParameters: CupCompetitionParametersInput!
Parameters that define the competitions the cup will generate.
registrationWindowOpenAt: DateTime
When the registration window should open. If not provided, players can register at any time.
scheduledStartTimeAt: DateTime
Time at which the cup should start automatically. Specify in UTC RFC3339 compliant format, e.g 2025-05-05T13:10:20Z.
autoForceReady: Boolean
Teams will automatically be set to ready and checked-in after joining the cup lobby. Caution: this will bypass restriction settings. Defaults to true.
minimumTeamCount: Int
The minimum number of teams required for the cup to start. Defaults to 8.
game: GameIdentifierInput
The game you want to create a cup for. Optional if you are creating the cup from a template.
space: SpaceIdentifierInput
The Space hosting the Cup.
Note that for BOT access, your bot must have admin rights in said space. This is configurable in the application dashboard or in your spaces under 'Roles'.
Optional if you are creating the cup from a template.
CupCompetitionParametersInputEmpresa
Parameters for the competitions that the cup should produce.
Fields
Name
Description
tournamentParameters: CupTournamentParametersInput
Parameterized the cup to create tournaments.
CupStateFilterInputEmpresa
Filter by the current state of a cup.
Fields
Name
Description
states: [CupState!]!
List of spaces to include in filter.
CupTournamentParametersInputEmpresa
Parameters for creating a cup which produces tournaments.
You can use this to create a cup tournament from scratch, or when customizing from a pre-configured template.
Fields
Name
Description
templateId: UUID
Tournament template ID, when creating the cup from an existing template on Challengermode.
Recommended for advanced configuration.
Templates for your cups can be found in your space settings under Tournament Templates -> Cups.
teamSize: Int
The required size of each lineup. Must be compatible with the game.
gameSettings: TournamentGameSettingsInput
Allows you to override or patch game settings for the competition blueprint that will be used in the cup.
CupsForGameInputEmpresa
Fields
Name
Description
gameSlug: String
The slug of the target game title, for example lol.
first: Int
Number of cups to fetch.
after: String
Cursor to start after.
stateFilter: [CupState!]
Filter by the state of the cup. By default Upcoming and Running cups will be searched.
DeactivateSubscriptionInput
Fields
Name
Description
subscriptionId: UUID!
The subscription ID to deactivate.
DeclineMatchmakingOfferInputNúcleo
Fields
Name
Description
queueId: UUID!
EditCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to edit.
The public name of the cup. By default minimum length of 3 and maximum length of 100.
teamSize: OptionalInputOfInt32Input
The team size that should be used.
description: OptionalInputOfStringInput
The public description of the cup. By default maximum length of 4000.
registrationWindowOpenAt: OptionalInputOfNullableOfDateTimeInput
The time at which registrations open.
scheduledStartTimeAt: OptionalInputOfNullableOfDateTimeInput
The time at which the cup should start automatically.
GameIdentifierInput
Unique identifier for a game title.
GameSettingFilterInput
Filter by json values set as in-game settings.
Fields
Name
Description
path: String!
Path to the setting in the json structure.
value: String!
Value to filter by.
GameTitleFilterInput
Filter by game title.
Fields
Name
Description
gameTitles: [GameIdentifierInput!]!
List of game titles to filter by.
JoinCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to join.
gameAccountIds: [String!]
The game account IDs of the players to join the cup with.
If provided, the authenticated user's own game account must be included.
If not provided, the user will join solo with their primary game account.
teamName: String
Optional. Team name that the lineup will use throughout the cup.
teamRating: Float
Optional. External numerical rating of the team.
teamBucket: Long
Optional. Place the team in a bucket where it is only matched with teams in the same bucket.
JoinLadderInput
Fields
Name
Description
ladderId: UUID!
JoinLeaderboardInputNúcleo
Fields
Name
Description
leaderboardId: UUID!
The ID of the leaderboard to join
JoinMatchmakingQueueInputNúcleo
Fields
Name
Description
queueId: UUID!
LaddersForGameInput
Search parameters for searching ladders for a specific game title.
Fields
Name
Description
gameSlug: String!
The slug of the target game title, for example lol.
LaddersForSpaceInput
Search parameters for searching tournaments for a specific Space.
Fields
Name
Description
spaceId: UUID!
The ID of the target space.
LeaveCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to leave.
confirmLeaveRunningCup: Boolean!
Optional. If true the user or team will be allowed to forfeit, leaving a running cup.
LeaveLadderInput
Fields
Name
Description
ladderId: UUID!
LeaveLeaderboardInputNúcleo
Fields
Name
Description
leaderboardId: UUID!
The ID of the leaderboard to leave
LeaveMatchmakingQueueInputNúcleo
Fields
Name
Description
queueId: UUID!
LeaveTournamentInput
Fields
Name
Description
tournamentId: UUID!
OpenTournamentSelectorInput
Returns only upcoming and ongoing tournaments.
Fields
Name
Description
excludeRunning: Boolean
Returns only upcoming tournaments that haven't started yet.
OptionalInputOfInt32Input
Represents an input field that is optional, utilized to be ablet to explicitly set nullable values.
Fields
Name
Description
value: Int!
The value of the field.
OptionalInputOfNullableOfDateTimeInput
Represents an input field that is optional, utilized to be ablet to explicitly set nullable values.
Fields
Name
Description
value: DateTime
The value of the field.
OptionalInputOfStringInput
Represents an input field that is optional, utilized to be ablet to explicitly set nullable values.
Fields
Name
Description
value: String!
The value of the field.
OwnLaddersInput
Filter own ladders to limit the results returned.
Fields
Name
Description
onlyOngoing: Boolean
Filters the ladders to only ongoing or completed. Omit filter for both.
gameSlugs: [String!]
Filters the ladders to only for the specified games.
OwnMatchmakingFilterInputNúcleo
Filter parameters when fetching own matchmaking games for the current user.
Fields
Name
Description
gameSlug: String!
Filter by game title slug
OwnTournamentsInput
Filter own tournaments to limit the results returned.
Fields
Name
Description
onlyOngoing: Boolean
Filters the tournaments to only ongoing or completed. Omit filter for both
tournamentsAfter: DateTime
Filter tournament that ended after specific date (or started in case on ongoing).
tournamentIds: [UUID!]
Filter to only specified tournaments.
gameSlugs: [String!]
Filter to only specified game titles.
PreSeedInput
The pre-seed data for a team in a tournament.
Fields
Name
Description
lineupId: UUID!
The lineup ID of the team to pre-seed.
seed: Int
The seed value for the team. This can be used later with manual seeding when the actual seeds are assigned.
SearchCupsFiltersInputEmpresa
List of available filters for searching for cups for a specific user.
Fields
Name
Description
stateFilter: CupStateFilterInput
Filter by cup state.
startedAtFilter: StartedAtFilterInput
Filter by when the cup started.
gameTitleFilter: GameTitleFilterInput
Filter by game title.
spaceFilter: SpaceFilterInput
Filter by space host.
userFilter: UserFilterInput
Filter by participating users.
SearchOwnCupsFiltersInputEmpresa
List of available filters for searching for cups for a specific user.
Fields
Name
Description
stateFilter: CupStateFilterInput
Filter by cup state.
startedAtFilter: StartedAtFilterInput
Filter by when the cup started.
gameTitleFilter: GameTitleFilterInput
Filter by game title.
spaceFilter: SpaceFilterInput
Filter by space host.
SetTournamentPreSeedInput
Fields
Name
Description
preSeeds: [PreSeedInput!]!
The pre-seed for lineups in the tournament.
SignupTournamentInput
Parameters for letting a user sign up for a tournament.
After they have signed up to the tournament, the user still needs to confirm their participation when the tournament confirmation window opens. Refer to lobbyFeedback to see whether the user can confirm their participation.
SpaceFilterInput
Filter by Space.
Fields
Name
Description
spaces: [SpaceIdentifierInput!]!
List of spaces to include in filter.
SpaceIdentifierInput
Identifier for a space by either ID or slug.
Fields
Name
Description
id: UUID
The ID of the space, as found in settings.
slug: String
The slug of the space, e.g https://challengermode.com/s/{space-slug}.
Prefer using ID if you are building a worker or script for automation.
StartCupInputEmpresa
Fields
Name
Description
cupId: UUID!
The ID of the cup to start.
StartedAtFilterInput
Filter by start date and time.
Allows a maximum of 90 days window.
Note that the default window is 30 days if only one side of the range is provided.
Fields
Name
Description
before: DateTime
Only include cups that started before this date and time.
If 'After' is not provided, 'After' defaults to 30 days before this date.
after: DateTime
Only include cups that started after this date and time.
If 'Before' is not provided, 'Before' defaults to 30 days after this date.
TournamentGameSettingsInput
Input object for overriding settings in a tournament, for example when using a tournament template.
Fields
Name
Description
value: JSON!
The new settings to apply. Must follow the game settings schema defined by the game.
updateMethod: JsonUpdateMethod
How to apply each game setting override, based on the existing value.
locations: [TournamentGameSettingsLocation!]!
Where in the tournament to apply the settings override.
TournamentStateFilterInput
Filters tournament results based on their state.
Fields
Name
Description
openTournamentSelector: OpenTournamentSelectorInput
Returns only upcoming and ongoing tournaments.
completedTournamentSelector: CompletedTournamentSelectorInput
Returns only completed tournaments.
TournamentsForGameInput
Search parameters for searching tournaments for a specific game title.
Fields
Name
Description
gameSlug: String!
The slug of the target game title, for example lol.
tournamentFilter: TournamentStateFilterInput!
Filter parameters for the kind of tournaments to search for.
gameSettingFilters: [GameSettingFilterInput!]
Filter parameters for the game settings of the tournaments.
TournamentsForSpaceInput
Search parameters for searching tournaments for a specific Space.
Fields
Name
Description
spaceId: UUID!
The ID of the target Space.
tournamentFilter: TournamentStateFilterInput!
Filter parameters for the kind of tournaments to search for.
gameSettingFilters: [GameSettingFilterInput!]
Filter parameters for the game settings of the tournaments.
UserFilterByGameAccountIdInput
Filter that allows filtering users by their external Game Account ID.
Fields
Name
Description
gameAccountIds: [String!]!
List of game account IDs to filter by.
UserFilterByIdInput
Filter that allows filtering users by their user ID.
Fields
Name
Description
userIds: [UUID!]!
List of user IDs to filter by.
UserFilterInput
Filter by user.
Fields
Name
Description
userIdFilter: UserFilterByIdInput
Filter by user IDs.
gameAccountIdFilter: UserFilterByGameAccountIdInput
Filter by game account IDs.
AllowedTournamentAction
List of available actions for a user in a tournament.
Enum
Name
Description
NONE
No action is available.
SIGN_UP
The user can sign up to the tournament. To let the user sign up, call signupTournament
CONFIRM
The user should confirm their participation in the tournament. Call confirmTournamentParticipation
CONFIRM_MATCH
The user should confirm their participation in their current match. Call confirmMatchParticipation
LEAVE
The user can leave the tournament. To let the user leave, call leaveTournament
ApplyPolicy
Defines when a policy shall be executed.
Enum
Name
Description
BEFORE_RESOLVER
Before the resolver was executed.
AFTER_RESOLVER
After the resolver was executed.
VALIDATION
The policy is applied in the validation step before the execution.
BannerSize
The size of a thumbnail image
Enum
Name
Description
SMALL
150 * 600
MEDIUM
300 * 1200
LARGE
600 * 2400
CompetitionRestriction
A restriction may prohibit users from participating in a competition.
Enum
Name
Description
OTHER
A restriction not (yet) described in the public API. These should be rare and only apply to specific Spaces. Direct users to the platform to fulfill these.
KYC
Users must fill in KYC (know your customer) information. Direct them to the platform.
VERIFIED_PHONE_NUMBER
Users must verify their phone number. Direct them to the platform.
ENTRY_FEE
The competition has an entry fee which must be paid.
CONNECTION
Users must connect a specific external account (e.g Discord) to their profile. Direct them to the platform.
SUBSCRIPTION
Users must have a specific subscription to the hosting Space. Direct them to the platform.
SURVEY
Users must fill in a survey. Direct them to the platform.
LINKED_GAME_ACCOUNT
Users must have a game account linked. Verify the users account again using one of the available account linking methods in the game integration API.
RANK
Users must be ranked within the range specified by the organizer.
USER_NOT_BANNED
Users must not be banned.
INVITATION
Users must have received and accepted an invitation.
JOIN
Some competitions formats, such as Leaderboards, support users joining implicitly only based on their play activity.
This restriction indicates that users must explicitly join the competition to participate.
CupStateEmpresa
The state of a cup.
Enum
Name
Description
UNKNOWN
UNLISTED
The cup is not listed on the website.
UPCOMING
The cup is scheduled to start in the future.
RUNNING
The cup is currently running.
COMPLETED
The cup is completed.
CANCELED
The cup is canceled.
ExternalAccountProvider
External account provider that users can connect to their account.
Enum
Name
Description
STEAM
Steam account IDs are formatted as SteamId64, see https://developer.valvesoftware.com/wiki/SteamID for details.
DISCORD
TWITCH
KRAFTON
JsonUpdateMethod
Available methods when applying JSON overrides to an existing json value.
Enum
Name
Description
REPLACE
Overrides will completely overwrite, replacing any existing values with the new ones.
MERGE
Overrides will be applied as a merge patch, for details of merge behaviour refer to RFC 7386.
LadderState
The state of a ladder.
Enum
Name
Description
UNKNOWN
NEW
Ladder is created but not yet joinable.
OPEN
Ladder is open and joinable, but not started.
RUNNING
Running and collecting game results.
FINISHED
Finished collecting results and setting the final positions.
CANCELLED
Ladder is cancelled.
LeaderboardActivityTypeNúcleo
The type of activity contributing to a leaderboard.
Enum
Name
Description
UNSPECIFIED
The type of this activity is not specified.
TOURNAMENT
A contribution from participating in a tournament.
LeaderboardStateNúcleo
The state of a leaderboard.
Enum
Name
Description
UNKNOWN
NEW
Leaderboard is created but not yet joinable.
OPEN
Leaderboard is open and joinable, but not started.
RUNNING
Running and collecting game results.
FINISHED
Finished collecting results and setting the final positions.
CANCELLED
Leaderboard is cancelled.
LogoSize
The size of a thumbnail image
Enum
Name
Description
SMALL
32 * 32
MEDIUM
64 * 64
LARGE
128 * 128
EXTRA_LARGE
256 * 256
LolGameRealm
Represents a League of Legends game realm.
Enum
Name
Description
UNKNOWN
Unknown or unspecified League of Legends realm.
BR
Brazilian League of Legends realm.
EUNE
European Nordic & East League of Legends realm.
EUW
European West League of Legends realm.
NA
North American League of Legends realm.
KR
Korean League of Legends realm.
LAN
Latin America North League of Legends realm.
LAS
Latin America South League of Legends realm.
OCE
Oceanian League of Legends realm.
RU
Russian League of Legends realm.
TR
Turkish League of Legends realm.
GLOBAL
Global League of Legends realm, used for cross-region services.
JP
Japanese League of Legends realm.
PBE
Public Beta Environment for League of Legends, used for testing.
PH
Philippine League of Legends realm.
SG
Singaporean League of Legends realm.
TH
Thai League of Legends realm.
TW
Taiwanese League of Legends realm.
VN
Vietnamese League of Legends realm.
ME
Middle East League of Legends realm.
MatchSeriesState
The state of a match series.
Enum
Name
Description
UNKNOWN
WAITING
The match series has been created and some "parameters" (game settings, teams) are known. Playing has not yet begun, either because parameters are missing or because it needs to be started manually.
RUNNING
The match series is currently running and some matches have been created.
PAUSED
The match series is paused. If the match involves several games, there may be some time in between each game (to allow for player substitutions, short breaks etc).
COMPLETED
The match series is completed and the result of this match has been decided.
NULLIFIED
The result of this match was discarded, and "no opponent" was propagated.
MatchState
The state of a match.
Enum
Name
Description
UNKNOWN
LOBBY
The match series is created and is in a lobby state where players are joining.
STARTING
All players have joined and the first match in the match series is starting. In some cases admins may force-start a match series.
RUNNING
The match series is running and one or more matching have been created.
COMPLETED
The match series is completed and results have been propagated.
CANCELLED
The match series was cancelled, either because not enough players joined or because an admin cancelled it.
MatchmakingOfferStateNúcleo
The state of a matchmaking offer. Open, Accepted and Playing are considered active states and will generally include the offer in ongoing active offer listings.
Enum
Name
Description
OPEN
The offer is open and the users need to either accept or decline.
ACCEPTED
The offer has been accepted and a competition is being created.
PLAYING
The corrpesonding competition has been created and the users are playing.
COMPLETED
The offer is completed and the competition has been concluded.
FAILED
The offer has failed and users have been requeued into the matchmaking queue.
MatchmakingQueueTypeNúcleo
The type of competitions that the matchmaking queue produces once players are matched together.
Enum
Name
Description
MATCH
A standard matchmaking queue where the queue produces invidiual matches.
TOURNAMENT
A tournament matchmaking queue where the queue produces tournaments.
See tournamentQueueSettings for tournament specific settings.
PublicApiErrorCode
Enum
Name
Description
UNKNOWN
UNAUTHORIZED
NOT_FOUND
REQUEST_TIMEOUT
INTERNAL_SERVICE_ERROR
MISSING_API_VERSION
INVALID_API_VERSION
INVALID_API_NAME
APP_NOT_APPROVED
INVALID_TIME_ZONE_ID
APP_DEACTIVATED
INVALID_GAME_STATE
TOKEN_EXPIRED
BAD_ARGUMENTS
FEATURE_NOT_ENABLED
REQUIRED_PARAMTER_NULL_OR_EMPTY
VALIDATION_ERROR
GAME_ACCOUNT_ALREADY_LINKED
TOURNAMENT_STATE_DISALLOWS_ACTION
TEAM_SIZE_NOT_CORRECT
ACTION_NOT_ALLOWED
TOURNAMENT_IP_RESTRICTED
TOURNAMENT_REQUIRES_RESERVATION
TOURNAMENT_TIER_RESTRICTED
O_AUTH_UNSUPPORTED_GRANT_TYPE
O_AUTH_TOKEN_EXCHANGE_ERROR
O_AUTH_ASSERTION_MISSING
O_AUTH_CLIENT_NOT_FOUND
O_AUTH_ASSERTION_GRANT_PROVIDER_NOT_AUTHORIZED
O_AUTH_ASSERTION_VALIDATION_FAILED
O_AUTH_USER_CODE_MISSING
O_AUTH_USER_CODE_WRONG
EMAIL_INVALID
EMAIL_CLAIMED
CREATE_USERNAME_FAILED
COUNTRY_INVALID
PLAYER_IN_OTHER_TEAM
COMPETITION_STATE_INVALID
INVALID_TEAM_SIZE
RESTRICTION_NOT_MET
REGISTRATION_CLOSED
TOO_FEW_TEAMS
NO_RUNNING_LADDER
ALREADY_JOINED_LADDER
USER_BANNED
GAME_INTEGRATION_NOT_CONFIGURED
GAME_ACCOUNT_NOT_LINKED
INVALID_GAME_SETTINGS
StatisticDataType
The available data types for statistic items.
Enum
Name
Description
UNKNOWN
The value is of unknown type.
STRING
The value is a string.
INTEGER
The value is a integer.
DOUBLE
The value is a double.
BOOLEAN
The value is a boolean.
DECIMAL
The value is a decimal.
StreamType
Different types of streams target different kinds of entities, such as a stream streaming a MatchSeries in a Tournament.
Enum
Name
Description
UNKNOWN
MATCH_SERIES
ThumbnailSize
The size of a thumbnail image
Enum
Name
Description
SMALL
180 * 320
MEDIUM
360 * 640
LARGE
720 * 1280
TournamentBracketFormat
Format of brackets within a tournament or tournament stage.
Enum
Name
Description
UNKNOWN
Unknown bracket format.
OTHER
Custom bracket format.
SINGLE_ELIMINATION
The most common bracket format. Participants are eliminated after one loss.
DOUBLE_ELIMINATION
Participants are eliminated after losing two matches. Losers in the upper bracket get a 2nd chance in the lower bracket, with the option to work their way back into the grand finals.
SWISS
A non-elimination format where participants compete against opponents with similar records each round.
ROUND_ROBIN
In round-robin, participants play against every other player or team in their group for a specified number of encounters.
TournamentFormat
The format of the tournament and its stages and brackets.
Enum
Name
Description
UNKNOWN
OTHER
Tournament consisting of multiple bracket formats.
SINGLE_ELIMINATION
Tournament with only a single elimination bracket.
DOUBLE_ELIMINATION
Tournament with only a double elimination bracket.
SWISS
Tournament with only a Swiss bracket.
ROUND_ROBIN
Tournament with a round-robin bracket.
TournamentGameSettingsLocation
Available methods when applying game settings to a tournament
Enum
Name
Description
DEFAULT_SETTINGS
The default settings, used for all matches without explicit override of game settings.
MATCH_SERIES_WITH_OVERRIDES
All matches that already have explicit overrides for game settings.
EVERYWHERE
All settings across the whole competition. (DEFAULT_SETTINGS|MATCH_SERIES_WITH_OVERRIDES)
TournamentGroupState
Current state of the tournament group.
Enum
Name
Description
UNKNOWN
WAITING
Playing has not yet begun, either because teams are missing or because it needs to be started manually.
RUNNING
Playing is in progress.
TIED
The group has concluded playing but requires tiebreaking.
COMPLETED
The result of this group has been decided.
TournamentNodeLabel
Labels used to describe tournament nodes, such as brackets, matches, rounds, etc.
Enum
Name
Description
DOUBLE_ELIMINATION_UPPER_BRACKET
The upper bracket of a double elimination stage. Teams that lose in this bracket are sent to the lower bracket.
DOUBLE_ELIMINATION_LOWER_BRACKET
The lower bracket of a double elimination stage.Teams that lose in this bracket are eliminated from the tournament.
DOUBLE_ELIMINATION_FINALS_BRACKET
The grand finals bracket of a double elimination stage.
SINGLE_ELIMINATION_BRACKET
A single elimination bracket.
SWISS_BRACKET
A bracket using a swiss format - a non-elimination format where players compete against opponents with similar records each round.
ROUND_ROBIN_BRACKET
A bracket with round robin format, where each team or player plays against every other team or player in their group for a specified number of encounters.
FINALS_MATCH
The final match of a tournament bracket.
SEMI_FINALS_MATCH
A semi-finals match of a tournament bracket.
BRONZE_MATCH
The bronze match of a tournament bracket.
FINALS_ROUND
The final round of a tournament bracket.
SEMI_FINALS_ROUND
The semi-finals round of a tournament bracket.
QUARTER_FINALS_ROUND
The quarter-finals round of a tournament bracket.
TournamentRestriction
Available restrictions which may prohibit a user from participating in a tournament.
Enum
Name
Description
OTHER
The tournament has another restriction which is not described in the public API. This may be restrictions that only apply to specific Spaces. Direct them to the platform.
KYC
The user must fill in KYC (know your customer) information in order to participate in the tournament. Direct them to the platform.
VERIFIED_PHONE_NUMBER
The user must verify their phone number in order to participate in the tournament. Direct them to the platform.
ENTRY_FEE
The tournament has an entry fee which must be paid in order to participate in the tournament.
CONNECTION
The user must connect a specific external account to their profile. Direct them to the platform.
SUBSCRIPTION
The tournament is only accessible by users with a specific subscription. Direct them to the platform.
SURVEY
The user must fill in a survey in order to participate in the tournament. Direct them to the platform.
TournamentState
The state of a tournament.
Enum
Name
Description
UNKNOWN
UNLISTED
Tournament is created but only visible to organizers.
OPEN
Tournament is listed and users can signup and confirm their participation.
STARTING
Tournament is ready to start.
RUNNING
Tournament is running.
COMPLETED
Results are available and final team placements are known.
CANCELLED
Tournament is cancelled or removed.
authorize
The authorize directive.
Arguments
Name
Description
policy: String
The name of the authorization policy that determines access to the annotated resource.
roles: [String!]
Roles that are allowed to access the annotated resource.
apply: ApplyPolicy! (default BEFORE_RESOLVER)
Defines when when the authorize directive shall be applied.By default the authorize directives are applied during the validation phase.
cost
The purpose of the cost directive is to define a weight for GraphQL types, fields, and arguments. Static analysis can use these weights when calculating the overall cost of a query or response.
Arguments
Name
Description
weight: String!
The weight argument defines what value to add to the overall cost for every appearance, or possible appearance, of a type, field, argument, etc.
listSize
The purpose of the @listSize directive is to either inform the static analysis about the size of returned lists (if that information is statically available), or to point the analysis to where to find that information.
Arguments
Name
Description
assumedSize: Int
The assumedSize argument can be used to statically define the maximum length of a list returned by a field.
slicingArguments: [String!]
The slicingArguments argument can be used to define which of the field's arguments with numeric type are slicing arguments, so that their value determines the size of the list returned by that field. It may specify a list of multiple slicing arguments.
slicingArgumentDefaultValue: Int
The slicingArgumentDefaultValue argument can be used to define a default value for a slicing argument, which is used if the argument is not present in a query.
sizedFields: [String!]
The sizedFields argument can be used to define that the value of the assumedSize argument or of a slicing argument does not affect the size of a list returned by a field itself, but that of a list returned by one of its sub-fields.
requireOneSlicingArgument: Boolean!
The requireOneSlicingArgument argument can be used to inform the static analysis that it should expect that exactly one of the defined slicing arguments is present in a query. If that is not the case (i.e., if none or multiple slicing arguments are present), the static analysis may throw an error.
oneOf
The @oneOf directive is used within the type system definition language
to indicate:
- an Input Object is a Oneof Input Object, or
- an Object Type's Field is a Oneof Field.
specifiedBy
The @specifiedBy directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions.
Arguments
Name
Description
url: String!
The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types.
DateTime
The DateTime scalar represents an ISO-8601 compliant date time type, 2019-12-31T23:59:59.9999999Z.
JSON
JsonString
A scalar type representing a JSON string.
Long
The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.
UUID
The UUID scalar represents a unique identifier and is formatted as 32 digit string guids separated by hyphens 00000000-0000-0000-0000-000000000000.