The Viewer API allows you to view the public information of a tournament. It focuses on reading information and does not create or modify data. You do not need any special permission from the organizer to access public information.
The Viewer API is appropriate if you want to:
- List tournaments from a playlist.
- Provide detailed information about a tournament.
- List the participants of a tournament.
- Provide a tournament schedule.
- Display match results, brackets and rankings.
- Show streams or videos of a match.
The API is divided into several sections. Each section provides the different access points related to a single entity.
List the matches of a stage including the information needed to display a bracket. This section is only available in stage types that support brackets.
- Custom fields
List the custom fields associated with tournament participants.
Access to discipline-related metadata in order to implement tournaments and matches that integrate the specificities of several disciplines. If you only want to implement a single discipline, you should not use this section and directly implement the specificities of the discipline in your application.
List all groups in a stage or tournament, and access the group settings.
List the matches of a tournament and access detailed information about a match. This does not include the match games.
- Match games
List the games of a match and access the detailed information of a match game.
List the participants of a specific tournament, and access detailed player and team information.
Retrieve information from a playlist. To find the tournaments in a playlist, you must use the "tournaments" section.
Retrieve the ranking of one or more stages of a tournament. This section is only available in stage types that support rankings.
List all rounds in a group, stage or tournament, and access the round settings.
List all stages in a tournament and access the stage settings.
List all streams of a tournament.
List tournaments and access public tournament information such as dates, location, rules and registration settings.
OpenAPI 3.0 specification
We also provide you with the OpenAPI 3.0 specification schema of our API. This specification allows us to describe our API with a standard format. Developers can import these files into interactive REST clients (such as Postman or Insomnia) or use these files to generate code and quickly perform calls to our API.
You can find more information on the OpenAPI initiative website.
You can also find a list of tools developed for OpenAPI on the OpenAPI tools website.