Frequently asked questions

Browse through some of our commonly asked questions to ease your integration.


If you have more questions

This is a growing section answering commonly asked REST API questions. If you have any questions that you can't find an answer to on this page, please join our developer slack to get support!

What is the difference between the status field and the complete field at the game level?

The status field shows the current state of a game, e.g., finished. The complete field indicates whether a finished game is ready for data consumption. For matches with detailed statistics (detailed_stats = true), the complete field shows whether the post-game statistics are available for usage. For games that do not have detailed statistics available (detailed_stats = false), the game will be complete once the status is finished. Users can employ the detailed_stats and complete fields at the game level to handle data consumption after a game has finished. Once a finished game is complete ( complete = true), the statistics should not change.

How can I tell whether a match will have post-game statistics?

The boolean detailed_stats field at the match level indicates whether a match should have detailed statistics available. There may be rare circumstances where, due to data issues, a child game of a match will not have detailed statistics available. In these cases, the detailed_stats field at the game level will return false and the detailed_stats field at the match level will remain true. If all games of a match will not have detailed statistics available, the detailed_stats field at the match and game levels will return false.

If you're only interested in matches that will have detailed statistics available, you can make use of filtering to only receive these matches in the API response, e.g.[detailed_stats]=true.
More details of filtering can be found in our documentation, and filtering options can be seen on each reference page.

When will post-game statistics be available?

Results will be available in real-time, and detailed post-game statistics will be available typically within 15 minutes of the game ending.

Where can I find the rosters for a tournament?

You can access tournament rosters via the endpoint /tournaments/{tournament_id_or_slug}/rosters. This endpoint displays the expected rosters for each team participating in the tournament. Further information for this endpoint can be found in our reference documentation.

What is a game advantage?

When a match has a game advantage, the first game of the match is automatically won by the specified opponent. This is due to the tournament format, and it is especially seen in tournaments with a lower bracket. The field game_advantage will contain the id of the corresponding opponent if there is a game advantage in the match, otherwise, the field will remain null.