> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibechain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List the wallet leaderboard

> Results are cached for about five minutes. Unknown sort or time-period values fall back to `opened` and `alltime`.



## OpenAPI

````yaml /api-reference/vibemarket_openapi.yml get /leaderboard
openapi: 3.0.3
info:
  title: vibe.market API
  version: 1.0.0
  description: |
    Production API for vibe.market packs, games, collections, creator drafts,
    allowlists, market activity, social features, recovery tools, and analytics.

    Most operations require a caller-specific VibeChain API key in the
    `API-KEY` header. Account-bound writes additionally require a vibe.market
    session token in `Authorization: Bearer <token>`. Public or Bearer-only
    exceptions are marked on the individual operation.
  contact:
    name: VibeChain developer support
    email: gm@vibechain.com
    url: https://docs.vibechain.com/api-reference/vibemarket-intro
servers:
  - url: https://build.vibechain.com/vibe/boosterbox
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Packs
    description: Read pack ownership, state, rarity, and metadata.
  - name: Collections
    description: Read collection holdings, statistics, and activity.
  - name: Games
    description: Discover games and read launch configuration.
  - name: Metadata
    description: Read published metadata and update launched collections.
  - name: Creator drafts
    description: Create, autosave, inspect, confirm, and delete launch drafts.
  - name: Allowlists
    description: Configure draft allowlists and generate Merkle proofs.
  - name: Activity
    description: Read recent packs and recover indexed transaction events.
  - name: Social
    description: Read chat, react to messages, and report collections.
  - name: Analytics
    description: Read price history, leaderboards, and platform totals.
  - name: Utility
    description: Resolve slugs, regions, prices, and processing readiness.
paths:
  /leaderboard:
    get:
      tags:
        - Analytics
      summary: List the wallet leaderboard
      description: >-
        Results are cached for about five minutes. Unknown sort or time-period
        values fall back to `opened` and `alltime`.
      operationId: listVibeMarketLeaderboard
      parameters:
        - in: query
          name: sortBy
          schema:
            $ref: '#/components/schemas/LeaderboardMetric'
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - $ref: '#/components/parameters/Page'
        - in: query
          name: includeUserData
          schema:
            type: boolean
            default: false
        - in: query
          name: timePeriod
          schema:
            type: string
            enum:
              - 7days
              - alltime
            default: alltime
        - in: query
          name: currentAddress
          description: Include the current wallet's placement alongside the page.
          schema:
            $ref: '#/components/schemas/EvmAddress'
      responses:
        '200':
          description: Leaderboard page
          headers:
            Cache-Control:
              schema:
                type: string
              example: public, max-age=30, s-maxage=60, stale-while-revalidate=300
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeaderboardResponse'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '429':
          $ref: '#/components/responses/ApiKeyOrRateLimit'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    LeaderboardMetric:
      type: string
      enum:
        - opened
        - burned
        - sealed
        - legendary
        - epic
        - rare
        - common
        - mythic
        - total
        - volume
        - creatorFees
      default: opened
    EvmAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x1111111111111111111111111111111111111111'
    LeaderboardResponse:
      type: object
      required:
        - success
        - leaderboard
        - pagination
        - sortedBy
        - timePeriod
      properties:
        success:
          type: boolean
          enum:
            - true
        leaderboard:
          type: array
          items:
            $ref: '#/components/schemas/LeaderboardEntry'
        pagination:
          $ref: '#/components/schemas/Pagination'
        sortedBy:
          $ref: '#/components/schemas/LeaderboardMetric'
        timePeriod:
          type: string
          enum:
            - 7days
            - alltime
        currentAddress:
          $ref: '#/components/schemas/LeaderboardEntry'
    LeaderboardEntry:
      type: object
      required:
        - ownerAddress
      additionalProperties: true
      properties:
        ownerAddress:
          $ref: '#/components/schemas/EvmAddress'
        rank:
          type: integer
          minimum: 1
        totalBoxes:
          type: integer
          minimum: 0
        openedCount:
          type: integer
          minimum: 0
        burnedCount:
          type: integer
          minimum: 0
        sealedCount:
          type: integer
          minimum: 0
        legendaryCount:
          type: integer
          minimum: 0
        epicCount:
          type: integer
          minimum: 0
        rareCount:
          type: integer
          minimum: 0
        commonCount:
          type: integer
          minimum: 0
        mythicCount:
          type: integer
          minimum: 0
        notAssignedCount:
          type: integer
          minimum: 0
        volume:
          $ref: '#/components/schemas/Wei'
        creatorFees:
          $ref: '#/components/schemas/Wei'
        user:
          $ref: '#/components/schemas/UserSummary'
    Pagination:
      type: object
      required:
        - page
        - limit
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
        total:
          type: integer
          minimum: 0
        totalPages:
          type: integer
          minimum: 0
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          description: >-
            Optional diagnostic detail. Do not depend on this field being
            present in production.
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
    Wei:
      type: string
      pattern: ^[0-9]+$
      description: Unsigned integer amount denominated in Wei.
      example: '1000000000000000'
    UserSummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        username:
          type: string
        displayName:
          type: string
        profileImage:
          type: string
          format: uri
        address:
          $ref: '#/components/schemas/EvmAddress'
  parameters:
    Page:
      in: query
      name: page
      schema:
        type: integer
        minimum: 1
        default: 1
  responses:
    InvalidInput:
      description: Invalid or incomplete request input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid contract address
    ApiKeyOrRateLimit:
      description: API key missing/invalid or the caller's rate allowance is exhausted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: >-
              Too many requests or invalid API key! See docs.vibechain.com for
              more info.
    InternalError:
      description: The server could not complete the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Failed to complete request
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-KEY
      description: Caller-specific VibeChain API key used for quota and abuse control.

````