gg.infinitetavern.tavern.getAdventurerCodex

infinitetavern.gg

Documentation

Retrieve a player's Adventurer's Codex — their portable character sheet with titles, labels, and career summary.

main query

Retrieve a player's Adventurer's Codex — their portable character sheet with titles, labels, and career summary.

Parameters

did string did Required

The DID of the adventurer whose codex to retrieve.

Output

Encodingapplication/json
codex unknown Required

The player's codex, or null if no codex record exists.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The DID of the adventurer whose codex to retrieve.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "codex"
      ],
      "properties": {
        "codex": {
          "$ref": "#/defs/codexView",
          "description": "The player's codex, or null if no codex record exists."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "did"
    ],
    "properties": {
      "did": {
        "type": "string",
        "format": "did",
        "description": "The DID of the adventurer whose codex to retrieve."
      }
    }
  },
  "description": "Retrieve a player's Adventurer's Codex — their portable character sheet with titles, labels, and career summary."
}
codexView object

No description available.

Properties

activeTitle string Optional

Key of the player's active display title.

activeTitleDisplay string Optional

Display name of the active title.

activeTitleTier string Optional

Rarity tier of the active title.

championships integer Required

Total first-place finishes.

did string did Required

The adventurer's DID.

earnedLabels array of string Required

Keys of all earned labels.

earnedTitles array of string Required

Keys of all earned titles.

favoriteHero string Optional

Most-played hero key.

gamesPlayed integer Required

Total games played.

peakRenown number Required

Peak MMR (Renown).

updatedAt string datetime Required

Last codex update timestamp.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "earnedTitles",
    "earnedLabels",
    "gamesPlayed",
    "championships",
    "peakRenown",
    "updatedAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The adventurer's DID."
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Last codex update timestamp."
    },
    "peakRenown": {
      "type": "number",
      "description": "Peak MMR (Renown)."
    },
    "activeTitle": {
      "type": "string",
      "description": "Key of the player's active display title."
    },
    "gamesPlayed": {
      "type": "integer",
      "description": "Total games played."
    },
    "earnedLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keys of all earned labels."
    },
    "earnedTitles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keys of all earned titles."
    },
    "favoriteHero": {
      "type": "string",
      "description": "Most-played hero key."
    },
    "championships": {
      "type": "integer",
      "description": "Total first-place finishes."
    },
    "activeTitleTier": {
      "type": "string",
      "description": "Rarity tier of the active title."
    },
    "activeTitleDisplay": {
      "type": "string",
      "description": "Display name of the active title."
    }
  }
}

Lexicon Garden

@