# gg.infinitetavern.tavern.getLeaderboard

> Published by [infinitetavern.gg](https://lexicon.garden/identity/did:plc:vxwgn77hp5ikvbiggm5es3rv)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:vxwgn77hp5ikvbiggm5es3rv/gg.infinitetavern.tavern.getLeaderboard)
- [Documentation](https://lexicon.garden/lexicon/did:plc:vxwgn77hp5ikvbiggm5es3rv/gg.infinitetavern.tavern.getLeaderboard/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:vxwgn77hp5ikvbiggm5es3rv/gg.infinitetavern.tavern.getLeaderboard/examples)

## Definitions

### `gg.infinitetavern.tavern.getLeaderboard`

**Type**: `query`

View the tavern's leaderboard — the top-ranked adventurers for a given campaign season, ordered by rating.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `seasonNumber` | `integer` | No | The campaign season to query. Defaults to season 1. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `results` | `array` | Yes |  |
| `seasonNumber` | `integer` | Yes | The season these rankings are for. |

### `gg.infinitetavern.tavern.getLeaderboard#leaderboardEntry`

**Type**: `object`

An adventurer's ranking on the season leaderboard.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `rank` | `integer` | Yes | Position on the leaderboard. |
| `wins` | `integer` | Yes |  |
| `handle` | `string` | No |  |
| `lastMmr` | `number` | Yes | Most recent tavern rating. |
| `gamesPlayed` | `integer` | Yes |  |
| `avgPlacement` | `number` | Yes | Average placement across all battles this season. |

## Raw Schema

```json
{
  "id": "gg.infinitetavern.tavern.getLeaderboard",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "seasonNumber",
            "results"
          ],
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "ref": "#leaderboardEntry",
                "type": "ref"
              }
            },
            "seasonNumber": {
              "type": "integer",
              "description": "The season these rankings are for."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 20,
            "maximum": 100,
            "minimum": 1
          },
          "seasonNumber": {
            "type": "integer",
            "default": 1,
            "minimum": 1,
            "description": "The campaign season to query. Defaults to season 1."
          }
        }
      },
      "description": "View the tavern's leaderboard — the top-ranked adventurers for a given campaign season, ordered by rating."
    },
    "leaderboardEntry": {
      "type": "object",
      "required": [
        "rank",
        "did",
        "gamesPlayed",
        "wins",
        "avgPlacement",
        "lastMmr"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "rank": {
          "type": "integer",
          "minimum": 1,
          "description": "Position on the leaderboard."
        },
        "wins": {
          "type": "integer",
          "minimum": 0
        },
        "handle": {
          "type": "string"
        },
        "lastMmr": {
          "type": "number",
          "description": "Most recent tavern rating."
        },
        "gamesPlayed": {
          "type": "integer",
          "minimum": 1
        },
        "avgPlacement": {
          "type": "number",
          "description": "Average placement across all battles this season."
        }
      },
      "description": "An adventurer's ranking on the season leaderboard."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
