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

# README

GoCryptoTrader package Poloniex

Build Status Software License GoDoc Coverage Status Go Report Card

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

Poloniex 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 p exchange.IBotExchange

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

// Public calls - wrapper functions

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

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

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

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

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

// Cancels current account order
accountInfo, err := p.CancelOrder()
if err != nil {
	// Handle error
}

// Submits an order and the exchange and returns its tradeID
tradeID, err := p.PlaceOrder(...)
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

# Functions

GetRateLimit returns the rate limit for the exchange If your account's volume is over $5 million in 30 day volume, you may be eligible for an API rate limit increase.

# Variables

WithdrawalFees the large list of predefined withdrawal fees Prone to change, using highest value.

# Structs

ActiveLoans shows the full active loans on the exchange.
AuthenticatedTradeHistory holds client trade history information.
AuthenticatedTradeHistoryAll holds the full client trade history.
AuthenticatedTradeHistoryResponse is a response type for trade history.
Balance holds data for a range of currencies.
CancelOrdersResponse holds cancelled order info.
ChartData holds kline data.
CodeSummaryInfo defines currency information.
CompleteBalance contains the complete balance with a btcvalue.
Currencies contains currency information.
CurrencyDetails stores a map of currencies associated with their ID.
DepositAddresses holds the full address per crypto-currency.
DepositsWithdrawals holds withdrawal information.
Fee holds fees for specific trades.
GenericResponse is a response type for exchange generic responses.
LendingHistory holds the full lending history data.
LoanOffer holds loan offer information.
LoanOrder holds loan order information.
LoanOrders holds loan order information range.
Margin holds margin information.
MarginPosition holds margin positional information.
MoveOrderResponse is a response type for move order trades.
OpenOrdersResponse holds open response orders.
OpenOrdersResponseAll holds all open order responses.
Order hold order information.
Orderbook is a generic type golding orderbook information.
OrderbookAll contains the full range of orderbooks.
OrderbookItem holds data on an individual item.
OrderbookResponse is a sub-type for orderbooks.
OrderbookResponseAll holds the full response type orderbook.
OrderResponse is a response type of trades.
OrderStatus holds order status data.
OrderStatusData defines order status details.
OrderTrade holds order trade data.
PairSummaryInfo defines currency pair information.
Poloniex is the overarching type across the poloniex package.
ResultingTrades holds resultant trade information.
Ticker holds ticker data.
TimeStampResponse returns the time.
TradeHistory holds trade history data.
WalletActivityResponse holds wallet activity info.
WalletDeposits holds wallet deposit info.
WalletWithdrawals holds wallet withdrawal info.
WebsocketTicker holds ticker data for the websocket.
WebsocketTrollboxMessage holds trollbox messages and information for websocket.
Withdraw holds withdraw information.
WsOrderUpdateResponse Authenticated Ws Account data.
WsTicker defines the websocket ticker response.
WsTrade defines the websocket trade response.
WsTradeNotificationResponse Authenticated Ws Account data.

# Type aliases

CompleteBalances holds the full balance data.