options

Documentation

Index

• type Client
  • func (c Client) GetStraddleP(params *Params) *StraddleIter
• type Params
• type StraddleIter
  • func GetStraddle(underlier string) *StraddleIter
  • func GetStraddleP(params *Params) *StraddleIter
  • func (si *StraddleIter) Meta() *finance.OptionsMeta
  • func (si *StraddleIter) Straddle() *finance.Straddle

Types

type Client

type Client struct {
	B finance.Backend
}

Client is used to invoke options APIs.

func (Client) GetStraddleP

func (c Client) GetStraddleP(params *Params) *StraddleIter

GetStraddleP returns options straddles. and requires a params struct as an argument.

type Params

type Params struct {
	// Context access.
	finance.Params `form:"-"`

	// Accessible fields.
	UnderlyingSymbol string             `form:"-"`
	Expiration       *datetime.Datetime `form:"-"`
	// contains filtered or unexported fields
}

Params carries a context and chart information.

type StraddleIter

type StraddleIter struct {
	*iter.Iter
}

StraddleIter is a structure containing results and related metadata for a yfin option straddles request.

func GetStraddle

func GetStraddle(underlier string) *StraddleIter

GetStraddle returns options straddles. and requires a underlier symbol as an argument.

func GetStraddleP

func GetStraddleP(params *Params) *StraddleIter

GetStraddleP returns options straddles. and requires a params struct as an argument.

func (*StraddleIter) Meta

func (si *StraddleIter) Meta() *finance.OptionsMeta

Meta returns the metadata associated with the options response.

func (*StraddleIter) Straddle

func (si *StraddleIter) Straddle() *finance.Straddle

Straddle returns the current straddle in the iter.