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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.competier.net/v1/ladder' \
--header 'Authorization: Bearer <token>' \
--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

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-06-16 11:54:03

Creates and returns a new api key, invalidating the previous one.

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