ticker

README

GoCryptoTrader package Ticker

This ticker package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progresss on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for ticker

• This services the exchanges package by ticker functions.

• This package facilitates ticker generation.

• Attaches methods to an ticker

  • Returns a string of a value

• Gets a loaded ticker by exchange, asset type and currency pair.

• This package is primarily used in conjunction with but not limited to the exchange interface system set by exchange wrapper orderbook functions in "exchange"_wrapper.go.

Examples below:

tick, err := yobitExchange.GetTickerPrice()
if err != nil {
  // Handle error
}

// Converts ticker value to string
tickerValString := tick.PriceToString(...)

• or if you have a routine setting an exchange orderbook you can access it via the package itself.

tick, err := ticker.GetTicker(...)
if err != nil {
  // Handle error
}

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.
• Code must adhere to our coding style.
• Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB

Documentation

Index

• Constants
• Variables
• func BaseCurrencyExists(exchange string, currency currency.Code) bool
• func ProcessTicker(exchangeName string, tickerNew *Price, assetType string) error
• func QuoteCurrencyExists(exchange string, p currency.Pair) bool
• type Price
  • func GetTicker(exchange string, p currency.Pair, tickerType string) (Price, error)
• type Ticker
  • func CreateNewTicker(exchangeName string, tickerNew *Price, tickerType string) Ticker
  • func GetTickerByExchange(exchange string) (*Ticker, error)
  • func (t *Ticker) PriceToString(p currency.Pair, priceType, tickerType string) string

Constants

const (
	Spot = "SPOT"
)

const values for the ticker package

Variables

var (
	Tickers []Ticker
)

Vars for the ticker package

Functions

func BaseCurrencyExists

func BaseCurrencyExists(exchange string, currency currency.Code) bool

BaseCurrencyExists checks to see if the base currency of the ticker map exists

func ProcessTicker

func ProcessTicker(exchangeName string, tickerNew *Price, assetType string) error

ProcessTicker processes incoming tickers, creating or updating the Tickers list

func QuoteCurrencyExists

func QuoteCurrencyExists(exchange string, p currency.Pair) bool

QuoteCurrencyExists checks to see if the quote currency of the ticker map exists

Types

type Price

type Price struct {
	Pair        currency.Pair `json:"Pair"`
	Last        float64       `json:"Last"`
	High        float64       `json:"High"`
	Low         float64       `json:"Low"`
	Bid         float64       `json:"Bid"`
	Ask         float64       `json:"Ask"`
	Volume      float64       `json:"Volume"`
	PriceATH    float64       `json:"PriceATH"`
	LastUpdated time.Time
}

Price struct stores the currency pair and pricing information

func GetTicker

func GetTicker(exchange string, p currency.Pair, tickerType string) (Price, error)

GetTicker checks and returns a requested ticker if it exists

type Ticker

type Ticker struct {
	Price        map[string]map[string]map[string]Price
	ExchangeName string
}

Ticker struct holds the ticker information for a currency pair and type

func CreateNewTicker

func CreateNewTicker(exchangeName string, tickerNew *Price, tickerType string) Ticker

CreateNewTicker creates a new Ticker

func GetTickerByExchange

func GetTickerByExchange(exchange string) (*Ticker, error)

GetTickerByExchange returns an exchange Ticker

func (*Ticker) PriceToString

func (t *Ticker) PriceToString(p currency.Pair, priceType, tickerType string) string

PriceToString returns the string version of a stored price field