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

> Margin risk of one account from Hyperdash's own margin engine, recomputed every sweep.



## OpenAPI

````yaml /data-api/openapi.json get /v1/accounts/{address}/risk
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}/risk:
    get:
      tags:
        - Accounts
      summary: Margin risk
      description: >-
        Margin risk of one account from Hyperdash's own margin engine,
        recomputed every sweep. It also gives the BTC move that liquidates the
        account.


        **Margin**

        - Each position row has the notional, mark and maintenance-margin
        requirement at its tier rate.

        - Rows are grouped by margin book: cross per dex, or isolated.

        - `meta` has equity and maintenance margin per book, margin mode,
        collateral and the sweep time.


        **BTC move**

        - Every coin is projected through its 30, 60 and 90-day hourly beta to
        BTC, with positions and margin tiers held constant. This is the
        account-risk view on hyperdash.com.

        - Each row has `beta`, `correlation` and `beta_fallback`.
        `beta_fallback` means the coin has no usable history and is projected
        1:1.

        - `meta.btc_move` is the closest cross book's move as a signed fraction:
        `-0.12` means BTC down 12%. It is `null` when there is no plausible move
        between -95% and +300%.

        - `meta.btc_liquidation_px` is also returned, and each book has
        `btc_move` and `btc_delta`. An isolated row's `btc_move` is its own move
        to its engine liquidation price.

        - This is a statistical projection from engine-exact inputs, not an
        engine-exact liquidation price.


        **Coverage**

        - Accounts with at least 100k USD of equity or gross notional are
        covered. Smaller accounts return no rows.

        - When the betas cannot be loaded, or the positions server lacks the
        projection inputs, the margin rows are still served. The BTC fields are
        `null` and `meta.btc_projection` is `false`.


        **Credits:** 10 per request.


        **Scope:** `accounts:read`
      operationId: getAccountRisk
      parameters:
        - name: address
          in: path
          required: true
          description: 'Wallet address: `0x` followed by 40 hex characters.'
          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:
                        book:
                          type: string
                          description: '`cross:<dex>` or `isolated`.'
                        dex:
                          type:
                            - integer
                            - 'null'
                          description: Dex index. `0` means the core exchange.
                        coin:
                          type: string
                          description: Market.
                        notional:
                          type: string
                          description: Signed notional, in USD. Decimal string.
                        mark_px:
                          type:
                            - string
                            - 'null'
                          description: Mark price. Decimal string.
                        maintenance_margin:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Maintenance margin requirement, in USD. Decimal
                            string.
                        mm_rate:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Maintenance margin rate of the position's tier.
                            Decimal string.
                        isolated_margin:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Isolated margin, for isolated positions. Decimal
                            string.
                        liquidation_px:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Engine liquidation price, for isolated positions.
                            Decimal string.
                        margin_uncertain:
                          type:
                            - boolean
                            - 'null'
                          description: >-
                            `true` when the position's margin is not certified
                            yet: it was opened since the engine's last state
                            snapshot (about every 12 minutes), it is a cross
                            position sharing its pool with one, or a fill since
                            then left a pool other than portfolio margin below
                            its maintenance requirement. Its cross or isolated
                            book and that book's equity are then the engine's
                            assumption, `liquidation_px` is `null`, and
                            `meta.approximate` and `meta.margin_uncertain` are
                            `true`. `null` when the positions server does not
                            report it.
                        beta:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Beta of the market to BTC, a 30, 60 and 90-day
                            hourly average. `1` when `beta_fallback` is `true`.
                            `null` when `meta.btc_projection` is `false`.
                            Decimal string.
                        correlation:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Correlation with BTC, over the same windows. Decimal
                            string.
                        beta_fallback:
                          type:
                            - boolean
                            - 'null'
                          description: >-
                            No usable price history, so it is projected 1:1 with
                            BTC.
                        btc_move:
                          type:
                            - string
                            - 'null'
                          description: >-
                            For isolated positions, the BTC move that reaches
                            the liquidation price, as a signed fraction. `null`
                            for cross rows. See `meta`. 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…/risk'
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.