symbols

Documentation

Index

• type APIClient
• type JSONFileManager
  • func NewJSONFileManager(hc *http.Client, stocksJSONURL, stocksJSONBasicAuth string) *JSONFileManager
  • func (m *JSONFileManager) GetAllSymbols() []string
  • func (m *JSONFileManager) UpdateSymbols()
• type Manager
• type ManagerImpl
  • func NewManager(apiClient APIClient, targetExchanges []configs.Exchange) *ManagerImpl
  • func (m *ManagerImpl) GetAllSymbols() []string
  • func (m *ManagerImpl) UpdateSymbols()
• type Stocks

Types

type APIClient

type APIClient interface {
	ListAssets(status *string) ([]v1.Asset, error)
}

type JSONFileManager

type JSONFileManager struct {
	// contains filtered or unexported fields
}

JSONFileManager is a symbol manager that reads a json file to get the list of symbols.

func NewJSONFileManager

func NewJSONFileManager(hc *http.Client, stocksJSONURL, stocksJSONBasicAuth string) *JSONFileManager

NewJSONFileManager initializes the SymbolManager object with the specified parameters.

func (*JSONFileManager) GetAllSymbols

func (m *JSONFileManager) GetAllSymbols() []string

GetAllSymbols returns symbols for all the target exchanges.

func (*JSONFileManager) UpdateSymbols

func (m *JSONFileManager) UpdateSymbols()

UpdateSymbols gets a remote json file, store the symbols in the file to the symbols map.

type Manager

type Manager interface {
	GetAllSymbols() []string
	UpdateSymbols()
}

Manager manages symbols in the target stock exchanges. symbol(s) can be newly registered / removed from the exchange, so target symbols should be updated periodically.

type ManagerImpl

type ManagerImpl struct {
	APIClient APIClient
	// Key: exchange(e.g. "NYSE")
	TargetExchanges map[configs.Exchange]struct{}
	Symbols         []string
}

ManagerImpl is an implementation of the Manager.

func NewManager

func NewManager(apiClient APIClient, targetExchanges []configs.Exchange) *ManagerImpl

NewManager initializes the SymbolManager object with the specified parameters.

func (*ManagerImpl) GetAllSymbols

func (m *ManagerImpl) GetAllSymbols() []string

GetAllSymbols returns Symbols for all the target exchanges.

func (*ManagerImpl) UpdateSymbols

func (m *ManagerImpl) UpdateSymbols()

UpdateSymbols calls the ListSymbols endpoint, convert the symbols to the Symbols and store them to the Symbols map.

type Stocks

type Stocks struct {
	Data map[string]interface{} `json:"data"`
}