okcoin

README

GoCryptoTrader package Okcoin

This okcoin 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

OKCoin Exchange

Current Features

• REST Support
• Websocket Support

How to enable

• Enable via configuration

• Individual package example below:

  // Exchanges will be abstracted out in further updates and examples will be
  // supplied then

How to do REST public/private calls

• If enabled via "configuration".json file the exchange will be added to the IBotExchange array in the go var bot Bot and you will only be able to use the wrapper interface functions for accessing exchange data. View routines.go for an example of integration usage with GoCryptoTrader. Rudimentary example below:

main.go

var o exchange.IBotExchange

for i := range bot.Exchanges {
  if bot.Exchanges[i].GetName() == "OKCoin" {
    y = bot.Exchanges[i]
  }
}

// Public calls - wrapper functions

// Fetches current ticker information
tick, err := o.FetchTicker()
if err != nil {
  // Handle error
}

// Fetches current orderbook information
ob, err := o.FetchOrderbook()
if err != nil {
  // Handle error
}

// Private calls - wrapper functions - make sure your APIKEY and APISECRET are
// set and AuthenticatedAPISupport is set to true

// Fetches current account information
accountInfo, err := o.GetAccountInfo()
if err != nil {
  // Handle error
}

• If enabled via individually importing package, rudimentary example below:

// Public calls

// Fetches current ticker information
ticker, err := o.GetTicker()
if err != nil {
  // Handle error
}

// Fetches current orderbook information
ob, err := o.GetOrderBook()
if err != nil {
  // Handle error
}

// Private calls - make sure your APIKEY and APISECRET are set and
// AuthenticatedAPISupport is set to true

// GetUserInfo returns account info
accountInfo, err := o.GetUserInfo(...)
if err != nil {
  // Handle error
}

// Submits an order and the exchange and returns its tradeID
tradeID, err := o.Trade(...)
if err != nil {
  // Handle error
}

How to do Websocket public/private calls

  // Exchanges will be abstracted out in further updates and examples will be
  // supplied then

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 OKCoin
  • func (o *OKCoin) FetchTicker(p currency.Pair, assetType asset.Item) (tickerData *ticker.Price, err error)
  • func (o *OKCoin) FetchTradablePairs(asset asset.Item) ([]string, error)
  • func (o *OKCoin) GetDefaultConfig() (*config.ExchangeConfig, error)
  • func (o *OKCoin) GetHistoricCandles(pair currency.Pair, a asset.Item, start, end time.Time, ...) (kline.Item, error)
  • func (o *OKCoin) GetHistoricCandlesExtended(pair currency.Pair, a asset.Item, start, end time.Time, ...) (kline.Item, error)
  • func (b *OKCoin) GetOrderHistoryById(getOrdersRequest string) ([]order.Detail, error)
  • func (o *OKCoin) Run()
  • func (o *OKCoin) SetDefaults()
  • func (o *OKCoin) Start(wg *sync.WaitGroup)
  • func (o *OKCoin) UpdateTicker(p currency.Pair, assetType asset.Item) (*ticker.Price, error)
  • func (o *OKCoin) UpdateTradablePairs(forceUpdate bool) error

Types

type OKCoin

type OKCoin struct {
	okgroup.OKGroup
}

OKCoin bases all methods off okgroup implementation

func (*OKCoin) FetchTicker

func (o *OKCoin) FetchTicker(p currency.Pair, assetType asset.Item) (tickerData *ticker.Price, err error)

FetchTicker returns the ticker for a currency pair

func (*OKCoin) FetchTradablePairs

func (o *OKCoin) FetchTradablePairs(asset asset.Item) ([]string, error)

FetchTradablePairs returns a list of the exchanges tradable pairs

func (*OKCoin) GetDefaultConfig

func (o *OKCoin) GetDefaultConfig() (*config.ExchangeConfig, error)

GetDefaultConfig returns a default exchange config

func (*OKCoin) GetHistoricCandles

func (o *OKCoin) GetHistoricCandles(pair currency.Pair, a asset.Item, start, end time.Time, interval kline.Interval) (kline.Item, error)

GetHistoricCandles returns candles between a time period for a set time interval

func (*OKCoin) GetHistoricCandlesExtended

func (o *OKCoin) GetHistoricCandlesExtended(pair currency.Pair, a asset.Item, start, end time.Time, interval kline.Interval) (kline.Item, error)

GetHistoricCandlesExtended returns candles between a time period for a set time interval

func (*OKCoin) GetOrderHistoryById

func (b *OKCoin) GetOrderHistoryById(getOrdersRequest string) ([]order.Detail, error)

GetOrderHistoryById retrieves specified closed order information Can Limit response to specific order status

func (*OKCoin) Run

func (o *OKCoin) Run()

Run implements the OKEX wrapper

func (*OKCoin) SetDefaults

func (o *OKCoin) SetDefaults()

SetDefaults method assignes the default values for OKEX

func (*OKCoin) Start

func (o *OKCoin) Start(wg *sync.WaitGroup)

Start starts the OKGroup go routine

func (*OKCoin) UpdateTicker

func (o *OKCoin) UpdateTicker(p currency.Pair, assetType asset.Item) (*ticker.Price, error)

UpdateTicker updates and returns the ticker for a currency pair

func (*OKCoin) UpdateTradablePairs

func (o *OKCoin) UpdateTradablePairs(forceUpdate bool) error

UpdateTradablePairs updates the exchanges available pairs and stores them in the exchanges config