> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amberdata.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Volatility Index

> This endpoint returns the value of the BTC (or other altcoin) VIX. The methodology of this index is similar to the VIX but for the underlying crypto. Deribit developed their Bitcoin VIX called the DVOL index.



## OpenAPI

````yaml get /analytics/volatility/index
openapi: 3.1.0
info:
  title: derivatives-api
  version: '2'
servers:
  - url: https://api.amberdata.com/markets/derivatives
security:
  - sec0: []
paths:
  /analytics/volatility/index:
    get:
      summary: Volatility Index
      description: >-
        This endpoint returns the value of the BTC (or other altcoin) VIX. The
        methodology of this index is similar to the VIX but for the underlying
        crypto. Deribit developed their Bitcoin VIX called the DVOL index.
      operationId: derivatives-volatility-index
      parameters:
        - name: exchange
          in: query
          description: >-
            **[Required]**  The exchange for which to retrieve the volatility
            index. 

            **[Examples]** `deribit`
          required: true
          schema:
            type: string
            default: deribit
        - name: currency
          in: query
          description: >-
            **[Required]** The underlying currency for which to retrieve the
            volatility index. 

            **[Examples]** `BTC | SOL_USDC`  

            Note: inverse options have underlying currencies formatted as (BTC,
            ETH) while linear option currency formats include the stable coin in
            the same  (SOL_USDC)
          required: true
          schema:
            type: string
            default: BTC
        - name: startDate
          in: query
          description: >-
            **[Optional]** Payload only includes data after this date
            (inclusive). 

            **[Formats]** `seconds | milliseconds | iso8601`

            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: >-
            **[Optional]** Payload only includes data before this date
            (exclusive). 

            **[Formats]** `seconds | milliseconds | iso8601`

            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
            format: date-time
        - name: timeInterval
          in: query
          description: >-
            **[Optional]** Time interval of data frequency for the selected date
            range. 

            **[Examples]** `minute | hour | day` 
             **[Note]** Due to the density of data historical date ranges are limited to 60x 1-minute or 24x 1 hour intervals, per call.
          schema:
            type: string
        - name: timeFormat
          in: query
          description: >-
            **[Optional]** Time format of the timestamps in the return payload.

            **[Defaults]** `milliseconds | ms* | iso | iso8601 | hr |
            human_readable`
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  title:
                    type: string
                    example: OK
                  description:
                    type: string
                    example: Successful request
                  payload:
                    type: object
                    properties:
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            exchangeTimestamp:
                              type: string
                              example: '2024-05-01T00:00:00.000Z'
                              description: >-
                                The timestamp when the data was received from
                                the exchange
                            exchange:
                              type: string
                              example: deribit
                              description: >-
                                The exchange where the volatility index is
                                calculated
                            instrument:
                              type: string
                              example: DERIBIT_BTC_DVOL_INDEX
                              description: >-
                                The instrument identifier for the volatility
                                index
                            currency:
                              type: string
                              example: BTC
                              description: The underlying currency for the volatility index
                            open:
                              type: number
                              example: 59.81
                              description: The opening value of the volatility index
                            high:
                              type: number
                              example: 59.81
                              description: >-
                                The highest value of the volatility index during
                                the period
                            low:
                              type: number
                              example: 59.81
                              description: >-
                                The lowest value of the volatility index during
                                the period
                            close:
                              type: number
                              example: 59.81
                              description: The closing value of the volatility index
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      data:
                        - exchangeTimestamp: '2024-05-01T00:00:00.000Z'
                          exchange: deribit
                          instrument: DERIBIT_BTC_DVOL_INDEX
                          currency: BTC
                          open: 59.81
                          high: 59.81
                          low: 59.81
                          close: 59.81
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: {}
              schema:
                type: object
                properties: {}
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````