Bourse.Symbol.ParsedSymbol (bourse v0.1.0)

Copy Markdown View Source

Typed components of a unified extended symbol from Bourse.Symbol.parse_extended/1.

Fields mirror the Bourse unified derivative grammar:

BASE/QUOTE[:SETTLE[-EXPIRY[-STRIKE-OPTION_TYPE]]]

Spot pairs leave settle/expiry/strike/option_type as nil. Swap fills settle; futures add expiry; options add strike and option_type ("C"/"P").

Summary

Types

t()

@type t() :: %Bourse.Symbol.ParsedSymbol{
  base: String.t(),
  expiry: String.t() | nil,
  option_type: String.t() | nil,
  quote: String.t(),
  settle: String.t() | nil,
  strike: String.t() | nil
}