exchange

Documentation

Index

• Constants
• func GetSessionAttributes(exchange types.Exchange) (isMargin, isFutures, isIsolated bool, isolatedSymbol string)
• func IsMaxExchange(exchange interface{}) bool
• func New(n types.ExchangeName, options ExchangeOptions) (types.ExchangeMinimal, error)
• func NewPublic(exchangeName types.ExchangeName) (types.Exchange, error)
• func NewWithEnvVarPrefix(n types.ExchangeName, varPrefix string) (types.ExchangeMinimal, error)
• func RegisterExchange(name types.ExchangeName, factory ExchangeFactory)
• type ExchangeConstructor
• type ExchangeEnvLoader
• type ExchangeFactory
• type ExchangeOptions
  • func DefaultEnvVarLoader(varPrefix string) (ExchangeOptions, error)

Constants

const (
	ExchangeOptionsKeyAPIKey        = "API_KEY"
	ExchangeOptionsKeyAPISecret     = "API_SECRET"
	ExchangeOptionsKeyAPIPassphrase = "API_PASSPHRASE"
)

Functions

func GetSessionAttributes

func GetSessionAttributes(exchange types.Exchange) (isMargin, isFutures, isIsolated bool, isolatedSymbol string)

func IsMaxExchange

func IsMaxExchange(exchange interface{}) bool

func New

func New(n types.ExchangeName, options ExchangeOptions) (types.ExchangeMinimal, error)

func NewPublic

func NewPublic(exchangeName types.ExchangeName) (types.Exchange, error)

func NewWithEnvVarPrefix

func NewWithEnvVarPrefix(n types.ExchangeName, varPrefix string) (types.ExchangeMinimal, error)

NewWithEnvVarPrefix allocate and initialize the exchange instance with the given environment variable prefix When the varPrefix is a empty string, the default exchange name will be used as the prefix

func RegisterExchange

func RegisterExchange(name types.ExchangeName, factory ExchangeFactory)

Types

type ExchangeConstructor

type ExchangeConstructor func(ExchangeOptions) (types.Exchange, error)

ExchangeConstructor is a function type to create an exchange instance with the given options

type ExchangeEnvLoader

type ExchangeEnvLoader func(varPrefix string) (ExchangeOptions, error)

ExchangeEnvLoader is a function type to load exchange options from environment variables According to pkg/bbgo/environment.go, we must to get the environment variable with %s-api-key so that we can add this custom exchange.

type ExchangeFactory

type ExchangeFactory struct {
	EnvLoader   ExchangeEnvLoader
	Constructor ExchangeConstructor
}

type ExchangeOptions

type ExchangeOptions map[string]string

ExchangeOptions is a map of exchange options used to initialize an exchange

func DefaultEnvVarLoader

func DefaultEnvVarLoader(varPrefix string) (ExchangeOptions, error)