cryptodataapi-com Volume Scanner API

openapi: 3.2.0
info:
  title: Crypto Data Volume Scanner API
  description: 'Real-time crypto market intelligence API. Built for AI agents: gasless USDC payments via x402 protocol, one-call onboarding, and 180+ endpoints for prices, derivatives, funding, and sentiment.'
  version: '2026-10-28'
servers:
- url: https://cryptodataapi.com
tags:
- name: Volume Scanner
paths:
  /api/v1/volume/scanner:
    get:
      tags:
      - Volume Scanner
      summary: Get Volume Scanner
      description: 'Every Hyperliquid perp with its 24h volume, 30-day average, and multiplier.


        ``multiplier`` = live rolling-24h notional ÷ mean daily notional over the last

        30 **settled** days (today''s partial day is excluded from the baseline). A

        reading of 3.0 means the coin is trading at three times its normal daily

        volume. ``multiplier_median`` is the same ratio against the 30-day median,

        which is far less distorted by a single prior blow-off day — compare the two

        when a coin''s recent history is lumpy.


        Perps listed less than 7 days ago have no honest baseline and report

        ``multiplier: null`` with ``band: "unknown"`` rather than a spurious number.


        Example screens: `?min_multiplier=3` (today''s unusual activity),

        `?band=dormant` (coins that have gone quiet), `?sort=volume_24h` (plain

        volume leaderboard).


        **Tiers:** Free returns the top 20 perps by 24h volume; Pro / Pro Plus return

        the full universe.'
      operationId: get_volume_scanner_api_v1_volume_scanner_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: band
        in: query
        required: false
        schema:
          description: Filter by activity band
          title: Band
          enum:
          - dormant
          - quiet
          - normal
          - elevated
          - surging
          - extreme
          - unknown
          - null
          type:
          - string
          - 'null'
        description: Filter by activity band
      - name: min_multiplier
        in: query
        required: false
        schema:
          description: Only perps trading at or above this multiple of their 30d average
          title: Min Multiplier
          type:
          - number
          - 'null'
          minimum: 0
        description: Only perps trading at or above this multiple of their 30d average
      - name: sort
        in: query
        required: false
        schema:
          enum:
          - multiplier
          - volume_24h
          - symbol
          - change_24h
          type: string
          default: multiplier
          title: Sort
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 250
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeScannerResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/volume/scanner/{symbol}:
    get:
      tags:
      - Volume Scanner
      summary: Get Volume Scanner Symbol
      description: 'One perp''s volume multiplier plus its 30-day daily notional series (**Pro**).


        Hyperliquid thousand-unit tickers (``kBONK``, ``kPEPE``, ``kSHIB``) are

        accepted as aliases of the plain symbol.'
      operationId: get_volume_scanner_symbol_api_v1_volume_scanner__symbol__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
        example: BTC
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeScannerDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    VolumeScannerDetailResponse:
      properties:
        symbol:
          type: string
          title: Symbol
        price:
          type: number
          title: Price
        change_24h:
          title: Change 24H
          type:
          - number
          - 'null'
        volume_change_24h:
          title: Volume Change 24H
          type:
          - number
          - 'null'
        spark_7d:
          items:
            type: number
          type: array
          title: Spark 7D
          default: []
        volume_24h:
          type: number
          title: Volume 24H
        avg_volume_30d:
          title: Avg Volume 30D
          type:
          - number
          - 'null'
        median_volume_30d:
          title: Median Volume 30D
          type:
          - number
          - 'null'
        multiplier:
          title: Multiplier
          type:
          - number
          - 'null'
        multiplier_median:
          title: Multiplier Median
          type:
          - number
          - 'null'
        open_interest_usd:
          type: number
          title: Open Interest Usd
          default: 0.0
        funding_rate:
          type: number
          title: Funding Rate
          default: 0.0
        days_of_history:
          type: integer
          title: Days Of History
          default: 0
        band:
          type: string
          enum:
          - dormant
          - quiet
          - normal
          - elevated
          - surging
          - extreme
          - unknown
          title: Band
          default: unknown
        as_of:
          type: string
          title: As Of
        history:
          items:
            $ref: '#/components/schemas/VolumeHistoryPoint'
          type: array
          title: History
          default: []
      type: object
      required:
      - symbol
      - price
      - volume_24h
      - as_of
      title: VolumeScannerDetailResponse
    VolumeHistoryPoint:
      properties:
        date:
          type: string
          title: Date
        notional:
          type: number
          title: Notional
      type: object
      required:
      - date
      - notional
      title: VolumeHistoryPoint
    VolumeScannerResponse:
      properties:
        as_of:
          type: string
          title: As Of
        items:
          items:
            $ref: '#/components/schemas/VolumeScannerItem'
          type: array
          title: Items
        count:
          type: integer
          title: Count
        universe_size:
          type: integer
          title: Universe Size
        rated_size:
          type: integer
          title: Rated Size
        total_volume_24h:
          type: number
          title: Total Volume 24H
        market_multiplier:
          title: Market Multiplier
          type:
          - number
          - 'null'
        surging_count:
          type: integer
          title: Surging Count
          default: 0
        window_days:
          type: integer
          title: Window Days
          default: 30
      type: object
      required:
      - as_of
      - items
      - count
      - universe_size
      - rated_size
      - total_volume_24h
      title: VolumeScannerResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    VolumeScannerItem:
      properties:
        symbol:
          type: string
          title: Symbol
        price:
          type: number
          title: Price
        change_24h:
          title: Change 24H
          type:
          - number
          - 'null'
        volume_change_24h:
          title: Volume Change 24H
          type:
          - number
          - 'null'
        spark_7d:
          items:
            type: number
          type: array
          title: Spark 7D
          default: []
        volume_24h:
          type: number
          title: Volume 24H
        avg_volume_30d:
          title: Avg Volume 30D
          type:
          - number
          - 'null'
        median_volume_30d:
          title: Median Volume 30D
          type:
          - number
          - 'null'
        multiplier:
          title: Multiplier
          type:
          - number
          - 'null'
        multiplier_median:
          title: Multiplier Median
          type:
          - number
          - 'null'
        open_interest_usd:
          type: number
          title: Open Interest Usd
          default: 0.0
        funding_rate:
          type: number
          title: Funding Rate
          default: 0.0
        days_of_history:
          type: integer
          title: Days Of History
          default: 0
        band:
          type: string
          enum:
          - dormant
          - quiet
          - normal
          - elevated
          - surging
          - extreme
          - unknown
          title: Band
          default: unknown
      type: object
      required:
      - symbol
      - price
      - volume_24h
      title: VolumeScannerItem
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key