> ## 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 points leaderboard

> Retrieve the Hz/Amps points leaderboard with rankings by total Hz or realized PnL.
Results are paginated and can be sorted by total_amps or realized_pnl.
Use the `search_term` parameter to filter by owner address prefix.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/points_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: 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: Predeposit Rewards
    description: Season 0 predeposit USDC rewards
  - name: Referrals
    description: Referral code management and tracking
paths:
  /api/v1/points_leaderboard:
    get:
      tags:
        - Analytics
      summary: Get points leaderboard
      description: >-
        Retrieve the Hz/Amps points leaderboard with rankings by total Hz or
        realized PnL.

        Results are paginated and can be sorted by total_amps or realized_pnl.

        Use the `search_term` parameter to filter by owner address prefix.
      operationId: handle_points_leaderboard
      parameters:
        - name: pagination
          in: query
          required: true
          schema:
            oneOf:
              - type: object
                properties:
                  limit:
                    type: integer
                    format: int32
                    maximum: 1000
                    minimum: 0
                  offset:
                    type: integer
                    format: int32
                    maximum: 10000
                    minimum: 0
            default: 100
          example: 10
        - name: sorting
          in: query
          required: true
          schema:
            type: object
            description: Generic sorting parameters
            properties:
              sort_dir:
                oneOf:
                  - type: 'null'
                  - $ref: d8982112-92c1-4e5e-aabb-2fe4d9a2c4d2
                    description: The direction of the sorting (ASC or DESC)
              sort_key:
                type: string
                enum:
                  - total_amps
                  - realized_pnl
          example: total_amps
        - name: search_term
          in: query
          description: Optional search term to filter by owner address prefix
          required: false
          schema:
            type: string
          example: '0x123'
        - name: tier
          in: query
          description: 'Optional tier filter: "top20", "diamond", "doublePlatinum", "gold"'
          required: false
          schema:
            $ref: 3a51ef53-9793-4cfe-8bd0-c3f51d23ae6c
          example: gold
      responses:
        '200':
          description: Paginated points leaderboard entries with rankings
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_PointsLeaderboardEntryDto
        '500':
          description: Database error
components:
  schemas:
    PaginatedResponse_PointsLeaderboardEntryDto:
      type: object
      required:
        - items
        - total_count
      properties:
        items:
          type: array
          items:
            type: object
            required:
              - rank
              - owner
              - total_amps
              - realized_pnl
              - referral_amps
              - vault_amps
            properties:
              owner:
                type: string
              rank:
                type: integer
                format: int32
                minimum: 0
              realized_pnl:
                type: number
                format: double
              referral_amps:
                type: number
                format: double
              total_amps:
                type: number
                format: double
              vault_amps:
                type: number
                format: double
          description: The items in the current page
        total_count:
          type: integer
          format: int32
          description: The total number of items across all pages
          minimum: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token from Geomi. See
        [Authentication](/api-reference/rest/authentication) for setup
        instructions.

````