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

> Size of long and short positions whose liquidation price falls in each price band, per bar, from the hourly positions snapshots.



## OpenAPI

````yaml /data-api/openapi.json get /v1/markets/{coin}/liquidation-heatmap
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/markets/{coin}/liquidation-heatmap:
    get:
      tags:
        - 'Markets: liquidation and stop levels'
      summary: Liquidation heatmap
      description: >-
        Size of long and short positions whose liquidation price falls in each
        price band, per bar, from the hourly positions snapshots.


        **How it works**

        - A `1h` bar is its hour's snapshot.

        - A `4h` or `1d` bar is the last hourly snapshot inside it, its close.
        It is never a sum over the bar's hours.


        **Filters**

        - Optional `min_px` and `max_px` keep only the bands that overlap that
        price range, as in the heatmap view on hyperdash.com.


        **Coverage**

        - Positions worth 100 USD or less at their liquidation price (absolute
        size times liquidation price) are not in the snapshot.
        `meta.min_notional_usd` has the floor.

        - The live ladder `GET /v1/markets/{coin}/liquidation-levels` has no
        floor.


        **Notes**

        - Bands span 0 to 2 times the mark.


        **Credits:** 20 per request + 1 per cell.


        **Scope:** `markets:read`
      operationId: getLiquidationHeatmap
      parameters:
        - name: coin
          in: path
          required: true
          description: Market, for example `BTC` or `xyz:TSLA`.
          schema:
            type: string
        - name: interval
          in: query
          required: false
          description: Bar size.
          schema:
            type: string
            default: 1h
            enum:
              - 1h
              - 4h
              - 1d
        - name: min_px
          in: query
          required: false
          description: Lower price. Bands ending below it are left out.
          schema:
            type: string
        - name: max_px
          in: query
          required: false
          description: Upper price. Bands starting above it are left out.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Bars per page.
          schema:
            type: integer
            minimum: 1
            maximum: 6
            default: 4
        - name: start_time
          in: query
          required: false
          description: >-
            Start time in epoch milliseconds, inclusive. Defaults to 24 hours
            before `end_time`.
          schema:
            type: integer
        - name: end_time
          in: query
          required: false
          description: End time in epoch milliseconds. Defaults to now.
          schema:
            type: integer
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from `next_cursor`. It replaces the range.
          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:
                        t:
                          type: integer
                          description: Bar start, in epoch milliseconds.
                        band_min:
                          type: string
                          description: Band lower price. Decimal string.
                        band_max:
                          type: string
                          description: Band upper price. Decimal string.
                        long_size:
                          type: string
                          description: >-
                            Long size, in base units, whose liquidation price is
                            in the band, at the bar's last snapshot. Decimal
                            string.
                        short_size:
                          type: string
                          description: >-
                            Short size, in base units, whose liquidation price
                            is in the band, at the bar's last snapshot. Decimal
                            string.
                        positions:
                          type: integer
                          description: Positions in the band at the bar's last snapshot.
                        mark_px:
                          type: string
                          description: >-
                            Current mark, which sets the band width. Decimal
                            string.
                        band_size:
                          type: string
                          description: Band width. 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'
        '404':
          description: 'Not found: an unknown market, dex or token'
          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/markets/BTC/liquidation-heatmap?interval=1h'
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.