Get the rating ladder

Lists calibrated players for one rating category and scope, highest rating first. Uncalibrated players are excluded. Defaults to gameType=x01 and scope=online.

GET/ratings

Authorization

x-api-keyAPI key · headerrequired

A user (dp_) or organization (dp_org_) API key with read scopes.

Query parameters

gameTypestring

Rating category to rank.

default: "x01"

Allowed:x01cricket

scopestring

Rating scope to rank.

default: "online"

Allowed:localtournamentonline

limitinteger

Number of ladder entries to return.

min 1 · max 100 · default: 50

Responses

200

The rating ladder.

gameTypestringrequired

Allowed:x01cricket

scopestringrequired

Allowed:localtournamentonline

entriesRatingLadderEntry[]required

Show properties

Array of RatingLadderEntry

rankintegerrequired

max 9007199254740991

userIdstringrequired

displayNamestringrequired

imagestring | nullrequired

gameTypestringrequired

Allowed:x01cricket

scopestringrequired

Allowed:localtournamentonline

rankedbooleanrequired

ratingnumberrequired

divisionRatingDivisionrequired

Show properties

tierstringrequired

Allowed:bronzesilvergoldplatinumdiamond

divisionnumberrequired

Show properties

Any of:

number

number

number

number

number

number

labelstringrequired

gamesPlayedintegerrequired

min 0 · max 9007199254740991

calibrationGamesintegerrequired

max 9007199254740991

lastRatedAtstring | nullrequired

seededbooleanrequired

400

Invalid request.

messagestringrequired

401

Missing or invalid API key.

messagestringrequired

403

The API key is missing a required scope or is the wrong type for this endpoint.

messagestringrequired

404

Entity not found.

messagestringrequired

429

Rate limit exceeded. See the Retry-After header.

messagestringrequired

500

Internal server error.

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

gameTypequeryRating category to rank.scopequeryRating scope to rank.limitqueryNumber of ladder entries to return.

Request

curl -X GET 'https://api.dartpilot.app/v1/ratings' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://api.dartpilot.app/v1/ratings", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.dartpilot.app/v1/ratings",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "gameType": "x01",
  "scope": "local",
  "entries": [
    {
      "rank": 1,
      "userId": "string",
      "displayName": "string",
      "image": "string",
      "gameType": "x01",
      "scope": "local",
      "ranked": true,
      "rating": 0,
      "division": {
        "tier": "bronze",
        "division": 1,
        "label": "string"
      },
      "gamesPlayed": 0,
      "calibrationGames": 1,
      "lastRatedAt": "string",
      "seeded": true
    }
  ]
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}