Game API

Get Loadout For Player Characters By Platform ID

GET

https://api.lootlocker.com/game/v1/player/character/loadout/{platform_id}

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.lootlocker.com/game/v1/player/character/loadout/FTKJE2HP55HA?platform=steam' \
--header 'x-session-token: ' \
--header 'x-session-token;'

Response Example

{
  "success": true,
  "loadouts": [
    {
      "character": {
        "id": 0,
        "ulid": "string",
        "type": "string",
        "name": "string",
        "is_default": true
      },
      "loadout": [
        {
          "variation_id": 0,
          "instance_id": 0,
          "mounted_at": "string",
          "asset": {
            "id": 1,
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "ulid": "01J8J4FJG869W5Q19FSDT8D3AC",
            "name": "string",
            "active": true,
            "purchasable": true,
            "price": 0,
            "sales_price": 1,
            "display_price": "string",
            "context": "string",
            "context_id": 1,
            "character_classes": [
              1
            ],
            "unlocks_context": "string",
            "detachable": true,
            "updated": "string",
            "marked_new": "string",
            "default_variation_id": 1,
            "default_loadouts": {
              "<user supplied loadout name>": true
            },
            "description": "string",
            "links": [
              {
                "<user supplied simple name>": "string"
              }
            ],
            "storage": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "rarity": {
              "name": "string",
              "short_name": "string",
              "color": "string"
            },
            "popular": true,
            "popularity_score": 1,
            "package_contents": [
              {
                "asset": {}
              }
            ],
            "unique_instance": true,
            "external_identifiers": {
              "psn": {
                "entitlement_id": "string",
                "sku_id": "string",
                "product_id": "string"
              },
              "apple_app_store": {
                "product_id": "string"
              },
              "google_play": {
                "product_id": "string"
              }
            },
            "rental_options": [
              {
                "id": 0,
                "name": "string",
                "duration": 0,
                "price": 0,
                "sales_price": 0,
                "links": [
                  {
                    "<user supplied simple name>": "string"
                  }
                ]
              }
            ],
            "filters": [
              {
                "value": "string",
                "name": "string"
              }
            ],
            "files": [
              {
                "id": 1,
                "name": "string",
                "duration": 1,
                "price": 1,
                "sales_price": 1,
                "links": [
                  {
                    "<user supplied simple name>": "string"
                  }
                ]
              }
            ],
            "data_entities": [
              "string"
            ],
            "hero_equip_exceptions": [
              {
                "can_equip": true,
                "hero_id": 0,
                "hero_name": "string"
              }
            ],
            "asset_candidate": 1,
            "drop_table_max_picks": 1,
            "variations": [
              {
                "id": 1,
                "name": "string",
                "primary_color": "string",
                "secondary_color": "string",
                "links": [
                  {
                    "<user supplied simple name>": "string"
                  }
                ]
              }
            ],
            "featured": true,
            "context_locked": true,
            "initially_purchasable": true
          },
          "rental": {
            "is_rental": true,
            "time_left": null,
            "duration": null,
            "is_active": null
          }
        }
      ]
    }
  ]
}

Request

Path Params

platform_id

string

required

The player identifier from the first party platform the player belongs to

Example:

FTKJE2HP55HA

Query Params

platform

enum<string>

required

The simple representation of the platform. Optional if platform is the same as the current player session. Valid options: steam, psn, apple_sign_in, apple_game_center, meta, epic_games, google_sign_in, xbox_one, nintendo_switch, guest, white_label_login, luna

Allowed values:

steampsnwhite_label_loginapple_sign_inapple_game_centermetaepic_gamesgoogle_sign_inxbox_onenintendo_switchguestluna

Example:

steam

Header Params

x-session-token

string

required

Example:

Responses

🟢200OK

application/json

Body

success

boolean

required

loadouts

array [object {2}]

required

character

object

optional

loadout

array [object {5}]

optional

Modified at 2025-01-23 21:09:19

Get Loadout For All Player Characters

Equip Asset To Character