CCXT.OptionData (ccxt_client v0.6.1)

Unified options contract data.

Represents market data for an options contract. Named OptionData to avoid confusion with Elixir's concept of options.

Fields

currency - Settlement currency
symbol - Unified symbol
timestamp - Data timestamp in milliseconds
datetime - ISO 8601 datetime string
implied_volatility - Implied volatility
open_interest - Open interest
bid_price - Bid price
ask_price - Ask price
mid_price - Mid price
mark_price - Mark price
last_price - Last traded price
underlying_price - Underlying asset price
change - Price change
percentage - Percentage change
base_volume - Volume in base currency
quote_volume - Volume in quote currency
info - Raw exchange response

Summary

Types

t()

Functions

schema()

JSON Schema for the OptionData unified type.

Types

t()

@type t() :: %CCXT.OptionData{
  ask_price: number() | nil,
  base_volume: number() | nil,
  bid_price: number() | nil,
  change: number() | nil,
  currency: String.t() | nil,
  datetime: String.t() | nil,
  implied_volatility: number() | nil,
  info: map() | nil,
  last_price: number() | nil,
  mark_price: number() | nil,
  mid_price: number() | nil,
  open_interest: number() | nil,
  percentage: number() | nil,
  quote_volume: number() | nil,
  symbol: String.t() | nil,
  timestamp: integer() | nil,
  underlying_price: number() | nil
}

Functions

schema()

@spec schema() :: map()

JSON Schema for the OptionData unified type.