/rank

Previous/leaderboard Next/score

Last updated 10 days ago

Gets Rank Among all Players

Gets the current Profile's rank among all players for the particular leaderboard.

get

/rank/global/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If not provided, the current epoch will be used by default for epochal leaderboards. This value will be ignored for all-time leaderboards. Set this value to 0 to explicitly reference the current epoch (when applicable).

Responses

application/json

text/csv

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/global/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets Rank among Friends

Gets the current Profile's rank among friends for the particular leaderboard.

get

/rank/friends/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

offsetany · default: 0

May be negative to place the requested player in the middle of the page.

countany · default: 20

The number of results to return in the page.

relativeany · default: false

Indicates whether or not to fetch results in a relative fashion.

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/friends/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets Rank among Mutual Followers

Gets the current Profile's rank among mutual followers for the particular leaderboard.

get

/rank/mutual_followers/{leaderboardNameOrId}

Authorizations

Path parameters

leaderboardNameOrIdanyrequired

Specifies the leaderboard name or ID.

Query parameters

offsetany · default: 0

May be negative to place the requested player in the middle of the page.

countany · default: 20

The number of results to return in the page.

relativeany · default: false

Indicates whether or not to fetch results in a relative fashion.

leaderboardEpochany · default: 0

Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/rank/mutual_followers/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}