Gets ladders of an account.

GET

/v1/ladders

ladder

Gets ladders of an account. Includes ladders which this account is the admin of, as well as ladders in which this account is participating in as a ladder-entry.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

adminOnly

array[boolean]

optional

Whether to only return ladders which this account is the admin of.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

number

read-onlyoptional

References a ladder.

Example:

name

string

required

The display name for this ladder.

Example:

My Ladder

ratingAlgorithm

string

optional

Rating algorithm to use. We support Elo, Glicko-1 and Glicko-2. If you don't have any particular requirements and/or don't know about the details of each algorithm, then we usually recommend Glicko-1.

Example:

Glicko-1

glickoCValue

number

optional

Default:

18.13

glicko2RValue

number

optional

Default:

0.5

playersCanEnterResults

boolean

optional

Allows players to add and remove results. If allowFullResultHistory is set, players can also add and remove results they haven't themselves participated in.

Example:

false

allowFullResultHistory

boolean

optional

Allows players to see the result history of all other players of this competition, not just their own.

Example:

true

Example

[
  {
    "id": 0,
    "name": "My Ladder",
    "ratingAlgorithm": "Glicko-1",
    "glickoCValue": 18.13,
    "glicko2RValue": 0.5,
    "playersCanEnterResults": false,
    "allowFullResultHistory": true
  }
]

🟠400Bad request

🟠401Unauthorized

🟠429Too Many Requests

Modified at 2024-04-09 16:58:35

Deletes a ladder from an account, including all its entries, ratings and results.

Adds a self-managed entry to a ladder.