lakebtc

README

GoCryptoTrader package Lakebtc

This lakebtc package is part of the GoCryptoTrader codebase.

This is still in active development

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

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

LakeBTC Exchange

Current Features

• Initial generation

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:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB

Documentation

Index

• type AccountInfo
• type AuthenticatedTradeHistory
• type ExternalAccounts
• type LakeBTC
  • func (l *LakeBTC) CancelOrder(orderID int64) error
  • func (l *LakeBTC) CreateWithdraw(amount float64, accountID int64) (Withdraw, error)
  • func (l *LakeBTC) GetAccountInfo() (AccountInfo, error)
  • func (l *LakeBTC) GetExchangeAccountInfo() (exchange.AccountInfo, error)
  • func (l *LakeBTC) GetExchangeHistory(p pair.CurrencyPair, assetType string) ([]exchange.TradeHistory, error)
  • func (l *LakeBTC) GetExternalAccounts() ([]ExternalAccounts, error)
  • func (l *LakeBTC) GetFee(maker bool) float64
  • func (l *LakeBTC) GetOpenOrders() ([]OpenOrders, error)
  • func (l *LakeBTC) GetOrderBook(currency string) (Orderbook, error)
  • func (l *LakeBTC) GetOrderbookEx(p pair.CurrencyPair, assetType string) (orderbook.Base, error)
  • func (l *LakeBTC) GetOrders(orders []int64) ([]Orders, error)
  • func (l *LakeBTC) GetTicker() (map[string]Ticker, error)
  • func (l *LakeBTC) GetTickerPrice(p pair.CurrencyPair, assetType string) (ticker.Price, error)
  • func (l *LakeBTC) GetTradeHistory(currency string) ([]TradeHistory, error)
  • func (l *LakeBTC) GetTrades(timestamp int64) ([]AuthenticatedTradeHistory, error)
  • func (l *LakeBTC) Run()
  • func (l *LakeBTC) SendAuthenticatedHTTPRequest(method, params string, result interface{}) (err error)
  • func (l *LakeBTC) SendHTTPRequest(path string, result interface{}) error
  • func (l *LakeBTC) SetDefaults()
  • func (l *LakeBTC) Setup(exch config.ExchangeConfig)
  • func (l *LakeBTC) Start()
  • func (l *LakeBTC) Trade(orderType int, amount, price float64, currency string) (Trade, error)
  • func (l *LakeBTC) UpdateOrderbook(p pair.CurrencyPair, assetType string) (orderbook.Base, error)
  • func (l *LakeBTC) UpdateTicker(p pair.CurrencyPair, assetType string) (ticker.Price, error)
• type OpenOrders
• type Orderbook
• type OrderbookStructure
• type Orders
• type Ticker
• type TickerResponse
• type Trade
• type TradeHistory
• type Withdraw

Types

type AccountInfo

type AccountInfo struct {
	Balance map[string]string `json:"balance"`
	Locked  map[string]string `json:"locked"`
	Profile struct {
		Email             string `json:"email"`
		UID               string `json:"uid"`
		BTCDepositAddress string `json:"btc_deposit_addres"`
	} `json:"profile"`
}

AccountInfo contains account information

type AuthenticatedTradeHistory

type AuthenticatedTradeHistory struct {
	Type   string  `json:"type"`
	Symbol string  `json:"symbol"`
	Amount float64 `json:"amount,string"`
	Total  float64 `json:"total,string"`
	At     int64   `json:"at"`
}

AuthenticatedTradeHistory is a store of personalised auth trade history

type ExternalAccounts

type ExternalAccounts struct {
	ID         int64       `json:"id,string"`
	Type       string      `json:"type"`
	Address    string      `json:"address"`
	Alias      interface{} `json:"alias"`
	Currencies string      `json:"currencies"`
	State      string      `json:"state"`
	UpdatedAt  int64       `json:"updated_at,string"`
}

ExternalAccounts holds external account information

type LakeBTC

type LakeBTC struct {
	exchange.Base
	*request.Handler
}

LakeBTC is the overarching type across the LakeBTC package

func (*LakeBTC) CancelOrder

func (l *LakeBTC) CancelOrder(orderID int64) error

CancelOrder cancels an order by ID number and returns an error

func (*LakeBTC) CreateWithdraw

func (l *LakeBTC) CreateWithdraw(amount float64, accountID int64) (Withdraw, error)

CreateWithdraw allows your to withdraw to external account WARNING: Only for BTC!

func (*LakeBTC) GetAccountInfo

func (l *LakeBTC) GetAccountInfo() (AccountInfo, error)

GetAccountInfo returns your current account information

func (*LakeBTC) GetExchangeAccountInfo

func (l *LakeBTC) GetExchangeAccountInfo() (exchange.AccountInfo, error)

GetExchangeAccountInfo retrieves balances for all enabled currencies for the LakeBTC exchange

func (*LakeBTC) GetExchangeHistory

func (l *LakeBTC) GetExchangeHistory(p pair.CurrencyPair, assetType string) ([]exchange.TradeHistory, error)

GetExchangeHistory returns historic trade data since exchange opening.

func (*LakeBTC) GetExternalAccounts

func (l *LakeBTC) GetExternalAccounts() ([]ExternalAccounts, error)

GetExternalAccounts returns your external accounts WARNING: Only for BTC!

func (*LakeBTC) GetFee

func (l *LakeBTC) GetFee(maker bool) float64

GetFee returns maker or taker fee

func (*LakeBTC) GetOpenOrders

func (l *LakeBTC) GetOpenOrders() ([]OpenOrders, error)

GetOpenOrders returns all open orders associated with your account

func (*LakeBTC) GetOrderBook

func (l *LakeBTC) GetOrderBook(currency string) (Orderbook, error)

GetOrderBook returns the order book from LakeBTC

func (*LakeBTC) GetOrderbookEx

func (l *LakeBTC) GetOrderbookEx(p pair.CurrencyPair, assetType string) (orderbook.Base, error)

GetOrderbookEx returns orderbook base on the currency pair

func (*LakeBTC) GetOrders

func (l *LakeBTC) GetOrders(orders []int64) ([]Orders, error)

GetOrders returns your orders

func (*LakeBTC) GetTicker

func (l *LakeBTC) GetTicker() (map[string]Ticker, error)

GetTicker returns the current ticker from lakeBTC

func (*LakeBTC) GetTickerPrice

func (l *LakeBTC) GetTickerPrice(p pair.CurrencyPair, assetType string) (ticker.Price, error)

GetTickerPrice returns the ticker for a currency pair

func (*LakeBTC) GetTradeHistory

func (l *LakeBTC) GetTradeHistory(currency string) ([]TradeHistory, error)

GetTradeHistory returns the trade history for a given currency pair

func (*LakeBTC) GetTrades

func (l *LakeBTC) GetTrades(timestamp int64) ([]AuthenticatedTradeHistory, error)

GetTrades returns trades associated with your account by timestamp

func (*LakeBTC) Run

func (l *LakeBTC) Run()

Run implements the LakeBTC wrapper

func (*LakeBTC) SendAuthenticatedHTTPRequest

func (l *LakeBTC) SendAuthenticatedHTTPRequest(method, params string, result interface{}) (err error)

SendAuthenticatedHTTPRequest sends an autheticated HTTP request to a LakeBTC

func (*LakeBTC) SendHTTPRequest

func (l *LakeBTC) SendHTTPRequest(path string, result interface{}) error

SendHTTPRequest sends an unauthenticated http request

func (*LakeBTC) SetDefaults

func (l *LakeBTC) SetDefaults()

SetDefaults sets LakeBTC defaults

func (*LakeBTC) Setup

func (l *LakeBTC) Setup(exch config.ExchangeConfig)

Setup sets exchange configuration profile

func (*LakeBTC) Start

func (l *LakeBTC) Start()

Start starts the LakeBTC go routine

func (*LakeBTC) Trade

func (l *LakeBTC) Trade(orderType int, amount, price float64, currency string) (Trade, error)

Trade executes an order on the exchange and returns trade inforamtion or an error

func (*LakeBTC) UpdateOrderbook

func (l *LakeBTC) UpdateOrderbook(p pair.CurrencyPair, assetType string) (orderbook.Base, error)

UpdateOrderbook updates and returns the orderbook for a currency pair

func (*LakeBTC) UpdateTicker

func (l *LakeBTC) UpdateTicker(p pair.CurrencyPair, assetType string) (ticker.Price, error)

UpdateTicker updates and returns the ticker for a currency pair

type OpenOrders

type OpenOrders struct {
	ID     int64   `json:"id"`
	Amount float64 `json:"amount,string"`
	Price  float64 `json:"price,string"`
	Symbol string  `json:"symbol"`
	Type   string  `json:"type"`
	At     int64   `json:"at"`
}

OpenOrders stores full information on your open orders

type Orderbook

type Orderbook struct {
	Bids []OrderbookStructure `json:"bids"`
	Asks []OrderbookStructure `json:"asks"`
}

Orderbook contains arrays of orderbook information

type OrderbookStructure

type OrderbookStructure struct {
	Price  float64
	Amount float64
}

OrderbookStructure stores price and amount for order books

type Orders

type Orders struct {
	ID             int64   `json:"id"`
	OriginalAmount float64 `json:"original_amount,string"`
	Amount         float64 `json:"amount,string"`
	Price          float64 `json:"price,string"`
	Symbol         string  `json:"symbol"`
	Type           string  `json:"type"`
	State          string  `json:"state"`
	At             int64   `json:"at"`
}

Orders holds current order information

type Ticker

type Ticker struct {
	Last   float64
	Bid    float64
	Ask    float64
	High   float64
	Low    float64
	Volume float64
}

Ticker holds ticker information

type TickerResponse

type TickerResponse struct {
	Last   interface{}
	Bid    interface{}
	Ask    interface{}
	High   interface{}
	Low    interface{}
	Volume interface{}
}

TickerResponse stores temp response Silly hack due to API returning null instead of strings

type Trade

type Trade struct {
	ID     int64  `json:"id"`
	Result string `json:"result"`
}

Trade holds trade information

type TradeHistory

type TradeHistory struct {
	Date   int64   `json:"data"`
	Price  float64 `json:"price,string"`
	Amount float64 `json:"amount,string"`
	TID    int64   `json:"tid"`
}

TradeHistory holds trade history data

type Withdraw

type Withdraw struct {
	ID                int64   `json:"id,string"`
	Amount            float64 `json:"amount,string"`
	Currency          string  `json:"currency"`
	Fee               float64 `json:"fee,string"`
	State             string  `json:"state"`
	Source            string  `json:"source"`
	ExternalAccountID int64   `json:"external_account_id,string"`
	At                int64   `json:"at"`
}

Withdraw holds withdrawal information