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

# README

GoCryptoTrader package Bitstamp

Build Status Software License GoDoc Coverage Status Go Report Card

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

Bitstamp 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() == "Bitstamp" {
		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
}

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

# Constants

Order side type.
Transaction types.
Transaction types.
Order side type.
Transaction types.
Transaction types.

# Structs

Balance stores the balance info.
Bitstamp is the overarching type across the bitstamp package.
CancelOrder holds the order cancellation info.
CaptureError is used to capture unmarshalled errors.
CryptoWithdrawalResponse response from a crypto withdrawal request.
DepositAddress holds the deposit info.
EURUSDConversionRate holds buy sell conversion rate information.
FIATWithdrawalResponse response from a fiat withdrawal request.
MakerTakerFees holds maker and taker fee information.
OHLCResponse holds returned candle data.
Order holds current open order data.
Orderbook holds orderbook information.
OrderbookBase holds singular price information.
OrderStatus holds order status information.
Ticker holds ticker information.
TradingFees holds trading fee information.
TradingPair holds trading pair information.
Transactions holds transaction data.
UnconfirmedBTCTransactions holds address information about unconfirmed transactions.
UserTransactions holds user transaction information.
WebsocketAuthResponse holds the auth token for subscribing to auth channels.
WithdrawalRequests holds request information on withdrawals.

# Type aliases

Balances holds full balance information with the supplied APIKEYS.