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

# Liquidation risk by BTC move

> Accounts ranked by how close a BTC move takes them to liquidation, or by equity, notional or leverage.



## OpenAPI

````yaml /data-api/openapi.json get /v1/accounts/liquidation-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/liquidation-risk:
    get:
      tags:
        - Accounts
      summary: Liquidation risk by BTC move
      description: >-
        Accounts ranked by how close a BTC move takes them to liquidation, or by
        equity, notional or leverage.


        **How it works**

        - Hyperdash's margin engine gives each account's exact margin inputs on
        every sweep, from Hyperdash's nodes.

        - Every coin is then projected through its 30, 60 and 90-day hourly beta
        to BTC, with positions and margin tiers held constant. Coins without
        usable history use 1.0.

        - The result is a statistical projection, not an engine-exact
        liquidation price.

        - A book liquidates when equity equals maintenance. For portfolio
        margin, maintenance is 0.95 times the liquidation value.


        **Fields**

        - Each row has the BTC move and BTC price that liquidate the account's
        closest cross book, its equity, notionals, cross leverage,
        BTC-equivalent exposure, maintenance and cushion.

        - The BTC move is a signed fraction: `-0.12` means BTC down 12%.

        - The move is `null` when no plausible move liquidates the account,
        meaning one outside -95% to +300%.

        - `meta` has `btc_mark`, `computed_at`, `input_at`, `stale` and the
        matching account count.

        - `computed_at` is the sweep time. `input_at` is the older of the newest
        node event and oracle update. `stale` marks input older than 60 seconds.


        **Coverage**

        - Accounts with at least 100k USD of equity or gross notional are
        covered.


        **Limits**

        - The response is one page: the top `limit` rows, at most your plan's
        wallet-list cap: Starter 100, Growth 500, Scale and Enterprise 1,000.


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


        **Scope:** `analytics:read`
      operationId: getAccountsLiquidationRisk
      parameters:
        - name: kind
          in: query
          required: false
          description: >-
            `cross` covers standard and unified accounts, which is every account
            that is not portfolio margin. `coin_margined` covers
            portfolio-margin accounts posting at least 1,000 USD of HYPE or BTC
            collateral. These match the XM and CM risk widgets on hyperdash.com.
          schema:
            type: string
            default: cross
            enum:
              - cross
              - coin_margined
        - name: min_equity
          in: query
          required: false
          description: >-
            Minimum account equity in USD: cross books plus isolated margin and
            value.
          schema:
            type: string
            default: '100000'
        - name: min_leverage
          in: query
          required: false
          description: >-
            Minimum cross leverage, which is cross notional divided by cross
            equity. Defaults to 3 for `cross`, because below 3x a plausible
            liquidation move is rare, and 0 for `coin_margined`.
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: >-
            `risk` puts the closest to liquidation first and accounts with no
            plausible move last. The other values sort largest first. Ties are
            ordered by address.
          schema:
            type: string
            default: risk
            enum:
              - risk
              - equity
              - notional
              - leverage
        - name: limit
          in: query
          required: false
          description: Accounts per page.
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
      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.
                        mode:
                          type: string
                          description: >-
                            Margin mode: `classic`, `unified` or
                            `portfolioMargin`.
                        coin_margined:
                          type: boolean
                          description: >-
                            Portfolio margin with at least 1,000 USD of HYPE or
                            BTC collateral.
                        equity:
                          type: string
                          description: Account equity, in USD. Decimal string.
                        cross_notional:
                          type: string
                          description: >-
                            Cross positions' gross notional, in USD. Decimal
                            string.
                        isolated_notional:
                          type: string
                          description: >-
                            Isolated positions' gross notional, in USD. Decimal
                            string.
                        cross_leverage:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Cross notional divided by cross equity. Decimal
                            string.
                        btc_delta:
                          type: string
                          description: >-
                            Sum of notional times beta over the cross books,
                            which is the BTC-equivalent exposure, in USD.
                            Collateral is not included. Decimal string.
                        maintenance_margin:
                          type: string
                          description: Cross maintenance margin, in USD. Decimal string.
                        cushion:
                          type: string
                          description: >-
                            Cross equity minus maintenance, in USD. Decimal
                            string.
                        collateral_hype_usd:
                          type: string
                          description: >-
                            Portfolio-margin HYPE collateral, in USD. Decimal
                            string.
                        collateral_btc_usd:
                          type: string
                          description: >-
                            Portfolio-margin BTC collateral, in USD. Decimal
                            string.
                        btc_move:
                          type:
                            - string
                            - 'null'
                          description: >-
                            BTC move that liquidates the closest cross book, as
                            a signed fraction. Decimal string.
                        btc_liquidation_px:
                          type:
                            - string
                            - 'null'
                          description: BTC price at that move. Decimal string.
                        approximate:
                          type: boolean
                          description: >-
                            Some positions had no mark or a margin not yet
                            certified, so the move is approximate.
                        margin_uncertain:
                          type:
                            - boolean
                            - 'null'
                          description: >-
                            Some positions' margin is not certified yet: opened
                            since the engine's last state snapshot (about every
                            12 minutes), sharing a pool with one, or in a pool
                            other than portfolio margin that a fill since then
                            left below its maintenance requirement. The
                            account's equity and books are then the engine's
                            assumption, and the account stays out of the ladder.
                            `null` when the positions server does not report it.
                    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/liquidation-risk?kind=cross&limit=50'
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.