Circuit API › Ranking Items

GET /ranking-items

Returns ranking items. The items are always ordered by ascending position.

Resource URL

https://api.toornament.com/circuit/v2/ranking-items

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:circuit scope (see Authorization)

  • 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

Query Parameters

  • ranking_ids
    array

    Only return rankings for the given list of ids.

    Example: 6031125052363620352,6036956611039707136

  • circuit_ids
    array

    Only return rankings for the given list of circuit ids.

    Example: 5617559294676615168,5629045554450325504

  • entities
    array

    Only return ranking items for the given list of participating entities.

    Example: team:435866996967283843,player:435867002403094801

  • min_position
    integer

    Only return ranking items from a minimum position.

  • max_position
    integer

    Only return ranking items up to a maximum position.

  • min_rank
    integer

    Only return ranking items from a minimum rank.

  • max_rank
    integer

    Only return ranking items up to a maximum position.

  • min_points
    integer

    Only return ranking items from a minimum number of points.

  • max_points
    integer

    Only return ranking items up to a maximum number of points.

Request Body

This endpoint does not require a request body.

Response

[206] List of ranking items.

Example
[
    {
        "id": "6031125052363620352",
        "ranking": {
            "id": "6036956611039707136",
            "circuit_id": "5617559294676615168",
            "name": "Challenger League",
            "discipline": "leagueoflegends"
        },
        "entity_id": "435867002503758116",
        "position": 4,
        "rank": 3,
        "points": 17
    }
]
Structure (collection)
  • id
    string

    The unique identifier of the ranking item.

    Example: "6031125052363620352"

  • ranking
    object

    The ranking of this item.

  • entity_id
    string

    The identifier of the participating entity of the ranking item.

    Example: "435867002503758116"

  • position
    integer

    The position of the participating entity of the ranking item. It is unique within a ranking.

    Example: 4

  • rank
    integer

    The rank of the participating entity of the ranking item. Multiple participants can share the same rank if they are tied after involving all configured tiebreakers.

    Example: 3

  • points
    integer

    The number of points acquired by the participating entity of the ranking item.

    Example: 17