Competier
  • api-key
  • ladder
    • Adds a ladder to an account.POST
    • Deletes a ladder from an account, including all its entries, ratings and results.DELETE
    • Gets ladders of an account.GET
  • ladder-entry
  • result
  • invite
  • account
  • credit
  • websocket
logoPowered by Apidog
  1. ladder

Adds a ladder to an account.

POST/v1/ladder

Adds a ladder to an account. A ladder is a type of competition in which players are rated based on their performance over an arbitrary timespan, f.e. the chess FIDE rating.

Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
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

Responses

OK(200)
Bad request(400)
Unauthorized(401)
Too Many Requests(429)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
Not configured
Last modified: 7 months ago