> ## 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 of one wallet

> Perp account value, notional, margin used and withdrawable for one dex (core exchange by default), and the wallet's equity as hyperdash.com shows it (every perp dex + spot at mid + staked HYPE; unified and portfolio-margin accounts: spot + staked HYPE), with its spot and staking parts.

Pricing: flat + node reads. Scope: `accounts:read`.



## 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. 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 DEXs
  - name: Leaderboards
  - name: Lending
  - name: Liquidations
  - name: Markets
  - name: Network
  - name: Outcomes
  - name: Positions
  - name: Snapshots
  - name: Spot
  - name: Staking
  - name: Traders
paths:
  /v1/accounts/{address}:
    get:
      tags:
        - Accounts
      summary: Margin summary and equity of one wallet
      description: >-
        Perp account value, notional, margin used and withdrawable for one dex
        (core exchange by default), and the wallet's equity as hyperdash.com
        shows it (every perp dex + spot at mid + staked HYPE; unified and
        portfolio-margin accounts: spot + staked HYPE), with its spot and
        staking parts.


        Pricing: flat + node reads. Scope: `accounts:read`.
      operationId: getAccount
      parameters:
        - name: address
          in: path
          required: true
          description: Wallet, 0x + 40 hex.
          schema:
            type: string
            pattern: ^0x[0-9a-fA-F]{40}$
        - name: dex
          in: query
          required: false
          description: Builder dex (e.g. xyz). Omit for the core exchange.
          schema:
            type: string
            pattern: ^[a-z0-9]{1,16}$
        - name: X-Max-Credits
          in: header
          required: false
          description: Refuse (free) if the request could cost more.
          schema:
            type: integer
        - name: X-Credit-Price-Version
          in: header
          required: false
          description: Expected price version; 409 price_changed if it differs.
          schema:
            type: integer
      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 (USD): Hyperliquid's
                            marginSummary, perp margin only (no spot, other
                            dexes or staking; see equity) (decimal string; may
                            carry extra trailing zeros)
                        total_notional:
                          type: string
                          description: >-
                            Total position notional (decimal string; may carry
                            extra trailing zeros)
                        total_raw_usd:
                          type: string
                          description: >-
                            Raw USD balance (decimal string; may carry extra
                            trailing zeros)
                        total_margin_used:
                          type: string
                          description: >-
                            Margin used (decimal string; may carry extra
                            trailing zeros)
                        cross_account_value:
                          type: string
                          description: >-
                            Cross-margin account value (decimal string; may
                            carry extra trailing zeros)
                        cross_maintenance_margin_used:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Cross maintenance margin used (decimal string; may
                            carry extra trailing zeros)
                        withdrawable:
                          type: string
                          description: >-
                            Withdrawable (decimal string; may carry extra
                            trailing zeros)
                        positions:
                          type: integer
                          description: Open positions
                        as_of:
                          type: integer
                          description: Node state time (epoch ms)
                        role:
                          type:
                            - string
                            - 'null'
                          description: user, agent, vault, subAccount or missing
                        abstraction:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Account abstraction mode (disabled, unifiedAccount,
                            portfolioMargin, …)
                        equity:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Account equity (USD) as hyperdash.com shows it: perp
                            account value on every perp dex + spot balances at
                            their mids + staked HYPE. Unified and
                            portfolio-margin accounts: spot + staked HYPE only
                            (their perp margin is drawn from the spot balances).
                            Null when a price could not be read. (decimal
                            string; may carry extra trailing zeros)
                        spot_value:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Spot balances at their mids (USD): USDC = 1, other
                            tokens at their USDC pair's mid; tokens without a
                            market (e.g. outcome shares) count 0. (decimal
                            string; may carry extra trailing zeros)
                        staked_value:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Staked HYPE (delegated + undelegated + pending
                            withdrawals) at the HYPE mid (USD) (decimal string;
                            may carry extra trailing zeros)
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
        '400':
          description: Invalid parameter
          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
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Rate limited (Retry-After)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Backend at capacity (Retry-After)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
      x-codeSamples:
        - lang: curl
          source: >-
            curl -H 'Authorization: Bearer $HD_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: hdk_sk_live_v1_… or hdk_sk_test_v1_…

````

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