Challengermode
Home
Dashboard
Game Integration API
Client API
Auth API
Embeds

Client API

Overview

The Challengermode Client API enables you to build your ideal user experience for how to display and interact withChallengermode driven competitions. It reduces the complex structure of advanced competitive formats into simple and easy to understand structures, allowing you to focus on building a good user experience.The API contains a few different components which enables you to build your own Challengermode client that your users interact with.
1

Content Discovery

With Query APIs you can retrieve data from Challengermode and display in your app, letting the user view and browse competitions.For example, using
query
tournamentsForSpace, using either
BOT
or
PAT
authentication, you can retrieve Tournaments and build a Tournament Browser.
2

Personalised Data

Let the user view their own activity and participation in competitions by querying the API on behalf of the user using
PAT
user authentictaion. This will retrieve data which is personal to that user.For example, using the
query
me query you can retrieve a list of the user's OwnTournamentParticipation for all tournaments that the user is part of.
3

User Interaction

Beyond displaying data, Mutation APIs allows users to perform actions such as joining or confirming their participation in a competition.For example, you can let the user sign up to a tournament by using
mutation
signupTournament, which utilizes
PAT
user authentication.
4

Real-time Updates

Use Subscription APIs to retrieve data in real-time, giving your users best possible experience by dynamically updating data as soon as it changes.For example, using
subscription
tournamentParticipationUpdated, you can build the best possible user experience by updating the user's tournament participation in real-time.

How to integrate

There are many ways to combine various APIs to build your ideal user experience for competitive play, and it may vary depending on what format's you wish to offer your users.All API's will use either
PAT
or
BOT
authentication which is described in details in the Auth API.
Note that for a fully white-label experience, you will want to use a non-interactive OAuth flow which allows you to create user's in the background.

Tournaments

Building a tournament experience generally involve the 4 steps outlined in the overview.
1

Tournament Browser

To let your users find tournaments, start by building a Tournament Browser. Use either
query
tournamentsForSpace or
query
tournamentsForGame to retrieve a list of Tournaments.For complex bracket formats, consider using Tournament Embeds.
2

Personalised Data

For a user's own participation in a tournament you can query
query
me to retrieve a list of the user's OwnTournamentParticipation allowing you to show they player's own activity and state in the tournaments, including their final placement.
3

User Interaction

•
Join tournament
When you find a tournament for the user, let them sign up to the tournament using
mutation
signupTournament.
•
Confirm participation
During a tournament, the user is also usually required to confirm their participation in the tournament and individual matchesthroughout the tournament. Look at the list of available actions in their TournamentLobbyFeedback that can be found on their OwnTournamentParticipationto determine when to call
mutation
confirmTournamentParticipation and
mutation
confirmMatchParticipation
Note that you can refer the users to theChallengermodeapp to perform actions too, for example during development.
4

Real-time Updates

For a real-time experience, you can use the subscription variants of the queries described above to get a push everytime anything included in your query is updated.We recommend starting with the
subscription
tournamentParticipationUpdated since this is most impactful for the end user experience. For example, looking at the user's TournamentLobbyFeedback, they can confirm their participation in their next match as soon asCONFIRM_MATCH turns up in their list of allowed actions.

Cups

A cups experience is very similar to a tournament experience, and mainly differs when it comes to discoverability.
1

Cups Browser

Let your users find cups by querying either
query
cupsForSpace or
query
cupsForGame to retrieve a list of Cups.
2

Personalised Data

Since a cup procudes tournaments, you'll only need to find the user's OwnTournamentParticipation, which can be queried through
query
me.
3

User Interaction

•
Join cup
To let a user join a cup, use
mutation
joinCup. Note that here you have the option to join with a whole team through their team leader.
•
Confirm participation
A cup does not require any additional user confirmation.
4

Real-time Updates

For a real-time experience, refer to the section on real-time tournaments!

Tournament Matchmaking

Tournament matchmaking works exactly the same as regular matchmaking queues except that you'll find a Tournament in the Offering from a particular matchmaking Queue, instead of an individual match.From there, the user-experience is the same as a regular tournament integration except that you will not need any tournament browser.
1

Browse matchmaking queues

Just as regular matchmaking, find matchmaking queues using either
query
matchmakingQueuesForGame or a predetermined single queue using
query
matchmakingQueue directly.
2

Personalised Data

Using
PAT
authentication, you can use
query
matchmakingQueue to retrieve a personal OwnMatchmakingQueueParticipation, which in turn will contain Matchmaking Offerings whenever there is a Tournament ready for the user.
3

User Interaction

Joining a Tournament matchmaking queue and accepting/declining offerings works exactly the same as for regular matchmaking.On top of this, refer to building a Tournament integration to see how to let the player interact with the tournament as the tournament is running.
Note however that, when the player accepts their Tournament offering they will already be confirmed as participating in the tournament.
4

Real-time Updates

To make the matchmaking experience real-time, you can use the
subscription
matchmakingQueueUpdated.And, in addition to this, for a real-time tournament experience, refer to the section on real-time tournaments!

Matchmaking

Matchmaking involves finding and joining matchmaking Queues and accepting and finding matches through matchmaking Offerings from those queues.
1

Queue browser

To find matchmaking queues, use
query
matchmakingQueuesForGame or
query
matchmakingQueue directly.
2

Personalised Data

Using
PAT
authentication, you can use
query
matchmakingQueue to retrieve a personal OwnMatchmakingQueueParticipation, which in turn will contain Matchmaking Offerings whenever there is a Match ready for the user.
3

User Interaction

•
Join queue
To let a user join a matchmaking queue, use
mutation
joinMatchmakingQueue
•
Accept offering
When a Matchmaking Offering is available, use
mutation
acceptMatchmakingOffer or
mutation
declineMatchmakingOffer to let the user take action.
4

Real-time Updates

Using
subscription
matchmakingQueueUpdated, you can make the matchmaking experience real-time, which is a very good experience for the end user as you'll get pushes for matchmaking offerings as soon as they are available.

Get started

The most popular use case for this API is to combine it with the Game Integration API to build a complete competitive experience directly within a game. But the possibilities don't end there. Using the Challengermode Client API, you can integrate Challengermode data and functionality into any third-party website or client, be it for the purpose of showing competitions on your own website, to provide a stats website, or to build an esports planner tool.The Challengermode Client API is a GraphQL API. To get started using the API, refer to the section Using the API.
To avoid exceeding rate limits, we recommend fetching and distributing data via a central backend with a caching layer.