Server API
HomeLootLocker
HomeLootLocker
LootLocker
  1. Metadata
  • Session
    • Session
      POST
    • Ping
      GET
  • Leaderboards
    • Schedules
      • Create
      • Delete
      • Get
    • Rewards
      • Create
      • Delete
    • Archives
      • Download
      • List
    • Get Leaderboard
      GET
    • Create Leaderboard
      POST
    • Update Leaderboard
      PUT
    • Delete Leaderboard
      DELETE
    • Submit Score
      POST
    • Get All Member Ranks
      GET
    • Get Score List
      GET
  • Assets
    • Get Assets
      GET
  • Asset Instances
    • Get All Storage To Asset Instance
      GET
    • Get Storage Pair by ID
      GET
    • Create Storage Pair on Asset Instance
      POST
    • Update Storage Pairs by Key on Instance
      PUT
    • Update Storage Pair by ID on Instance
      PUT
    • Delete Storage Pair by ID on Instance
      DELETE
  • Triggers
    • Invoke Trigger
      POST
  • Inventories
    • List Player Inventory
      GET
    • Get Character Inventory
      GET
    • Get Hero Inventory
      GET
    • Alter Player Inventory
      PATCH
    • Add Asset to Player Inventory
      POST
    • List Universal Assets
      GET
  • Loadouts
    • Get Player Loadout
    • Equip Asset for Player Loadout
    • Unequip Asset for Player Loadout
    • Get Character Loadout
    • Equip Asset for Character Loadout
    • Unequip Asset for Character Loadout
    • Get Hero Loadout
    • Equip Asset for Hero Loadout
    • Unequip Asset for Hero Loadout
  • Characters & Heroes
    • Get Player Characters
    • Get Player Heroes
  • Player Storage
    • Get Player Storage
    • Lookup keys for Multiple Players
    • Delete for Multiple Players
    • Set for Multiple Players
  • Player Files
    • List Files for Player
    • Get File By ID for Player
    • Delete File By ID for Player
    • Upload File For Player
  • Drop Tables
    • Compute and Lock Drop Table
    • Pick Drops
  • Loot Boxes
    • Inspect Loot Box
    • Open Loot Box
  • Player
    • Get Player Info By Game Session Tokens
    • Create Player
    • Lookup Player Names by IDs
  • Progressions
    • Tiers
      • Get Progression Tiers
      • Get Single Progression Tier By Step
    • Players
      • Get All Player Progressions
      • Get Player Progressions By ID
      • 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 ID
      • 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 ID
      • Add points to Asset Instance progression
      • Subtract points from Asset Instance progression
      • Reset Asset Instance progression
      • Delete Asset Instance progression
    • Get All Progressions
    • Get Progression By Key
  • Balances
    • Create Wallet Modifiers
    • Credit Balance
    • Debit Balance
    • List Balances
    • Create New Wallet
    • Get Wallet
    • Get Wallet for Holder
  • Currency
    • List Currencies
  • Friends
    • List Friends
  • Metadata
    • Metadata Actions
      POST
    • List Metadata
      GET
    • List Multisource Metadata
      POST
  • Catalogs
    • List Catalog Items By Key
  • Notifications
    • Send Notification to Player
  1. Metadata

List Metadata

GET
/server/metadata/source/{source}/id/{source_id}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lootlocker.io/server/metadata/source/reward/id/01J3ZEYRX4QVFZ0QC4DF4J1SST' \
--header 'x-auth-token;'
Response Response Example
{
  "metadata": [
    {
      "value": true,
      "key": "has_beta_access",
      "type": "bool",
      "tags": []
    },
    {
      "value": "xXx_ProGamer9000_xXx",
      "key": "preferred_nickname",
      "type": "string",
      "tags": [
        "foo"
      ]
    },
    {
      "value": 35,
      "key": "player_age",
      "type": "number",
      "tags": [
        "foo",
        "bar",
        "baz"
      ]
    },
    {
      "value": {
        "key": "value",
        "properties": {
          "tutorial_complete": true,
          "chapter_one_complete": true
        }
      },
      "key": "game_state",
      "type": "json",
      "tags": []
    },
    {
      "value": {
        "content_type": "image/jpeg",
        "content": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII="
      },
      "key": "chosen_icon",
      "type": "base64",
      "tags": []
    }
  ],
  "pagination": {
    "errors": null,
    "per_page": 10,
    "offset": 0,
    "total": 5,
    "last_page": 1,
    "current_page": 1,
    "next_page": null,
    "prev_page": null
  }
}

Request

Authorization
API Key
Add parameter in header
x-auth-token
Example:
x-auth-token: ********************
Path Params
source
string 
required
Source can be any of the supported features.
Example: leaderboard,reward, catalog_item,currency, progression, player
Example:
reward
source_id
string 
required
Example:
01J3ZEYRX4QVFZ0QC4DF4J1SST
Query Params
page
string 
optional
Page you want to see.
Example:
1
per_page
string 
optional
Number of items you want to see per page (max 100)
Example:
10
key
string 
optional
A specific metadata item identified by key (supercedes all other search parameters)
Example:
has_beta_access
tags
array[string]
optional
List of tags your items need to have.
Example:
["foo","bar"]

Responses

🟢200Success
application/json
Body
metadata
array[object (Metadata Entry) {5}] 
required
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.
pagination
object (Offset Pagination) 
required
errors
array [object {2}] 
required
If the values provided don't allow for pagination to happen, errors will be indicated within this array.
per_page
integer 
required
offset
integer 
required
How far you are within the total set of records.
total
integer 
required
How many items total were found.
last_page
integer 
required
current_page
integer 
required
next_page
integer  | null 
required
prev_page
integer  | null 
required
Modified at 2025-04-17 08:51:32
Previous
Metadata Actions
Next
List Multisource Metadata
Built with