coinex

README

coinex

The futures coin api。This package only implement fetures exchange of crypto coin. If you want a more common package, see gocryptotrader

Exchange Support

Exchange	REST API	Streaming API
Bitmex	Yes	Yes
OKex	No	No

Cheers to

Bitmex Websocket refer to gocryptotrader

Bitmex RESTful API use go-swagger

Bitmex Auth refer to ccxt

Documentation

Index

• Constants
• Variables
• type BaseExchanger
• type Config
  • func LoadConfigFile(cfg string) (configs Config, err error)
  • func LoadConfigs() (configs Config, err error)
  • func LoadViperConfig(cfg *viper.Viper) (configs Config, err error)
  • func (c *Config) Get(name string) (key, secret string)
  • func (c *Config) GetConfig(name string) (key, secret, passphrase string)
• type ConfigItem
• type Contract
  • func (c Contract) String() string
• type DataDownload
  • func NewDataDownload(start, end time.Time, binDuration time.Duration, paramFunc NewParamFunc, ...) (d *DataDownload)
  • func (d *DataDownload) Error() error
  • func (d *DataDownload) IsFinish() (bFinish bool)
  • func (d *DataDownload) Run(errChan chan error)
  • func (d *DataDownload) SetFinish(nFinish int32)
  • func (d *DataDownload) SetMaxRetry(maxRetry int)
  • func (d *DataDownload) Start(err chan error) (dataCh chan []interface{})
• type DownFunc
• type DownParam
• type Downloader
• type FuturesBaseExchanger
• type FuturesExchanger
• type NewParamFunc
• type Position

Constants

const (
	Long  = 1
	Short = 2
)

Variables

var (
	ErrNotImpl = errors.New("not implement")
)

Types

type BaseExchanger

type BaseExchanger interface {
	Buy(price float64, amount float64) (*Order, error)
	Sell(price float64, amount float64) (*Order, error)
}

type Config

type Config struct {
	Exchanges map[string]ConfigItem
	Proxy     string
}

func LoadConfigFile

func LoadConfigFile(cfg string) (configs Config, err error)

func LoadConfigs

func LoadConfigs() (configs Config, err error)

func LoadViperConfig

func LoadViperConfig(cfg *viper.Viper) (configs Config, err error)

func (*Config) Get

func (c *Config) Get(name string) (key, secret string)

func (*Config) GetConfig

func (c *Config) GetConfig(name string) (key, secret, passphrase string)

type ConfigItem

type ConfigItem struct {
	Type       string
	Key        string
	Secret     string
	Passphrase string
}

type Contract

type Contract struct {
	Symbol string
	Name   string
	Expiry time.Time
}

func (Contract) String

func (c Contract) String() string

type DataDownload

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

func NewDataDownload

func NewDataDownload(start, end time.Time, binDuration time.Duration, paramFunc NewParamFunc, downFunc DownFunc, onceCount int32, nDuration time.Duration, nLimit int) (d *DataDownload)

func (*DataDownload) Error

func (d *DataDownload) Error() error

func (*DataDownload) IsFinish

func (d *DataDownload) IsFinish() (bFinish bool)

func (*DataDownload) Run

func (d *DataDownload) Run(errChan chan error)

func (*DataDownload) SetFinish

func (d *DataDownload) SetFinish(nFinish int32)

func (*DataDownload) SetMaxRetry

func (d *DataDownload) SetMaxRetry(maxRetry int)

func (*DataDownload) Start

func (d *DataDownload) Start(err chan error) (dataCh chan []interface{})

type DownFunc

type DownFunc func(DownParam) ([]interface{}, bool, error)

type DownParam

type DownParam interface {
	SetStart(start *int32)
	SetCount(count *int32)
	SetStartTime(startTime *time.Time)
	SetEndTime(endTime *time.Time)
}

type Downloader

type Downloader interface {
	Start() chan []interface{}
	Error() error
}

type FuturesBaseExchanger

type FuturesBaseExchanger interface {
	BaseExchanger
	OpenLong(price float64, amount float64) (*Order, error)
	CloseLong(price float64, amount float64) (*Order, error)
	OpenShort(price float64, amount float64) (*Order, error)
	CloseShort(price float64, amount float64) (*Order, error)
	OpenLongMarket(amount float64) (*Order, error)
	CloseLongMarket(amount float64) (*Order, error)
	OpenShortMarket(amount float64) (*Order, error)
	CloseShortMarket(amount float64) (*Order, error)
}

type FuturesExchanger

type FuturesExchanger interface {
	FuturesBaseExchanger

	Contracts() ([]Contract, error)
	Positions() ([]Position, error)
	ContractBalances() (map[Contract]Balance, error)

	Depth(int) (Orderbook, error)
	Ticker() (Ticker, error)

	SetSymbol(symbol string) error
	SetContract(contract string) error
	SetLever(lever float64) error

	KlineRecent(count int32, binSize string) (klines []*Candle, err error)
	Kline(start, end time.Time, nLimit int, binSize string) (klines []*Candle, err error)
	KlineChan(start, end time.Time, bSize string) (data chan []interface{}, err chan error)
}

type NewParamFunc

type NewParamFunc func() DownParam

type Position

type Position struct {
	Info        Contract // 合约信息
	Type        int      // 合约类型，Long: 多头，Short: 空头
	Hold        float64  // 持有仓位
	Price       float64  //开仓价格
	ProfitRatio float64  // 盈利比例,正数表示盈利，负数表示亏岁
}