Viewer API › Rankings Legacy

Endpoints

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

LegacyGET /tournaments/{tournament_id}/stages/{stage_id}/ranking-items

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

Returns ranking items of a stage with a small summary of the associated participant in the ranking. The items are always ordered by ascending position.

Resource URL

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

HTTP headers

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

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: 618965314871946714,618932178746476544
group_numbers
array
A list of group numbers to filter.
Example: 3,4

Request Body

This endpoint does not require a request body.

Response

[206] List of ranking items.

Example

[
    {
        "id": "618983668512789184",
        "group_id": "618983668512789184",
        "number": 2,
        "position": 4,
        "rank": 3,
        "participant": {
            "id": "375143143408309123",
            "name": "Jon Snow",
            "custom_fields": {}
        },
        "points": 17,
        "properties": {
            "wins": 1,
            "draws": 0,
            "losses": 0,
            "played": 1,
            "forfeits": 0,
            "score_for": 0,
            "score_against": 0,
            "score_difference": 0
        }
    }
]

Structure (collection)

id
string
The id of the ranking item.
Example: "618983668512789184"
group_id
string
The id of the group associated to this ranking.
Example: "618983668512789184"
number
integer
A number used as relative identifier within the ranking. It is determined from the seed attributed to the participant during the placement.
Example: 2
position
integer
A position used for presentation purposes. It is always unique within the same ranking.
Example: 4
rank
integer|null
The ranking of the participant in the ranking. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.
Example: 3
participant
object|null
- id
  string
  The id of the participant.
  Example: "375143143408309123"
- name
  string
  The name of the participant.
  Max. length: 40 characters
  Example: "Jon Snow"
- 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: {}
points
integer
A number of points acquired by the participant in the ranking.
Example: 17
properties
object
A list of ranking metrics (see ranking properties).
Example: {"wins":1,"draws":0,"losses":0,"played":1,"forfeits":0,"score_for":0,"score_against":0,"score_difference":0}

LegacyGET /stages/{stage_id}/ranking-items