GET players/{steamId}/entries/{lbid}

Gets a player's leaderboard entry for a leaderboard.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lbid

The ID of the leaderboard.

integer

Required

steamId

The Steam ID of the player.

integer

Required

Response Information

Resource Description

Returns a player's leaderboard entry for a leaderboard.

Entry
NameDescriptionTypeAdditional information
leaderboard

The leaderboard that contains the entry.

Leaderboard

player

The player that submitted the entry.

Player

rank

The rank of the entry on the leaderboard.

integer

score

The raw score value.

integer

end

The zone and level that the entry ends on.

End

killed_by

The entity that killed the player. This may be null if the replay has not been parsed yet or there was an error parsing the replay.

string

version

Version of the entry's replay. This may be null if the replay has not been parsed yet or there was an error parsing the replay.

integer

Response Status Codes

404 Not Found if a player with that Steam ID was not found.

404 Not Found if an entry for the player on the leaderboard was not found.

Response Formats

application/json, text/json

Sample:
{
  "leaderboard": {
    "id": 1,
    "updated_at": "2020-07-12T10:45:04.867627Z",
    "name": "sample string 2",
    "display_name": "sample string 3",
    "production": true,
    "product": "sample string 5",
    "_product": {
      "id": 1,
      "name": "sample string 2",
      "display_name": "sample string 3"
    },
    "mode": "sample string 6",
    "_mode": {
      "id": 1,
      "name": "sample string 2",
      "display_name": "sample string 3"
    },
    "run": "sample string 7",
    "_run": {
      "id": 1,
      "name": "sample string 2",
      "display_name": "sample string 3"
    },
    "character": "sample string 8",
    "_character": {
      "id": 1,
      "name": "sample string 2",
      "display_name": "sample string 3"
    },
    "coOp": true,
    "customMusic": true,
    "total": 11
  },
  "player": {
    "id": "sample string 1",
    "updated_at": "2020-07-12T10:45:04.867627Z",
    "display_name": "sample string 2",
    "avatar": "sample string 3"
  },
  "rank": 1,
  "score": 2,
  "end": {
    "zone": 1,
    "level": 2
  },
  "killed_by": "sample string 3",
  "version": 1
}