exchange

package

v1.63.0 Latest Latest Go to latest Published: Jul 15, 2025 License: AGPL-3.0 Imports: 11 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/c9s/bbgo

Links

Open Source Insights

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 Options) (types.ExchangeMinimal, error)
func NewPublic(exchangeName types.ExchangeName) (types.Exchange, error)
func NewWithEnvVarPrefix(n types.ExchangeName, varPrefix string) (types.ExchangeMinimal, error)
func Register(name types.ExchangeName, factory Factory)
type Constructor
type EnvLoader
type Factory
type Options
- func DefaultEnvVarLoader(varPrefix string) (Options, error)

Constants ¶

View Source

const (
	OptionKeyAPIKey        = "API_KEY"
	OptionKeyAPISecret     = "API_SECRET"
	OptionKeyAPIPassphrase = "API_PASSPHRASE"
	OptionKeyAPIPrivateKey = "API_PRIVATE_KEy"
)

Variables ¶

This section is empty.

Functions ¶

func GetSessionAttributes ¶ added in v1.37.0

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

func IsMaxExchange ¶ added in v1.58.0

func IsMaxExchange(exchange interface{}) bool

func New ¶

func New(n types.ExchangeName, options Options) (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 Register ¶ added in v1.63.0

func Register(name types.ExchangeName, factory Factory)

Types ¶

type Constructor ¶ added in v1.63.0

type Constructor func(Options) (types.Exchange, error)

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

type EnvLoader ¶ added in v1.63.0

type EnvLoader func(varPrefix string) (Options, 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 Factory ¶ added in v1.63.0

type Factory struct {
	EnvLoader   EnvLoader
	Constructor Constructor
}

type Options ¶ added in v1.63.0

type Options map[string]string

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

func DefaultEnvVarLoader ¶ added in v1.62.0

func DefaultEnvVarLoader(varPrefix string) (Options, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
batch
binance
binanceapi
bitget
bitgetapi
bitgetapi/v2
bybit
bybitapi
bybitapi/v3
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
coinbase Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
api/v1
kucoin Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
kucoinapi
max Code generated by go:generate; DO NOT EDIT.	Code generated by go:generate; DO NOT EDIT.
maxapi
maxapi/v3
okex Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
okexapi
retry
sandbox

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL