Gets ladder entries.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

ladderId

array[integer]

required

Id of ladder

amount

array[integer]

optional

Amount of latest ladder-entries to get. Default and maximum is 50.

offset

array[integer]

optional

Amount of latest ladder-entries to skip. For example, if you have already populated an entry list with 50 ladder-entries, but then your user wants to see more entries, you would fetch those using offset=50.

orderByRating

array[boolean]

optional

By default, entries are ordered by newest added. You can instead specify entries to be ordered by highest rating, resulting in a leaderboard of your ladder.

resultId

array[integer]

optional

Only get entries that participated in the result with this id. This can also be called by non-admins if they themselves participated in the given result, or if the allowFullResultHistory permission is set for its ladder. Mutually exclusive with all other query parameters.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.competier.net/v1/ladder-entries?ladderId&amount&offset&orderByRating&resultId'

Responses

🟢200OK

application/json

Body

array of:

id

number

read-onlyoptional

References a ladder-entry.

Example:

0

ladderId

integer

required

id of the ladder that this ladder-entry belongs to.

Example:

0

name

string

required

The display name for this ladder entry.

Example:

Jane Doe

rating

integer

optional

Allows manually setting rating, for example when moving already existing ladders with ongoing ratings to Competier. Leave as default otherwise.

Example:

1500

reliabilityDeviation

integer

optional

For Glicko algorithms: Allows manually setting relaibility deviation, for example when moving already existing ladders with ongoing ratings to Competier. Leave as default otherwise.

Example:

350

accountIds

array[integer]

read-onlyoptional

IDs of accounts represented by this entry. A ladder-entry representing real accounts will be generated in your ladder if those accounts accept invites to your ladder.

Example

[
  {
    "id": 0,
    "ladderId": 0,
    "name": "Jane Doe",
    "rating": 1500,
    "reliabilityDeviation": 350,
    "accountIds": [
      0
    ]
  }
]

🟠400Bad request

🟠401Unauthorized

🟠429Too Many Requests