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

# Get leaderboard

> Retrieve the trading leaderboard with rankings based on trading performance metrics.
Results are paginated and can be sorted by account value, realized PnL, ROI, or trading volume.
Use the `search_term` parameter to filter accounts by address prefix.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/leaderboard
openapi: 3.1.0
info:
  title: Decibel Trading API
  description: >-
    RESTful API for Decibel. Provides read-only endpoints for market data,
    trading operations, positions, and analytics.
  contact:
    name: Decibel Team
    url: https://decibel.trade/
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.mainnet.aptoslabs.com/decibel
    description: Mainnet
  - url: https://api.testnet.aptoslabs.com/decibel
    description: Testnet
security:
  - bearerAuth: []
tags:
  - name: Market Data
    description: Market information and real-time data endpoints
  - name: User
    description: User information and account management
  - name: Account
    description: Account-specific endpoints and data
  - name: Trades
    description: Trading operations and history
  - name: Positions
    description: User position management
  - name: Orders
    description: Order management and history
  - name: TWAP
    description: Time-weighted average price orders
  - name: Bulk Orders
    description: Bulk order management
  - name: Vaults
    description: Vault operations and management
  - name: Analytics
    description: Analytics and performance metrics
  - name: Points
    description: Points-related account metrics
  - name: Trading Points
    description: Trading points endpoints
  - name: Trading Hz
    description: Trading Hz endpoints
  - name: Tier
    description: Tier information endpoints
  - name: Streaks
    description: User streak tracking endpoints
  - name: Predeposit Rewards
    description: Season 0 predeposit USDC rewards
  - name: Referrals
    description: Referral code management and tracking
  - name: Affiliates
    description: Affiliate code and earnings endpoints
  - name: Campaigns
    description: On-chain reward campaign endpoints
paths:
  /api/v1/leaderboard:
    get:
      tags:
        - Analytics
      summary: Get leaderboard
      description: >-
        Retrieve the trading leaderboard with rankings based on trading
        performance metrics.

        Results are paginated and can be sorted by account value, realized PnL,
        ROI, or trading volume.

        Use the `search_term` parameter to filter accounts by address prefix.
      operationId: handle_leaderboard
      parameters:
        - name: limit
          in: query
          description: Page size
          required: false
          schema:
            type: integer
            format: int32
            default: 10
            maximum: 1000
            minimum: 0
          example: 100
        - name: offset
          in: query
          description: Page offset
          required: false
          schema:
            type: integer
            format: int32
            default: 0
            maximum: 10000
            minimum: 0
          example: 0
        - name: sort_key
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/LeaderboardSortKey'
        - name: sort_dir
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SortDir'
        - name: search_term
          in: query
          description: Optional search term to filter accounts by address prefix
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Paginated leaderboard entries with rankings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_LeaderboardEntryDto'
        '500':
          description: Database error
components:
  schemas:
    LeaderboardSortKey:
      type: string
      enum:
        - account_value
        - realized_pnl
        - volume
        - roi
    SortDir:
      type: string
      enum:
        - ASC
        - DESC
    PaginatedResponse_LeaderboardEntryDto:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            type: object
            required:
              - rank
              - account
              - account_value
              - realized_pnl
              - roi
              - volume
            properties:
              account:
                type: string
              account_value:
                type: number
                format: double
              rank:
                type: integer
                format: int32
                minimum: 0
              realized_pnl:
                type: number
                format: double
              roi:
                type: number
                format: double
              volume:
                type: number
                format: double
          description: The items in the current page
        total_count:
          type:
            - integer
            - 'null'
          format: int32
          description: >-
            The total number of items across all pages.

            Optional: history endpoints omit this field to avoid expensive
            COUNT(*) queries.
          minimum: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token from Geomi. See
        [Authentication](/api-reference/rest/authentication) for setup
        instructions.

````