Adds a ladder to an account.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

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

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.competier.net/v1/ladder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Ladder",
    "ratingAlgorithm": "Glicko-1",
    "glickoCValue": 18.13,
    "glicko2RValue": 0.5,
    "playersCanEnterResults": false,
    "allowFullResultHistory": true
}'

Responses

🟢200OK

application/json

Body

id

number

read-onlyoptional

References a ladder.

Example:

0

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