GET players/{steamId}/entries

Gets a Steam player's leaderboard entries.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
steamId

The Steam ID of the player.

integer

Required

lbids

Comma-separated leaderboard IDs.

Object []

Required

products

Valid values are 'classic' and 'amplified'. If not provided, returns leaderboards from all products.

Object []

Required

production

If true, returns production leaderboards. If false, returns Early Access leaderboards. If not provided, returns both production and Early Access leaderboards.

boolean

coOp

If true, returns Co-op leaderboards. If false, returns non-Co-op leaderboards. If not provided, returns both Co-op and non-Co-op leaderboards.

boolean

customMusic

If true, returns Custom Music leaderboards. If false, returns non-Custom Music leaderboards. If not provided, returns both Custom Music and non-Custom Music leaderboards.

boolean

Response Information

Resource Description

Returns a Steam player's leaderboard entries.

PlayerEntries
NameDescriptionTypeAdditional information
player

The Steam player.

Player

total

Total number of leaderboard entries.

integer

entries

A collection of leaderboard entries.

Entry[]

Response Status Codes

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

404 Not Found if one or more leaderboards were not found.

Response Formats

application/json, text/json

Sample:
{
  "player": {
    "id": "sample string 1",
    "updated_at": "2020-07-12T10:20:57.520019Z",
    "display_name": "sample string 2",
    "avatar": "sample string 3"
  },
  "total": 1,
  "entries": [
    {
      "leaderboard": {
        "id": 1,
        "updated_at": "2020-07-12T10:20:57.520019Z",
        "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:20:57.520019Z",
        "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
    },
    {
      "leaderboard": {
        "id": 1,
        "updated_at": "2020-07-12T10:20:57.520019Z",
        "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:20:57.520019Z",
        "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
    }
  ]
}