reference

Documentation

Index

• type OptionSymbol
  • func GoldenOptionSymbol() (symbols OptionSymbol)
• type Symbol
  • func GoldenSymbol() (symbols []Symbol)
  • func (s *Symbol) MarshalJSON() ([]byte, error)
  • func (s *Symbol) UnmarshalJSON(data []byte) (err error)
  • func (s *Symbol) Validate() error

Types

type OptionSymbol

type OptionSymbol map[string][]string

OptionSymbol represents one datum of that returned by the ref-data/options/symbols endpoint.

func GoldenOptionSymbol

func GoldenOptionSymbol() (symbols OptionSymbol)

GoldenOptionSymbol returns golden data for the OptionSymbol type

type Symbol

type Symbol struct {
	Symbol   string    `json:"symbol"`
	Name     string    `json:"name"`
	Exchange string    `json:"exchange"`
	IEXID    string    `json:"iexId"`
	Currency string    `json:"currency"`
	Date     time.Time `json:"-"`
	Type     string    `json:"type"`
	Enabled  bool      `json:"isEnabled"`
	Region   string    `json:"region"`
	FIGI     string    `json:"figi"`
	CIK      string    `json:"cik"`
}

Symbol represents one datum of that returned by the ref-data/symbols endpoint.

func GoldenSymbol

func GoldenSymbol() (symbols []Symbol)

GoldenSymbol returns golden data for the Symbol type

func (*Symbol) MarshalJSON

func (s *Symbol) MarshalJSON() ([]byte, error)

MarshalJSON satisfies the json.Unmarshaler interface. This function correctly translates the date field, which is specified as "YYYY-MM-DD", into a time.Time by using time.Parse().

func (*Symbol) UnmarshalJSON

func (s *Symbol) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON satisfies the json.Unmarshaler interface. This function correctly translates the date field, which is specified as "YYYY-MM-DD", into a time.Time by using time.Parse().

func (*Symbol) Validate

func (s *Symbol) Validate() error

Validate satisfies the Validator interface. It will return an error if the Symbol, IEXID, or Date fields are equal to their zero value.