kline

README

GoCryptoTrader Backtester: Kline package

This kline package is part of the GoCryptoTrader codebase.

This is still in active development

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

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

Kline package overview

The Kline event type is used to store the candle data of an individual data event. It can be utilised to understand market conditions at a point in time and make decisions from there

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:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

Documentation

Index

• type Event
• type Kline
  • func (k *Kline) GetClosePrice() decimal.Decimal
  • func (k *Kline) GetHighPrice() decimal.Decimal
  • func (k *Kline) GetLowPrice() decimal.Decimal
  • func (k *Kline) GetOpenPrice() decimal.Decimal
  • func (k *Kline) GetUnderlyingPair() currency.Pair
  • func (k *Kline) GetVolume() decimal.Decimal
  • func (k *Kline) IsKline() bool

Types

type Event

type Event interface {
	data.Event
	IsKline() bool
}

Event is a kline data event

type Kline

type Kline struct {
	*event.Base
	Open             decimal.Decimal
	Close            decimal.Decimal
	Low              decimal.Decimal
	High             decimal.Decimal
	Volume           decimal.Decimal
	ValidationIssues string
}

Kline holds kline data and an event to be processed as a common.Event type

func (*Kline) GetClosePrice

func (k *Kline) GetClosePrice() decimal.Decimal

GetClosePrice returns the closing price of a kline

func (*Kline) GetHighPrice

func (k *Kline) GetHighPrice() decimal.Decimal

GetHighPrice returns the high price of a kline

func (*Kline) GetLowPrice

func (k *Kline) GetLowPrice() decimal.Decimal

GetLowPrice returns the low price of a kline

func (*Kline) GetOpenPrice

func (k *Kline) GetOpenPrice() decimal.Decimal

GetOpenPrice returns the open price of a kline

func (*Kline) GetUnderlyingPair

func (k *Kline) GetUnderlyingPair() currency.Pair

GetUnderlyingPair returns the open price of a kline

func (*Kline) GetVolume

func (k *Kline) GetVolume() decimal.Decimal

GetVolume returns the volume of a kline

func (*Kline) IsKline

func (k *Kline) IsKline() bool

IsKline is a function to help distinguish between kline.Event and signal.Event as signal.Event implements kline.Event definitions otherwise this function is not called