Brackets | Viewer API | API v2.0 | Toornament Developer

Endpoints

LegacyGET /tournaments/{tournament_id}/stages/{stage_id}/bracket-nodes
Retrieve bracket nodes of a stage and tournament.
LegacyGET /stages/{stage_id}/bracket-nodes
Retrieve bracket nodes of a stage.

LegacyGET /tournaments/{tournament_id}/stages/{stage_id}/bracket-nodes

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

Returns the bracket nodes of a stage. A bracket node represents a match and some extra data.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/stages/{stage_id}/bracket-nodes

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Range
string
A range of requested items using the nodes unit. The size of the range can not exceed 128. (see Pagination)
Example: nodes=0-127

Path parameters

tournament_id
string
The id of the tournament you want to retrieve data about.
stage_id
string
The id of the stage you want to retrieve data about.

Query Parameters

group_ids
array
A list of group ids to filter.
Example: 618943519431786343,618965178941654763
group_numbers
array
A list of group numbers to filter.
Example: 3,4
round_ids
array
A list of round ids to filter.
Example: 618943519431786343,618965178941654763
round_numbers
array
A list of round numbers to filter.
Example: 1,2
min_depth
integer
A minimum depth to filter.
max_depth
integer
A maximal depth to filter.

Request Body

This endpoint does not require a request body.

Response

[206] Bracket nodes retrieved.

Example

[
    {
        "id": "618954615761465416",
        "stage_id": "618983668512789184",
        "group_id": "618985165765456465",
        "round_id": "618965146546456651",
        "number": 2,
        "type": "duel",
        "status": "pending",
        "scheduled_datetime": "2015-12-31T00:00:00+00:00",
        "played_at": "2015-12-31T00:00:00+00:00",
        "depth": 2,
        "branch": "lb",
        "opponents": [
            {
                "number": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "source_type": "winner",
                "source_node_id": "618946514654565656",
                "participant": {
                    "id": "375143143408309123",
                    "name": "Northmen",
                    "custom_fields": {}
                }
            }
        ]
    }
]

Structure (collection)

id
string
The id of the bracket node and the match (they both share the same id).
Example: "618954615761465416"
stage_id
string
The id of the stage that contains this bracket node.
Example: "618983668512789184"
group_id
string
The id of the group that contains this bracket node.
Example: "618985165765456465"
round_id
string
The id of the round that contains this bracket node.
Example: "618965146546456651"
number
integer
The match number (a relative identifier within a round).
Example: 2
type
string
The match type.
Possible values: duel, ffa, bye
status
string
The status of the match.
Possible values: pending, running, completed
scheduled_datetime
string|null
The scheduled date of the match in RFC 3339 (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
played_at
string|null
The timestamp on which the match was played (a result was provided) in RFC 3339 (combined date, time and utc offset).
Format: datetime
Example: "2015-12-31T00:00:00+00:00"
depth
integer
The depth of the node in the bracket.
Example: 2
branch
string|null
The core branch of the node in the bracket.
Possible values: wb, lb, gf
opponents
array[object]
List of match opponents.
- number
  integer
  A relative identifier between 1 and the total number of participants, it is unique and determined by the seeding.
  Example: 1
- result
  string|null
  The game result of the opponent.
  Possible values: win, draw, loss
- rank
  integer|null
  The rank of the participant in the ranking. Multiple participants can share the same rank if they are tied after applying all configured tiebreakers.
  Example: 3
- forfeit
  boolean
  Whether the opponent is forfeit.
  Example: false
- score
  integer|null
  The score of the opponent.
  Example: 15
- source_type
  string
  The type of source of this node item.
  Possible values: none, winner, loser
- source_node_id
  string|null
  The id of the bracket node connected to this opponent.
  Example: "618946514654565656"
- participant
  object|null
  The participant identified with this opponent.
  - id
    string
    The id of the participant.
    Example: "375143143408309123"
  - name
    string
    The name of the participant.
    Max. length: 40 characters
    Example: "Northmen"
  - custom_fields
    object
    The values of the public custom fields configured in the tournament using the machine names as keys. For more information, please read the Custom Fields documentation.
    Example: {}

LegacyGET /stages/{stage_id}/bracket-nodes