Game API
HomeLootLocker
HomeLootLocker
LootLocker
  1. Metadata
  • 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
    • List Multiple Players Info
    • Lookup Player Names by IDS
    • Get Players Active Name
    • Set Player Name
    • Migrate DLCs
    • Get Migrated DLCs
    • Set Player Profile Private
    • Set Player Profile Public
    • Get Other Players Loadout for Default Character
    • Get Players Loadout for Default Character
    • Delete Player
    • Submit XP
    • Get Other Player Info
    • Get Player Info
    • Get Multiple Other Players XP And Level
  • 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
      GET
    • Metadata Operations
      POST
    • List Multisource Metadata
      POST
  • 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
  • Broadcasts
  1. Metadata

Metadata Operations

POST
/game/metadata
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.lootlocker.com/game/metadata' \
--header 'Content-Type: application/json' \
--header 'x-session-token;' \
--data-raw '{
    "source": "self",
    "source_id": "self",
    "entries": [
        {
            "value": true,
            "key": "has_beta_access",
            "type": "bool",
            "tags": [],
            "access": [
                "game_api.read"
            ],
            "action": "create"
        },
        {
            "value": "xXx_ProGamer9000_xXx",
            "key": "preferred_nickname",
            "type": "string",
            "tags": [
                "foo"
            ],
            "access": [
                "game_api.read",
                "game_api.write"
            ],
            "action": "create"
        },
        {
            "value": 25,
            "key": "player_age",
            "type": "number",
            "tags": [
                "foo",
                "bar"
            ],
            "access": [
                "game_api.read"
            ],
            "action": "create"
        },
        {
            "value": 35,
            "key": "player_age",
            "type": "number",
            "tags": [
                "foo",
                "bar"
            ],
            "access": [
                "game_api.read"
            ],
            "action": "update"
        },
        {
            "value": {
                "key": "value",
                "properties": {
                    "tutorial_complete": true,
                    "chapter_one_complete": true
                }
            },
            "key": "game_state",
            "type": "json",
            "tags": [],
            "access": [
                "game_api.read"
            ],
            "action": "create"
        },
        {
            "value": {
                "content_type": "image/jpeg",
                "content": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII="
            },
            "key": "chosen_icon",
            "type": "base64",
            "tags": [],
            "access": [
                "game_api.read"
            ],
            "action": "create"
        },
        {
            "key": "some_deprecated_key",
            "action": "delete"
        }
    ]
}'
Response Response Example
202 - Success
{
  "errors": [],
  "source": "reward",
  "source_id": "01J3ZEYRX4QVFZ0QC4DF4J1SST"
}

Request

Authorization
API Key
Add parameter in header
x-session-token
Example:
x-session-token: ********************
Body Params application/json
self
boolean 
optional
If set to true, source and source_id will be ignored, all actions will be taken against the logged-in player.
source
enum<string> 
required
Source can be any of the supported features (Optional when self: true)
Allowed values:
leaderboardrewardcatalog_itemprogressioncurrencyplayer
source_id
string 
required
Source ID as a ULID (Optional when self: true)
entries
array[object (Metadata Action) {6}] 
required
>= 1 items<= 100 items
access
array[string]
required
Controls the access level this entry should have via the Game API.
Allowed values:
game_api.readgame_api.write
key
string 
required
The name of the metadata key you want to insert.
tags
array[string]
required
type
enum<string> 
required
Defines the type of metadata value you are passing in.
All types are self-explanatory with the notable exception of base64, which requires you follow this specific value format:
{
    "content-type": "<some content type, e.g. image/jpeg>",
    "content": "<some base64 value>"
}
Allowed values:
jsonbase64numberstringbool
value
Metadata Value
required
The actual value of the metadata.
action
string 
required
Examples

Responses

🟢202Accepted
application/json
Body
errors
array [object {3}] 
required
action
string 
required
entry
object 
required
error
string 
required
source
string 
required
source_id
string 
required
🟠400Invalid Request Body
Modified at 2025-03-31 14:06:04
Previous
List Metadata
Next
List Multisource Metadata
Built with