Structure API

Overview

The API Structure presents the different entities into sections and describes all the resources and endpoints that can access or manipulate an entity in each section.

Sections

• Stages

  List all stages or a single stage of a tournament.

• Groups

  List all groups or a single group of a tournament.

• Rounds

  List all rounds or a single round of a tournament.

• Brackets

  List the matches including the information needed to display a bracket. This section is only available in stage types that support brackets.

• Ranking items

  List the ranking items of a stage and tournament.

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.

• stage.json
• group.json
• round.json
• bracket.json
• ranking.json
• placement.json

You can also find a list of tools developed for OpenAPI on the OpenAPI tools website.