> ## 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.

# Largest outcome holders

> Largest holders of one HIP-4 outcome, per side.



## OpenAPI

````yaml /data-api/openapi.json get /v1/outcomes/{outcome}/holders
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/outcomes/{outcome}/holders:
    get:
      tags:
        - Outcomes
      summary: Largest outcome holders
      description: >-
        Largest holders of one HIP-4 outcome, per side. Each row has shares,
        cost basis, average entry, realized PnL, how the balance was established
        and, at the side's live mid, the notional and unrealized PnL.


        **How it works**

        - The default ranks by shares.

        - `sort=notional` ranks by notional, as Top Holders on hyperdash.com
        does. The site also merges the outcomes of one event.


        **Mid price**

        - A side's mid is its own live mid. When it has none, the mid is 1 minus
        the other side's, as on the site.

        - Without a mid, for example on a settled outcome, `mid_px`, `notional`
        and `unrealized_pnl` are null. Those rows rank by shares, after the
        priced ones.


        **Settled outcomes**

        - On a settled outcome, a row is the position held at settlement, which
        Hyperliquid then redeems, with what it cost.

        - `realized_pnl` includes the settlement result.


        **Notes**

        - Results are cached for up to 30 seconds.


        **Credits:** 720 per request + 1 per row + 5 per node read.


        **Scope:** `analytics:read`
      operationId: getOutcomeHolders
      parameters:
        - name: outcome
          in: path
          required: true
          description: Outcome id.
          schema:
            type: integer
            minimum: 0
            maximum: 1000000000000000
        - name: side
          in: query
          required: false
          description: '`0` is Yes and `1` is No. Leave it out for both.'
          schema:
            type: integer
            minimum: 0
            maximum: 1
        - name: sort
          in: query
          required: false
          description: 'Ranking: shares held, or notional at the live mid.'
          schema:
            type: string
            default: shares
            enum:
              - shares
              - notional
        - name: limit
          in: query
          required: false
          description: Rows to return, at most 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
      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.
                        side_index:
                          type: integer
                          description: '`0` is Yes and `1` is No.'
                        shares:
                          type: string
                          description: >-
                            Shares held. For a settled outcome, the shares held
                            at settlement. Decimal string.
                        cost_basis:
                          type: string
                          description: What the shares held cost, in USD. Decimal string.
                        avg_entry:
                          type: string
                          description: >-
                            Average entry: `cost_basis` divided by `shares`.
                            Decimal string.
                        realized_pnl:
                          type: string
                          description: >-
                            Realized PnL: closed PnL minus USDC fees. For a
                            settled outcome, the settlement result is included.
                            Decimal string.
                        fills:
                          type: integer
                          description: Fills.
                        last_fill_at:
                          type: integer
                          description: Last fill, in epoch milliseconds.
                        balance_status:
                          type:
                            - string
                            - 'null'
                          description: >-
                            `reconciled` for a Hyperliquid balance check under
                            30 minutes old plus later fills, `stale` for an
                            older check or `estimated` for no check, replayed
                            from fills with splits and merges included.
                        balance_checked_at:
                          type:
                            - integer
                            - 'null'
                          description: >-
                            Last balance check, in epoch milliseconds. `null`
                            when estimated.
                        mid_px:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The side's live mid, as a price per share, in USD.
                            Decimal string.
                        notional:
                          type:
                            - string
                            - 'null'
                          description: '`shares` times `mid_px`, in USD. Decimal string.'
                        unrealized_pnl:
                          type:
                            - string
                            - 'null'
                          description: >-
                            `mid_px` minus `avg_entry`, times `shares`, in USD.
                            Decimal string.
                        display_name:
                          type:
                            - string
                            - 'null'
                          description: Display name.
                        avatar:
                          type:
                            - string
                            - 'null'
                          description: Avatar image URL.
                        verified:
                          type:
                            - boolean
                            - 'null'
                          description: Verified profile.
                        share_fees:
                          type:
                            - string
                            - 'null'
                          description: Fees paid in outcome shares. Decimal string.
                        account_value:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Account value from the latest snapshot, in USD.
                            Decimal string.
                    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/outcomes/1234/holders'
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.