chart

Documentation

Index

• type Client
  • func (c Client) Get(params *Params) *Iter
• type Iter
  • func Get(params *Params) *Iter
  • func (i *Iter) Bar() *finance.ChartBar
  • func (i *Iter) Meta() finance.ChartMeta
• type Params

Types

type Client

type Client struct {
	B finance.Backend
}

Client is used to invoke chart APIs.

func (Client) Get

func (c Client) Get(params *Params) *Iter

Get returns a historical chart.

type Iter

type Iter struct {
	*iter.Iter
}

Iter is a structure containing results and related metadata for a yfin chart request.

func Get

func Get(params *Params) *Iter

Get returns a historical chart. and requires a params struct as an argument.

func (*Iter) Bar

func (i *Iter) Bar() *finance.ChartBar

Bar returns the next Bar visited by a call to Next.

func (*Iter) Meta

func (i *Iter) Meta() finance.ChartMeta

Meta returns the chart metadata related to a chart response.

type Params

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

	// Accessible fields.
	Symbol   string             `form:"-"`
	Start    *datetime.Datetime `form:"-"`
	End      *datetime.Datetime `form:"-"`
	Interval datetime.Interval  `form:"-"`

	IncludeExt bool `form:"includePrePost"`
	// contains filtered or unexported fields
}

Params carries a context and chart information.