/rank

Gets Rank Among all Players

get

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

Authorizations

auth_bearersession_secret

Path parameters

leaderboardNameOrIdanyRequired

Specifies the leaderboard name or ID.

Query parameters

leaderboardEpochanyOptional

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).

Default: 0

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

text/csv

get

HTTPcURLJavaScriptPython

GET /api/rest/rank/global/{leaderboardNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets Rank among Friends

get

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

Authorizations

auth_bearersession_secret

Path parameters

leaderboardNameOrIdanyRequired

Specifies the leaderboard name or ID.

Query parameters

offsetanyOptional

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

Default: 0

countanyOptional

The number of results to return in the page.

Default: 20

relativeanyOptional

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

Default: false

leaderboardEpochanyOptional

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

Default: 0

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/rank/friends/{leaderboardNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets Rank among Mutual Followers

get

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

Authorizations

auth_bearersession_secret

Path parameters

leaderboardNameOrIdanyRequired

Specifies the leaderboard name or ID.

Query parameters

offsetanyOptional

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

Default: 0

countanyOptional

The number of results to return in the page.

Default: 20

relativeanyOptional

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

Default: false

leaderboardEpochanyOptional

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

Default: 0

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/rank/mutual_followers/{leaderboardNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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