# Metadata

Metadata allows you to store additional, custom information related to various LootLocker features, such as Progressions, Leaderboards, and Catalogs. This data lets you add context or functionality to these features, going beyond the default settings. For example, you might use Metadata to store map details for a leaderboard or to attach an image to an item in your in-game store.

### Types of Metadata

Metadata can be stored in a variety of formats:

* **String**: Ideal for storing text, such as names or descriptions.
* **Base64**: Used for encoding files like icons, thumbnails or other binary data.
* **Boolean**: A true/false value, useful for toggling settings such as whether a store item is featured.
* **Number**: Stores numeric values, such as scores or item prices.
* **JSON**: A structured format for storing complex objects, like configurations or items with a list of stats.

### Tags

Tags are an optional input that lets you categorize or label Metadata entries. This makes it easier to search and filter Metadata in the client or on the server. For example, you can use tags to flag certain Metadata entries as "seasonal" or "limited edition" to tailor in-game content accordingly.

### Game Read Access

The "Game Read" tick box allows you to control whether the Metadata can be accessed via the Game API. If this option is selected, the Metadata will be available to the game client through the Game API. If it is not selected, the Metadata will only be accessible via the Server API. This feature is primarily used for security purposes, to ensure that sensitive information remains server-side and out of reach from the game client.

## Use Cases

### Leaderboards

* Seasonal leaderboards
* Leaderboards linked to specific maps
* List leaderboards for a specific country
* A leaderboard banner and information

### Progressions

* Battle Pass criteria
* Get progressions only for a specific class (like warrior or rogue)
* Information about what a progression is for
* Progression banner images

### Currencies

* Currency icon
* Detailed currency information

### Catalogs

* Discount price
* Featured item toggle
* Show only specific shop sections: food, weapons

## How To

* [Add Metadata in Console](/shared-systems/metadata/how-to/add-metadata-in-console.md)
* [Fetch a Single Metadata In-Game](/shared-systems/metadata/how-to/fetch-a-single-metadata-in-game.md)
* [Fetch Metadata In-Game by Tags](/shared-systems/metadata/how-to/fetch-metadata-in-game-by-tags.md)
* [Fetch Metadata In-Game from Multiple Sources](/shared-systems/metadata/how-to/fetch-metadata-in-game-from-multiple-sources.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.lootlocker.com/shared-systems/metadata.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.