Game API
HomeLootLocker
HomeLootLocker
LootLocker
  1. Home
  • Game API
  • Authentication
    • Guest Session
      POST
    • White Label Session
      POST
    • Steam Session
      POST
    • Epic Games Session
      POST
    • Apple Sign In Session
      POST
    • Apple Game Center Session
      POST
    • Google Session
      POST
    • Nintendo Switch Session
      POST
    • Xbox Session
      POST
    • Meta/Oculus Session
      POST
    • PSN Player Verification
      POST
    • Steam/PSN Session
      POST
    • End Session
      DELETE
    • Steam Player Verification
      POST
  • Unified Player Accounts
    • Connected Accounts
      • List Connected Accounts
      • Connect Google Account
      • Connect Twitch Account
      • Connect Apple Account
      • Attach Provider
      • Transfer Providers
      • Unlink Platform Provider
    • Begin Remote Session Login Lease
      POST
    • Begin Remote Session Link Lease
      POST
    • Poll Remote Session Lease
      POST
    • Refresh Remote Session
      POST
  • White Label Login
    • Sign Up
      POST
    • Sign In
      POST
    • Request Verification
      POST
    • Request Reset Password
      POST
    • Verify Session
      POST
  • Players
    • Files
    • Player Storage
      • Get Player Storage
      • Get Player Storage Single Item
      • Get Player Public Storage
      • Update Player Storage
      • Lookup Public Player Storage
      • Delete Player Storage Item
    • Get Info From Session
      GET
    • List Multiple Players Info
      POST
    • Lookup Player Names by IDS
      GET
    • Get Players Active Name
      GET
    • Set Player Name
      PATCH
    • Migrate DLCs
      POST
    • Get Migrated DLCs
      GET
    • Set Player Profile Private
      DELETE
    • Set Player Profile Public
      POST
    • Get Other Players Loadout for Default Character
      GET
    • Get Players Loadout for Default Character
      GET
    • Delete Player
      DELETE
    • Submit XP
      POST
    • Get Other Player Info
      GET
    • Get Player Info
      GET
    • Get Multiple Other Players XP And Level
      POST
  • Notifications
    • List Notifications
    • Read Notifications
    • Read All Notifications
  • Commerce
    • Currency
      • Get Currency By Code
      • List Currencies
      • List Denominations By Currency
    • Purchasing
      • Stores
        • Google Play Store
          • Google Play Player Product Purchase
          • Google Play Character Product Purchase
        • Apple App Store
          • Apple App Store - Player Purchase
          • Apple App Store - Character Purchase
        • Steam
          • Steam - Begin Purchase
          • Steam - Query Transaction
          • Steam - Finalise Transaction
      • Purchase - In Game Only
      • Get Player Balance
      • Purchase - Get Status
      • Get Order Details
      • Purchase - Soft Currency Spend
      • Purchase - Steam Hard Currency
      • Purchase - Android
      • Purchase - iOS
    • Balances
      • Credit Balance
      • Debit Balance
      • List Balances
      • Get Wallet
      • Get Wallet for Holder
      • Create New Wallet
    • Catalogs
      • List Catalogs For Game
      • List Catalog Items By Key
  • Entitlements
    • List Entitlements
    • Get Single Entitlement
  • Leaderboards
    • Get Score List
    • Submit Score
    • Get Member Rank
    • Get By List of Members
    • List Leaderboards
    • Get Leaderboard Details
    • List Historical Leaderboard Data
    • Get Historical Leaderboard Data
  • Characters & Heroes
    • Characters
      • List Equippable Contexts to Default Character
      • List Equippable Contexts to Character By ID
      • Update Character
      • List Character Types
      • List Characters
      • Create Character
      • Get Loadout For All Player Characters
      • Get Loadout For Player Characters By Platform ID
      • Equip Asset To Character
      • Unequip Asset To Character
      • Equip Asset To Default Character
      • Unequip Asset To Default Character
    • Heroes
      • Get Game Heroes
      • Create Player Hero
      • List Player Heroes
      • Get Player Hero
      • Update Player Hero
      • Delete Player Hero
      • List Player Hero Inventory
      • Get Default Player Hero By SteamID64
      • List Player Heroes By SteamID64
      • List Player Heros Loadout By ID
      • Get Player Hero Loadout
      • Equip Asset to Hero
      • Unequip Asset from Hero
  • Assets
    • Drop Tables
      • Compute and Lock Drop Table
      • Pick Drops
    • List Contexts
    • Get Assets Stream
    • Get Assets List
    • Get Assets List By Asset IDs
    • List Favourite Assets
    • Unfavourite Asset
    • Favourite Asset
  • Asset Instances
    • Storage
      • Stream All Instance Storage To Player
      • Get Key Value for Asset Instance and Key Value Pair ID
      • List Key Value Sets for Asset Instance
      • Create Key Value Pair
      • Update Item Storage By Keys
      • Update Item Storage By ID
      • Delete Item Storage By ID
    • Loot Box
      • Inspect Loot Box
      • Open Loot Box
    • List Universal Assets
    • List Player Inventory
    • Stream Player Inventory
    • Get Asset Grant Notifications
    • Activate Rental Asset
    • Delete asset from player's inventory
    • Grant asset to player
  • Triggers
    • Call
    • Execute Trigger
    • List Triggers For Player
  • Progressions
    • Tiers
      • Get Progression Tiers
      • Get Single Progression Tier By Step
    • Players
      • Get All Player Progressions
      • Get All Player Progressions By Player ULID
      • Get Player Progressions By Key
      • Get Player Progressions By Key and Player ULID
      • Add points to player progression
      • Subtract points from player progression
      • Reset player progression
      • Delete player progression
    • Characters
      • Get All Character Progressions
      • Get Character Progressions By Key
      • Add points to character progression
      • Subtract points from character progression
      • Reset character progression
      • Delete character progression
    • Asset Instances
      • Get All Asset Instance Progressions
      • Get Asset Instance Progressions By Key
      • Add points to an Asset Instance progression
      • Subtract points from an Asset Instance progression
      • Reset Asset Instance progression
      • Delete Asset Instance progression
    • Get All Progressions
    • Get Progression By Key
  • Messages
    • List Messages
  • Friends
    • Followers
      • List
      • Follow
      • Unfollow
    • List Friends
    • List Incoming Friend Requests
    • List Outgoing Friend Requests
    • Send Friend Request
    • Cancel Outgoing Friend Request
    • Accept Friend Request
    • Decline Friend Request
    • Delete Friend
    • List Blocked Players
    • Block Player
    • Unblock Player
  • Feedback
    • Category
      • List
    • Moderation Reporting
      • [Legacy] Report Player
      • [Legacy] Report Asset
      • [Legacy] Get Player Report Reasons
      • [Legacy] Get Asset Report Reasons
      • [Legacy] Get Asset Report Types
      • Get Removed UGC for Player
    • Create
  • Metadata
    • List Metadata
    • Metadata Operations
    • List Multisource Metadata
  • User Generated Content (UGC)
    • Asset Candidates
      • Get Asset Candidate
      • List Asset Candidates
      • Create Asset Candidate
      • Add File to Asset Candidate
      • Update Asset Candidate
      • Delete Asset Candidate
  • Game
    • Ping
  • Collectables
    • Collect Collectable Item
    • List Collectables
  • Missions
    • Get Mission
    • List Missions
    • Start Mission
    • Finish Mission
  1. Home

Authentication

Starting a Player Session#

Before you can call any of the other endpoints, you first need to start a player session.
You can register sessions with any of the below listed options, and you will receive a session_token in the response. This token is used to identify the player in subsequent requests.

Using The Game Session Token#

All session registration calls will return a session_token, which is used to identify the player in subsequent requests.
The session token is sent as a HTTP header, with the name x-session-token. If this is not sent with a request, an authentication error will be returned.

In a nutshell...#

1
Start a player session.
2
Use the returned session_token in the x-session-token header to authenticate your API calls
3
You are ready to use the API.
Modified at 2024-10-01 11:19:17
Previous
Game API
Next
Guest Session
Built with