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

# Volume footprint

> Taker buy and sell size and counts for each bar and price level.



## OpenAPI

````yaml /data-api/openapi.json get /v1/markets/{coin}/footprint
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}/footprint:
    get:
      tags:
        - 'Markets: trades and flow'
      summary: Volume footprint
      description: >-
        Taker buy and sell size and counts for each bar and price level.


        **Filters**

        - `row_size` is optional and buckets prices.

        - `tier` keeps only fills of at least 10k USD or at least 100k USD.


        **Limits**

        - A page returns at most 20,000 cells. `limit` is the number of bars per
        page, and a page ends on a whole bar.

        - A page reads at most 1 day for bars shorter than `1h`, 7 days for `1h`
        and `4h`, and 30 days for `1d`, and the cursor continues.

        - Available on Growth plans and above.


        **Notes**

        - Bars reach the current minute, live from Hyperdash's nodes. `final` is
        false until the bar is complete and certified.


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


        **Scope:** `markets:read`
      operationId: getFootprint
      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:
              - 1m
              - 5m
              - 15m
              - 30m
              - 1h
              - 4h
              - 1d
        - name: row_size
          in: query
          required: false
          description: >-
            Price bucket, for example `10` for 10 USD levels. Leave it out for
            exact prices.
          schema:
            type: string
        - name: tier
          in: query
          required: false
          description: Fill size filter.
          schema:
            type: string
            default: all
            enum:
              - all
              - 10k
              - 100k
        - name: limit
          in: query
          required: false
          description: Bars per page.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 60
        - name: start_time
          in: query
          required: false
          description: >-
            Start time in epoch milliseconds, inclusive. Defaults to 1 day
            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.
                        px:
                          type: string
                          description: Price level. Decimal string.
                        buy_sz:
                          type: string
                          description: Taker buy size. Decimal string.
                        sell_sz:
                          type: string
                          description: Taker sell size. Decimal string.
                        buy_n:
                          type: integer
                          description: Taker buys.
                        sell_n:
                          type: integer
                          description: Taker sells.
                        final:
                          type: boolean
                          description: >-
                            Whether the bar is complete and settled. `false`
                            means the forming bar, or minutes not yet certified,
                            and values can still grow.
                    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/footprint?interval=1h&row_size=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.