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

> One row per market, with the z-scores of its latest scored bucket in the window and aggregates over the window.



## OpenAPI

````yaml /data-api/openapi.json get /v1/markets/sentiment/scanner
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/sentiment/scanner:
    get:
      tags:
        - 'Markets: trades and flow'
      summary: Sentiment scanner
      description: >-
        One row per market, with the z-scores of its latest scored bucket in the
        window and aggregates over the window. With `view=index`, the response
        is one open-interest-weighted index over the selected markets instead.


        **How it works**

        - The latest scored bucket is taken from `start_time` up to but not
        including `end_time`. Each z-score is measured against the 30 days
        before that bucket.

        - A bucket is scored only with at least 95% of that month behind it.

        - Only whole buckets count: the start rounds up and the end rounds down.

        - The window is at most 7 days at `1h` and at most 30 days at `4h` or
        `1d`.


        **Fields**

        - `t` is the market's latest scored bucket, so it can differ between
        markets.

        - A z-score is null where it could not be computed.

        - Window aggregates cover the market's scored buckets: summed taker CVD
        and volume, RMS realized volatility in annualized %, price and
        open-interest change, the latest bucket's funding change and
        end-of-bucket funding in APR % and log return.

        - Price and open-interest change are ratios: 0.05 is +5%.

        - Index rows have no price, so `px_change` is null.


        **Filters**

        - `asset_class` uses the sentiment classes.

        - `majors`: BTC, ETH, SOL, HYPE, XRP, BNB and DOGE.

        - `alts`: other core-exchange markets.

        - `xyz`: trade.xyz.

        - `dex:<name>`: other HIP-3 dexes.


        **Credits:** 500 per request.


        **Scope:** `analytics:read`
      operationId: getSentimentScanner
      parameters:
        - name: interval
          in: query
          required: false
          description: Bucket size.
          schema:
            type: string
            default: 1h
            enum:
              - 1h
              - 4h
              - 1d
        - name: view
          in: query
          required: false
          description: >-
            `markets` returns one row per market. `index` returns one row: the
            open-interest-weighted index over the selected markets, which is all
            markets or one `asset_class`.
          schema:
            type: string
            default: markets
            enum:
              - markets
              - index
        - name: asset_class
          in: query
          required: false
          description: >-
            Only this sentiment class. With `view=index`, it is the index's
            class.
          schema:
            type: string
        - name: coins
          in: query
          required: false
          description: Comma-separated markets, up to 50. Works with `view=markets` only.
          schema:
            type: string
        - name: start_time
          in: query
          required: false
          description: >-
            Start time in epoch milliseconds. Defaults to 7 days before
            `end_time`. The range is at most 30 days.
          schema:
            type: integer
        - name: end_time
          in: query
          required: false
          description: End time in epoch milliseconds. Defaults to now.
          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:
                        market:
                          type: string
                          description: >-
                            Market, or the index label, which is `all` or the
                            `asset_class`.
                        t:
                          type: integer
                          description: Bar start, in epoch milliseconds.
                        z_ret:
                          type:
                            - string
                            - 'null'
                          description: Return z-score. Decimal string.
                        z_cvd:
                          type:
                            - string
                            - 'null'
                          description: Taker CVD z-score. Decimal string.
                        z_funding:
                          type:
                            - string
                            - 'null'
                          description: Funding z-score. Decimal string.
                        z_oi:
                          type:
                            - string
                            - 'null'
                          description: Open-interest change z-score. Decimal string.
                        z_vol:
                          type:
                            - string
                            - 'null'
                          description: Realized-volatility z-score. Decimal string.
                        z_funding_base:
                          type:
                            - string
                            - 'null'
                          description: Funding vs base z-score. Decimal string.
                        funding_change:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The latest bucket's funding change, as APR in
                            percent. Decimal string.
                        funding_end:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Funding at the latest bucket's end, as APR in
                            percent. Decimal string.
                        cvd:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Taker CVD summed over the window's scored buckets,
                            in USD. Decimal string.
                        volume:
                          type:
                            - string
                            - 'null'
                          description: Taker volume summed, in USD. Decimal string.
                        rv:
                          type:
                            - string
                            - 'null'
                          description: >-
                            RMS realized volatility, annualized, in percent.
                            Decimal string.
                        px_change:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Price change over the window, as a ratio. `null` for
                            an index. Decimal string.
                        oi_change:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Open-interest change over the window, as a ratio.
                            Decimal string.
                        last_return:
                          type:
                            - string
                            - 'null'
                          description: The latest bucket's log return. 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'
        '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/sentiment/scanner?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.