Brackets

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

Simple Access

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 cannot exceed 128. (see Pagination)

    Example: nodes=0-127

Path parameters

  • tournament_id
    string

    The id of the concerned tournament

  • stage_id
    string

    The id of the concerned stage

Query Parameters

  • group_ids
    array

    A list of group ids to filter

    Example: 618965314871946714,618932178746476544

  • 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 doesn't 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": [
            {
                "id": "618946545664165456",
                "number": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "source_type": "winner",
                "source_node_id": "618946514654565656",
                "participant": {
                    "id": "375143143408309123",
                    "name": "Jon Snow",
                    "custom_fields": {
                        "country": "UK",
                        "logo": {
                            "logo_small": "url_to_small_image",
                            "logo_medium": "url_to_medium_image",
                            "logo_large": "url_to_large_image"
                        }
                    }
                }
            }
        ]
    }
]
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 type of match

    Possible values: duel, ffa, bye

  • status
    string

    The status of the match

    Possible values: pending, running, completed

  • scheduled_datetime
    datetime|null

    The scheduled date of the match

    Format: RFC 3339 (combined date, time and utc offset)

    Example: "2015-12-31T00:00:00+00:00"

  • played_at
    datetime|null

    The timestamp on which the match was played (a result was provided)

    Format: RFC 3339 (combined date, time and utc offset)

    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]