CoinMetricsClient.catalog_market_implied_volatility_v2

coinmetrics.api_client.CoinMetricsClient.catalog_market_implied_volatility_v2(
    markets=None,
    exchange=None,
    market_type=None,
    base=None,
    quote=None,
    asset=None,
    symbol=None,
    format='json_stream',
    start_time=None,
    end_time=None,
    start_inclusive=None,
    end_inclusive=None,
    timezone=None,
    page_size=None,
    paging_from=None,
    next_page_token=None,
)

Returns a list of implied volatility for option market.

• Parameters:

  • markets (Optional *[*Union [str , List [str ] ] ]) -- Comma separated list of markets. By default all markets are returned.
  • exchange (Optional [str ]) -- Unique name of an exchange.
  • market_type (Optional [str ]) -- Type of markets.
  • base (Optional [str ]) -- Base asset of markets.
  • quote (Optional [str ]) -- Quote asset of markets.
  • asset (Optional [str ]) -- Any asset of markets.
  • symbol (Optional [str ]) -- Symbol of derivative markets, full instrument name.
  • format (Optional [str ]) -- Format of the response. Supported values are json, json_stream, csv. Default is json_stream. Setting format='json_stream' is generally more performant. page_size and paging_from is ignored when format='json_stream'.
  • start_time (Optional *[*Union *[*datetime , date , str ] ]) -- Start time of the interval.
  • end_time (Optional *[*Union *[*datetime , date , str ] ]) -- End time of the interval.
  • start_inclusive (Optional [bool ]) -- Whether to include the start time in the interval.
  • end_inclusive (Optional [bool ]) -- Whether to include the end time in the interval.
  • timezone (Optional [str ]) -- Timezone of the interval.
  • page_size (Optional [int ]) -- Number of items per single page of results.
  • paging_from (Optional [str ]) -- Where does the first page start, at the start of the interval or at the end.
  • next_page_token (Optional [str ]) -- Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

Returns:

• CatalogV2DataCollection

  • List of implied volatility statistics.