Circuit API › Rankings

Download OpenAPI 3.0

Endpoints

GET /rankings

Returns all rankings from your circuits.

Resource URL

https://api.toornament.com/circuit/v2/rankings

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 rankings unit. The size of the range can not exceed 50. (see Pagination)

    Example: rankings=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

  • discipline
    string

    Only return rankings for the given discipline.

    Example: leagueoflegends

  • entity_type
    string

    Only return rankings for the given participating entity type.

    Example: team

  • season_ids
    array

    Only return rankings for the given list of seasons, identified by their ids.

    Example: 5617559294676615168,5629045554450325504

  • season_names
    array

    Only return rankings for the given list of seasons, identified by their machine names.

    Example: season_1,season_3

  • region_ids
    array

    Only return rankings for the given list of regions, identified by their ids.

    Example: 5617559294676615168,5629045554450325504

  • region_names
    array

    Only return rankings for the given list of regions, identified by their machine names.

    Example: europe,americas,asia

Request Body

This endpoint does not require a request body.

Response

[206] Rankings retrieved.

Example
[
    {
        "id": "6031125052363620352",
        "circuit": {
            "id": "5756452414364442624",
            "name": "Challenger League"
        },
        "name": "Global Ranking",
        "engine": "points",
        "discipline": "leagueoflegends",
        "entity_type": "player",
        "season": {
            "id": "5629045554450325504",
            "name": "Open Winter 2022",
            "machine_name": "open_winter_2022"
        },
        "region": {
            "id": "5629088936350867456",
            "name": "Europe West",
            "machine_name": "euw"
        },
        "settings": {
            "default_scale": {
                "1": 300,
                "2-9": 100,
                "10-20": 40
            }
        }
    }
]
Structure (collection)
  • id
    string

    The unique identifier of the ranking.

    Example: "6031125052363620352"

  • circuit
    object

    The circuit associated with this ranking.

  • name
    string

    The name of the ranking.

    Max. length: 40 characters

    Example: "Global Ranking"

  • engine
    string

    The engine used to calculate the ranking.

    Possible values: points, elo

  • discipline
    string

    Unique identifier of the ranking’s discipline.

    Example: "leagueoflegends"

  • entity_type
    string

    The type of participating entity to be analyzed in matches for the ranking.

    Possible values: player, team, custom_player, custom_team

  • season
    object|null

    The circuit season associated with this ranking.

  • region
    object|null

    The circuit region associated with this ranking.

  • settings
    object

    The settings of the ranking.

    Example: {"default_scale":{"1":300,"2-9":100,"10-20":40}}

GET /rankings/{id}

Returns a ranking identified by the given id.

Resource URL

https://api.toornament.com/circuit/v2/rankings/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:circuit scope (see Authorization)

Path parameters

  • id
    string

    The id of the ranking.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Ranking retrieved

Example
{
    "id": "6031125052363620352",
    "circuit": {
        "id": "5756452414364442624",
        "name": "Challenger League"
    },
    "name": "Global Ranking",
    "engine": "points",
    "discipline": "leagueoflegends",
    "entity_type": "player",
    "season": {
        "id": "5629045554450325504",
        "name": "Open Winter 2022",
        "machine_name": "open_winter_2022"
    },
    "region": {
        "id": "5629088936350867456",
        "name": "Europe West",
        "machine_name": "euw"
    },
    "settings": {
        "default_scale": {
            "1": 300,
            "2-9": 100,
            "10-20": 40
        }
    }
}
Structure (object)
  • id
    string

    The unique identifier of the ranking.

    Example: "6031125052363620352"

  • circuit
    object

    The circuit associated with this ranking.

  • name
    string

    The name of the ranking.

    Max. length: 40 characters

    Example: "Global Ranking"

  • engine
    string

    The engine used to calculate the ranking.

    Possible values: points, elo

  • discipline
    string

    Unique identifier of the ranking’s discipline.

    Example: "leagueoflegends"

  • entity_type
    string

    The type of participating entity to be analyzed in matches for the ranking.

    Possible values: player, team, custom_player, custom_team

  • season
    object|null

    The circuit season associated with this ranking.

  • region
    object|null

    The circuit region associated with this ranking.

  • settings
    object

    The settings of the ranking.

    Example: {"default_scale":{"1":300,"2-9":100,"10-20":40}}