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

# Margin summary and equity

> Perp account value, notional, margin used and withdrawable for one dex, which is the core exchange by default.



## OpenAPI

````yaml /data-api/openapi.json get /v1/accounts/{address}
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/accounts/{address}:
    get:
      tags:
        - Accounts
      summary: Margin summary and equity
      description: >-
        Perp account value, notional, margin used and withdrawable for one dex,
        which is the core exchange by default. Also the wallet's equity, with
        its spot and staking parts.


        **Equity**

        - Equity is every perp dex plus spot at mid plus staked HYPE.

        - For unified and portfolio-margin accounts, equity is spot plus staked
        HYPE.

        - This is the equity hyperdash.com shows.


        **Credits:** 60 per request + 10 per node read.


        **Scope:** `accounts:read`
      operationId: getAccount
      parameters:
        - name: address
          in: path
          required: true
          description: 'Wallet address: `0x` followed by 40 hex characters.'
          schema:
            type: string
        - name: dex
          in: query
          required: false
          description: Builder dex, for example `xyz`. Leave it out for the core exchange.
          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:
                        account_value:
                          type: string
                          description: >-
                            Perp account value on this dex, in USD. This is
                            Hyperliquid's `marginSummary`, which is perp margin
                            only, with no spot, other dexes or staking. See
                            `equity`. Decimal string.
                        total_notional:
                          type: string
                          description: Total position notional. Decimal string.
                        total_raw_usd:
                          type: string
                          description: Raw USD balance. Decimal string.
                        total_margin_used:
                          type: string
                          description: Margin used. Decimal string.
                        cross_account_value:
                          type: string
                          description: Cross-margin account value. Decimal string.
                        cross_maintenance_margin_used:
                          type:
                            - string
                            - 'null'
                          description: Cross maintenance margin used. Decimal string.
                        withdrawable:
                          type: string
                          description: Withdrawable. Decimal string.
                        positions:
                          type: integer
                          description: Open positions.
                        as_of:
                          type: integer
                          description: Node state time, in epoch milliseconds.
                        role:
                          type:
                            - string
                            - 'null'
                          description: '`user`, `agent`, `vault`, `subAccount` or `missing`.'
                        master:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For a `subAccount`, the master wallet. `null`
                            otherwise.
                        agent_of:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For an `agent`, the wallet it trades for. `null`
                            otherwise.
                        abstraction:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Account abstraction mode, for example `disabled`,
                            `unifiedAccount` or `portfolioMargin`.
                        equity:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Account equity, in USD, as shown on hyperdash.com:
                            perp account value on every perp dex plus spot
                            balances at their mids plus staked HYPE. For unified
                            and portfolio-margin accounts, spot plus staked HYPE
                            only, because their perp margin is drawn from the
                            spot balances. `null` when a price could not be
                            read. Decimal string.
                        spot_value:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Spot balances at their mids, in USD. USDC is 1 and
                            other tokens are at their USDC pair's mid. Tokens
                            without a market, for example outcome shares, count
                            0. Decimal string.
                        staked_value:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Staked HYPE, which is delegated plus undelegated
                            plus pending withdrawals, at the HYPE mid, in USD.
                            Decimal string.
                        cross_total_notional:
                          type:
                            - string
                            - 'null'
                          description: Cross-margin position notional. Decimal string.
                        cross_total_raw_usd:
                          type:
                            - string
                            - 'null'
                          description: Cross-margin raw USD. Decimal string.
                        cross_total_margin_used:
                          type:
                            - string
                            - 'null'
                          description: Cross margin used. 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/accounts/0x…'
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.