package
0.0.0-20250311023717-5c21e974eed8
Repository: https://github.com/thrasher-corp/gocryptotrader.git
Documentation: pkg.go.dev

# README

GoCryptoTrader package Btcmarkets

Build Status Software License GoDoc Coverage Status Go Report Card

This btcmarkets 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 our GoCryptoTrader Kanban board.

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

BTCMarkets Exchange

Current Features

  • REST Support
  • Websocket Support

How to enable

	// 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 b exchange.IBotExchange

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

// Public calls - wrapper functions

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

// Fetches current orderbook information
ob, err := b.UpdateOrderbook(...)
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 := b.GetAccountInfo()
if err != nil {
	// Handle error
}
  • If enabled via individually importing package, rudimentary example below:
// Public calls

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

// Fetches current orderbook information
ob, err := b.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 := b.GetUserInfo(...)
if err != nil {
	// Handle error
}

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

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

# Functions

GetRateLimit returns the rate limit for the exchange.

# Structs

AccountData stores account data.
AssetData stores data for given asset.
BatchCancelResponse stores the cancellation details from batch cancels.
BatchPlaceCancelResponse stores place and cancel batch data.
BatchPlaceData stores data for placed batch orders.
BatchTradeResponse stores the trades from batchtrades.
BTCMarkets is the overarching type across the BTCMarkets package.
CancelBatch stores data for batch cancel request.
CancelOrderMethod stores data for Cancel request.
CancelOrderResp stores data for cancelled orders.
CreateReportResp stores data for created report.
DepositAddress stores deposit address data.
Market holds a tradable market instrument.
MarketCandle stores candle data for a given pair.
OBData stores orderbook data.
Order holds order information.
Orderbook holds current orderbook information returned from the exchange.
OrderData stores data for new order created.
OrderToGo holds order information to be sent to the exchange.
PaymentDetails stores payment address.
PlaceBatch stores data for place batch request.
PlaceOrderMethod stores data for place request.
ReportData gets data for a created report.
Ticker holds ticker information.
TimeResp stores server time.
Trade holds trade information.
TradeHistoryData stores data of past trades.
TradeResponse holds trade information.
TradingFee 30 day trade volume.
TradingFeeData stores trading fee data.
TradingFeeResponse stores trading fee data.
TransactionData stores data from past transactions.
TransferData stores data from asset transfers.
UnprocessedBatchResp stores data for unprocessed response.
WithdrawalFeeData stores data for fees.
WithdrawRequestAUD is a generalized withdraw request type.
WithdrawRequestCrypto is a generalized withdraw request type.
WsError stores websocket error data.
WsFundTransfer stores fund transfer data for websocket.
WsMessageType message sent via ws to determine type.
WsOrderbook message received for orderbook data.
WsOrderChange stores order data.
WsSubscribe defines a subscription message used in the Subscribe function.
WsTick message received for ticker data.
WsTrade message received for trade data.
WsTradeData stores trade data for websocket.

# Type aliases

CandleResponse holds OHLCV data for exchange.
WebsocketOrderbook defines a specific websocket orderbook type to directly unmarshal json.