> ## 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-price heatmap of one market

> Per bar and price band: size of long and short positions whose liquidation price falls in the band. Bands span 0 to 2 × mark; optional `min_px` / `max_px` keep only the bands that overlap that price range (hyperdash.com's heatmap view). `limit` bars per page; page with the cursor.

Pricing: base + per cell. Scope: `markets:read`.



## 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. 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/markets/{coin}/liquidation-heatmap:
    get:
      tags:
        - Markets
      summary: Liquidation-price heatmap of one market
      description: >-
        Per bar and price band: size of long and short positions whose
        liquidation price falls in the band. Bands span 0 to 2 × mark; optional
        `min_px` / `max_px` keep only the bands that overlap that price range
        (hyperdash.com's heatmap view). `limit` bars per page; page with the
        cursor.


        Pricing: base + per cell. Scope: `markets:read`.
      operationId: getLiquidationHeatmap
      parameters:
        - name: coin
          in: path
          required: true
          description: Market, e.g. BTC, xyz:TSLA.
          schema:
            type: string
            pattern: ^[A-Za-z0-9:_\-/@.]{1,40}$
        - 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
            pattern: ^\d{1,12}(\.\d{1,12})?$
        - name: max_px
          in: query
          required: false
          description: 'Upper price: bands starting above it are left out.'
          schema:
            type: string
            pattern: ^\d{1,12}(\.\d{1,12})?$
        - 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, epoch ms (inclusive). Default: end_time − 24 h.'
          schema:
            type: integer
        - name: end_time
          in: query
          required: false
          description: 'End, epoch ms. Default: now.'
          schema:
            type: integer
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from next_cursor (replaces the range).
          schema:
            type: string
        - 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:
                        t:
                          type: integer
                          description: Bar start, epoch ms
                        band_min:
                          type: string
                          description: >-
                            Band lower price (decimal string; may carry extra
                            trailing zeros)
                        band_max:
                          type: string
                          description: >-
                            Band upper price (decimal string; may carry extra
                            trailing zeros)
                        long_size:
                          type: string
                          description: >-
                            Long size liquidated in the band (decimal string;
                            may carry extra trailing zeros)
                        short_size:
                          type: string
                          description: >-
                            Short size liquidated in the band (decimal string;
                            may carry extra trailing zeros)
                        positions:
                          type: integer
                          description: Positions in the band
                        mark_px:
                          type: string
                          description: >-
                            Current mark (sets the band width) (decimal string;
                            may carry extra trailing zeros)
                        band_size:
                          type: string
                          description: >-
                            Band width (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/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: hdk_sk_live_v1_… or hdk_sk_test_v1_…

````

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