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

# README

GoCryptoTrader package Bithumb

Build Status Software License GoDoc Coverage Status Go Report Card

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

Bithumb Exchange

Current Features

  • REST 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() == "Bithumb" {
		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.

# Variables

WithdrawalFees the large list of predefined withdrawal fees Prone to change.

# Structs

Account holds account details.
ActionStatus holds the return status.
Balance holds balance details.
Bithumb is the overarching type across the Bithumb package.
FullBalance defines a return type with full balance data.
KRWDeposit resp type for a KRW deposit.
LastTransactionTicker holds customer last transaction information.
MarketBuy holds market buy order information.
MarketSell holds market buy order information.
OHLCVResponse holds returned kline data.
Orderbook holds full range of order book information.
OrderData contains all individual order details.
OrderDetails contains specific order information.
OrderPlace contains order information.
Orders contains information about your current orders.
Status defines the current exchange allowance to deposit or withdraw a currency.
StatusAll defines the current exchange allowance to deposit or withdraw a currency.
Ticker holds ticker data.
TickerResponse holds the standard ticker response.
TickersResponse holds the standard ticker response.
TransactionHistory holds history of completed transaction data.
UserTransactions holds users full transaction list.
WalletAddressRes contains wallet address information.
WsOrderbook defines a singular orderbook tranche.
WsOrderbooks defines an amalgamated bid ask orderbook tranche list.
WsResponse is a generalised response data structure which will defer unmarshalling of different contents.
WsSubscribe is used to subscribe to the ws channel.
WsTicker defines a websocket ticker.
WsTransaction defines a trade that has executed via their matching engine.
WsTransactions defines a transaction list.