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

# Sentiment regime inputs

> One row per bucket for one market: log return, taker CVD and volume, realized volatility, funding (APR %), open-interest change and liquidations.



## OpenAPI

````yaml /data-api/openapi.json get /v1/markets/{coin}/sentiment
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}/sentiment:
    get:
      tags:
        - 'Markets: trades and flow'
      summary: Sentiment regime inputs
      description: >-
        One row per bucket for one market: log return, taker CVD and volume,
        realized volatility, funding (APR %), open-interest change and
        liquidations. Each input also has a z-score against the 30 days before
        the bucket.


        **How it works**

        - Only complete buckets are returned.

        - A bucket is scored when at least 95% of the prior month's buckets are
        complete.


        **Credits:** 25 per request + 1 per bucket.


        **Scope:** `analytics:read`
      operationId: getSentiment
      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: Bucket size.
          schema:
            type: string
            default: 1h
            enum:
              - 1h
              - 4h
              - 1d
        - name: limit
          in: query
          required: false
          description: Buckets per page.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 168
        - name: start_time
          in: query
          required: false
          description: >-
            Start time in epoch milliseconds, inclusive. Defaults to 7 days
            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.
                        close:
                          type:
                            - string
                            - 'null'
                          description: Close. Decimal string.
                        ret:
                          type: string
                          description: Log return. Decimal string.
                        cvd:
                          type: string
                          description: Taker CVD, in USD. Decimal string.
                        volume:
                          type: string
                          description: Taker volume, in USD. Decimal string.
                        rv:
                          type: string
                          description: >-
                            Realized volatility, annualized, in percent. Decimal
                            string.
                        funding:
                          type:
                            - string
                            - 'null'
                          description: Funding APR, in percent. Decimal string.
                        funding_start:
                          type:
                            - string
                            - 'null'
                          description: Funding APR at the bucket start. Decimal string.
                        funding_end:
                          type:
                            - string
                            - 'null'
                          description: Funding APR at the bucket end. Decimal string.
                        funding_base:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Lowest end-of-bucket funding over the prior day.
                            Decimal string.
                        oi_usd:
                          type:
                            - string
                            - 'null'
                          description: Open interest at the end, in USD. Decimal string.
                        oi_change_pct:
                          type:
                            - string
                            - 'null'
                          description: Open interest change, in percent. Decimal string.
                        rv_change:
                          type:
                            - string
                            - 'null'
                          description: Volatility change. Decimal string.
                        liq_long:
                          type: string
                          description: Longs liquidated, in USD. Decimal string.
                        liq_short:
                          type: string
                          description: Shorts liquidated, in USD. Decimal string.
                        liq_long_next:
                          type:
                            - string
                            - 'null'
                          description: Longs liquidated in the next bucket. Decimal string.
                        liq_short_next:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Shorts liquidated in the next bucket. Decimal
                            string.
                        z_ret:
                          type:
                            - string
                            - 'null'
                          description: Return z-score. Decimal string.
                        z_cvd:
                          type:
                            - string
                            - 'null'
                          description: CVD z-score. Decimal string.
                        z_funding:
                          type:
                            - string
                            - 'null'
                          description: Funding z-score. Decimal string.
                        z_oi:
                          type:
                            - string
                            - 'null'
                          description: OI change z-score. Decimal string.
                        z_vol:
                          type:
                            - string
                            - 'null'
                          description: Volatility z-score. Decimal string.
                        z_funding_base:
                          type:
                            - string
                            - 'null'
                          description: Funding base z-score. 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/sentiment?interval=4h'
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.