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

# Trader screener

> Ranked traders with their stats: PnL per window, trade counts, win rates, Sharpe and Sortino, drawdowns, GPR, copy scores, account value, open notional, unrealized PnL, profile and top assets.



## OpenAPI

````yaml /data-api/openapi.json get /v1/traders/screener
openapi: 3.1.0
info:
  title: Hyperdash Data API
  version: v1
  description: >-
    Hyperliquid data from Hyperdash's own nodes and stored datasets; requests
    never call Hyperliquid's public API. Every response reports the credits it
    cost.
servers:
  - url: https://data.hyperdash.com
security: []
tags:
  - name: Accounts
  - name: Async jobs
  - name: Builders
  - name: Cohorts
  - name: HIP-3 dexes
  - name: Leaderboards
  - name: Lending
  - name: Liquidations
  - name: Markets
  - name: 'Markets: analytics'
  - name: 'Markets: funding'
  - name: 'Markets: liquidation and stop levels'
  - name: 'Markets: open interest and positioning'
  - name: 'Markets: order book'
  - name: 'Markets: prices and candles'
  - name: 'Markets: queue priority'
  - name: 'Markets: trades and flow'
  - name: 'Markets: TWAPs'
  - name: Network
  - name: Outcomes
  - name: Positions
  - name: Referrals
  - name: Snapshots
  - name: Spot
  - name: Staking
  - name: Traders
  - name: Vaults
paths:
  /v1/traders/screener:
    get:
      tags:
        - Traders
      summary: Trader screener
      description: >-
        Ranked traders with their stats: PnL per window, trade counts, win
        rates, Sharpe and Sortino, drawdowns, GPR, copy scores, account value,
        open notional, unrealized PnL, profile and top assets.


        **Fields**

        - `rank` is the wallet's rank on the perp-PnL leaderboard of
        `timeframe`, which is the # column in Explore. It is for display only
        and does not change the order.

        - Explore's Win Rate column is `winrate_30d`. `winrate` is lifetime.


        **Filters**

        - Explore's filters are offered as fixed choices: smallest account
        value, smallest PnL in the timeframe, smallest copy score and style tag.

        - All filters are optional and are combined with AND.


        **Coverage**

        - Each sort and filter set returns the top 2,000 traders, paged.

        - Like Explore on hyperdash.com, it leaves out the 13 accounts the site
        excludes, for example the Assistance Fund.


        **Freshness**

        - Each wallet's stats row is rebuilt about once a day, at a
        wallet-specific time, every 24 to 26 hours.

        - Its 24-hour, 7-day and 30-day PnL windows end around that rebuild, not
        now, and rows of one page can be up to a day apart.

        - `updated_at` is when the row was computed. Some inputs, such as
        account value, can be older still.


        **Credits:** 870 per request + 1 per row.


        **Scope:** `analytics:read`
      operationId: traderScreener
      parameters:
        - name: sort
          in: query
          required: false
          description: >-
            Sort field. Defaults to `pnlPerpMonth`, the 30-day perp PnL, as on
            Explore traders on hyperdash.com.
          schema:
            type: string
            default: pnlPerpMonth
            enum:
              - pnlPerpDay
              - pnlPerpWeek
              - pnlPerpMonth
              - pnlPerpAllTime
              - winrate30d
              - winrate7d
              - winrateLifetime
              - totalTrades
              - accountValue
              - notional
              - sharpe30d
              - copyScore
              - copyScoreV2
              - maxDrawdownPerpWeek
              - maxDrawdownPerpMonth
        - name: order
          in: query
          required: false
          description: Sort order.
          schema:
            type: string
            default: desc
            enum:
              - desc
              - asc
        - name: timeframe
          in: query
          required: false
          description: >-
            Window of `rank` and of `min_pnl`. Defaults to the sort's window:
            `24h` for `pnlPerpDay`, `7d` for `pnlPerpWeek`, `30d` for
            `pnlPerpMonth` (so `30d` for the default sort) and `alltime` for
            `pnlPerpAllTime`. Any other sort defaults to `alltime`.
          schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - alltime
        - name: min_account_value
          in: query
          required: false
          description: >-
            Only traders with at least this account value, in USD. This is the
            equity filter on Explore.
          schema:
            type: string
            enum:
              - '1000'
              - '10000'
              - '100000'
              - '1000000'
              - '10000000'
        - name: min_pnl
          in: query
          required: false
          description: >-
            Only traders with at least this perp PnL in USD over the `timeframe`
            window: `pnl_day`, `pnl_week`, `pnl_month` or `pnl_alltime`. `0`
            means profitable.
          schema:
            type: string
            enum:
              - '0'
              - '10000'
              - '100000'
              - '1000000'
        - name: min_copy_score
          in: query
          required: false
          description: >-
            Only traders with at least this copy score (`copy_score_v2`). This
            is the copy-score filter on Explore.
          schema:
            type: string
            enum:
              - '50'
              - '70'
              - '90'
        - name: tag
          in: query
          required: false
          description: >-
            Only traders with this style tag. This is the trader-type filter on
            Explore.
          schema:
            type: string
            enum:
              - algo
              - scalp
              - intraday
              - swing
              - position
        - name: max_account_value
          in: query
          required: false
          description: Only traders with at most this account value, in USD.
          schema:
            type: string
            enum:
              - '10000'
              - '100000'
              - '1000000'
              - '10000000'
              - '100000000'
        - name: max_pnl
          in: query
          required: false
          description: >-
            Only traders with at most this perp PnL in USD over the `timeframe`
            window. `0` means unprofitable.
          schema:
            type: string
            enum:
              - '0'
              - '-1000'
              - '-10000'
              - '-100000'
              - '-1000000'
        - name: max_copy_score
          in: query
          required: false
          description: Only traders with at most this copy score (`copy_score_v2`).
          schema:
            type: string
            enum:
              - '30'
              - '50'
              - '70'
              - '90'
        - name: winrate_window
          in: query
          required: false
          description: >-
            Window of `min_winrate` and `max_winrate`: `winrate_7d`,
            `winrate_30d` or the lifetime win rate. Defaults to `winrate_30d`.
            The lifetime value covers wallets with at least one completed trade.
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - lifetime
        - name: min_winrate
          in: query
          required: false
          description: >-
            Only traders with at least this win rate in `winrate_window`, from 0
            to 1.
          schema:
            type: string
            enum:
              - '0.3'
              - '0.4'
              - '0.5'
              - '0.6'
              - '0.7'
              - '0.8'
              - '0.9'
        - name: max_winrate
          in: query
          required: false
          description: >-
            Only traders with at most this win rate in `winrate_window`, from 0
            to 1.
          schema:
            type: string
            enum:
              - '0.1'
              - '0.2'
              - '0.3'
              - '0.4'
              - '0.5'
              - '0.6'
        - name: min_sharpe
          in: query
          required: false
          description: Only traders with at least this 30-day Sharpe.
          schema:
            type: string
            enum:
              - '0'
              - '1'
              - '2'
              - '3'
              - '5'
        - name: max_sharpe
          in: query
          required: false
          description: Only traders with at most this 30-day Sharpe.
          schema:
            type: string
            enum:
              - '0'
              - '-1'
              - '-2'
        - name: drawdown_window
          in: query
          required: false
          description: 'Window of `max_drawdown`: `7d` or `30d`. Defaults to `30d`.'
          schema:
            type: string
            enum:
              - 7d
              - 30d
        - name: max_drawdown
          in: query
          required: false
          description: >-
            Only traders whose max drawdown in `drawdown_window` is at most
            this. It is a fraction of peak, from 0 to 1.
          schema:
            type: string
            enum:
              - '0.05'
              - '0.1'
              - '0.2'
              - '0.3'
              - '0.5'
        - name: trades_window
          in: query
          required: false
          description: >-
            Window of `min_trades` and `max_trades`: `7d`, `30d` or `total`.
            Defaults to `30d`.
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - total
        - name: min_trades
          in: query
          required: false
          description: Only traders with at least this many trades in `trades_window`.
          schema:
            type: string
            enum:
              - '1'
              - '10'
              - '50'
              - '100'
              - '500'
              - '1000'
        - name: max_trades
          in: query
          required: false
          description: Only traders with at most this many trades in `trades_window`.
          schema:
            type: string
            enum:
              - '10'
              - '50'
              - '100'
              - '500'
              - '1000'
        - name: verified
          in: query
          required: false
          description: Only verified profiles.
          schema:
            type: string
            enum:
              - 'true'
        - name: limit
          in: query
          required: false
          description: Rows to return, at most 1,000.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from `next_cursor`.
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            X-Credits-Charged:
              schema:
                type: integer
            X-Credit-Price-Version:
              schema:
                type: integer
            X-Request-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - has_more
                  - next_cursor
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        address:
                          type: string
                          description: Wallet.
                        rank:
                          type:
                            - integer
                            - 'null'
                          description: >-
                            Rank on the perp-PnL leaderboard of `timeframe`.
                            `null` when not ranked in that window.
                        pnl_day:
                          type: string
                          description: Perp PnL over 24 hours. Decimal string.
                        pnl_week:
                          type: string
                          description: Perp PnL over 7 days. Decimal string.
                        pnl_month:
                          type: string
                          description: Perp PnL over 30 days. Decimal string.
                        pnl_alltime:
                          type: string
                          description: Perp PnL, all time. Decimal string.
                        total_trades:
                          type: integer
                          description: Completed trades.
                        trades_7d:
                          type: integer
                          description: Trades over 7 days.
                        trades_30d:
                          type: integer
                          description: Trades over 30 days.
                        long_trades:
                          type: integer
                          description: Long trades.
                        short_trades:
                          type: integer
                          description: Short trades.
                        winning_trades:
                          type: integer
                          description: Winning trades.
                        losing_trades:
                          type: integer
                          description: Losing trades.
                        winrate:
                          type: string
                          description: >-
                            Lifetime win rate, over all completed trades.
                            Decimal string.
                        winrate_7d:
                          type:
                            - string
                            - 'null'
                          description: Win rate over 7 days. Decimal string.
                        winrate_30d:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Win rate over 30 days, as shown in the Win Rate
                            column of Explore on hyperdash.com. Decimal string.
                        winrate_90d:
                          type:
                            - string
                            - 'null'
                          description: Win rate over 90 days. Decimal string.
                        last_trade_at:
                          type:
                            - integer
                            - 'null'
                          description: Last trade, in epoch milliseconds.
                        last_fill_at:
                          type:
                            - integer
                            - 'null'
                          description: Last fill, in epoch milliseconds.
                        account_value:
                          type:
                            - string
                            - 'null'
                          description: Account value, in USD. Decimal string.
                        notional:
                          type:
                            - string
                            - 'null'
                          description: Open notional, in USD. Decimal string.
                        unrealized_pnl:
                          type:
                            - string
                            - 'null'
                          description: Unrealized PnL, in USD. Decimal string.
                        display_name:
                          type:
                            - string
                            - 'null'
                          description: Display name.
                        twitter:
                          type:
                            - string
                            - 'null'
                          description: Twitter handle.
                        tag:
                          type:
                            - string
                            - 'null'
                          description: Tag.
                        verified:
                          type: boolean
                          description: Verified profile.
                        label:
                          type:
                            - string
                            - 'null'
                          description: Label.
                        sharpe_7d:
                          type:
                            - string
                            - 'null'
                          description: Sharpe over 7 days. Decimal string.
                        sharpe_30d:
                          type:
                            - string
                            - 'null'
                          description: Sharpe over 30 days. Decimal string.
                        sortino_7d:
                          type:
                            - string
                            - 'null'
                          description: Sortino over 7 days. Decimal string.
                        sortino_30d:
                          type:
                            - string
                            - 'null'
                          description: Sortino over 30 days. Decimal string.
                        sortino_90d:
                          type:
                            - string
                            - 'null'
                          description: Sortino over 90 days. Decimal string.
                        max_drawdown_week:
                          type:
                            - string
                            - 'null'
                          description: Max drawdown over 7 days. Decimal string.
                        max_drawdown_month:
                          type:
                            - string
                            - 'null'
                          description: Max drawdown over 30 days. Decimal string.
                        max_drawdown_90d:
                          type:
                            - string
                            - 'null'
                          description: Max drawdown over 90 days. Decimal string.
                        gpr_7d:
                          type:
                            - string
                            - 'null'
                          description: Gain-to-pain over 7 days. Decimal string.
                        gpr_30d:
                          type:
                            - string
                            - 'null'
                          description: Gain-to-pain over 30 days. Decimal string.
                        gpr_90d:
                          type:
                            - string
                            - 'null'
                          description: Gain-to-pain over 90 days. Decimal string.
                        gpr_all_time:
                          type:
                            - string
                            - 'null'
                          description: Gain-to-pain, all time. Decimal string.
                        copy_score:
                          type:
                            - string
                            - 'null'
                          description: Copy score. Decimal string.
                        copy_score_v2:
                          type:
                            - string
                            - 'null'
                          description: Copy score v2. Decimal string.
                        top_assets:
                          type: string
                          description: Top assets, as JSON with `coin`, `volume` and `pnl`.
                        total_volume:
                          type:
                            - string
                            - 'null'
                          description: Volume, in USD. Decimal string.
                        updated_at:
                          type: integer
                          description: >-
                            When this wallet's stats row was computed, in epoch
                            milliseconds. Rows are computed about once a day per
                            wallet, and some inputs, such as account value, can
                            be older.
                        avatar:
                          type:
                            - string
                            - 'null'
                          description: Avatar image URL.
                    description: Result rows.
                  has_more:
                    type: boolean
                    description: '`true` when another page follows.'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Cursor for the next page, passed as `cursor`. `null` on
                      the last page.
                  meta:
                    type: object
                    description: >-
                      Response metadata. Its keys depend on the endpoint and are
                      described above.
        '400':
          description: 'Invalid parameter (also: a request body that is not valid JSON)'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: Invalid, expired or revoked key
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Scope, plan, history or credit limit
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: Price version changed, or a cursor's snapshot expired
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            Rate limited (Retry-After; free): request rate, concurrent requests
            (a request counts one slot per 1,000 rows it can return), or this
            server busy with your workspace's requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: Upstream data source failed (free; retry later)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Backend at capacity or temporarily unavailable (Retry-After)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: Upstream data source timed out (free; retry later)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
      x-codeSamples:
        - lang: curl
          source: >-
            curl -H "Authorization: Bearer $HYPERDASH_API_KEY"
            'https://data.hyperdash.com/v1/traders/screener?sort=sharpe30d&limit=100'
components:
  schemas:
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        hint:
          type: string
        request_id:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Your API key, sent as `Bearer hdk_sk_live_v1_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.