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

# README

GoCryptoTrader package Bitmex

Build Status Software License GoDoc Coverage Status Go Report Card

This bitmex 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() == "Bitmex" {
		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.
StructValsToURLVals converts a struct into url.values for easy encoding can set json tags for outgoing naming conventions.

# Constants

ContractDownsideProfit downside profit contract type.
ContractFutures futures contract type.
ContractPerpetual perpetual contract type.
ContractUpsideProfit upside profit contract type.

# Structs

AffiliateStatus affiliate Status details.
Alias Name refers to Trollbox client name.
Announcement General Announcements.
AnnouncementData contains announcement resp data with action to be taken.
APIKey Persistent API Keys for Developers.
APIKeyParams contains all the parameters to send to the API endpoint.
Bitmex is the overarching type across this package.
Chat Trollbox Data.
ChatChannel chat channel.
ChatGetParams contains all the parameters to send to the API endpoint.
ChatSendParams contains all the parameters to send to the API endpoint.
ConfirmEmail confirmatin email endpoint data.
ConnectedUsers connected users.
Execution Raw Order and Balance Data.
Funding Swap Funding History.
GenericRequestParams contains all the parameters for some general functions.
IndexComposite index composite.
Instrument Tradeable Contracts, Indices, and History.
InstrumentInterval instrument interval.
Insurance stores insurance fund data.
Leaderboard Information on Top Users.
LeaderboardGetParams contains all the parameters to send to the API endpoint.
Liquidation Active Liquidations.
MinWithdrawalFee minimum withdrawal fee information.
Notification Account Notifications.
Order Placement, Cancellation, Amending, and History.
OrderAmendBulkParams contains all the parameters to send to the API endpoint.
OrderAmendParams contains all the parameters to send to the API endpoint for the order amend operation.
OrderBookData contains orderbook resp data with action to be taken.
OrderBookGetL2Params contains all the parameters to send to the API endpoint.
OrderBookL2 contains order book l2.
OrderCancelAllAfterParams contains all the parameters to send to the API endpoint.
OrderCancelAllParams contains all the parameters to send to the API endpoint for cancelling all your orders.
OrderCancelParams contains all the parameters to send to the API endpoint.
OrderClosePositionParams contains all the parameters to send to the API endpoint.
OrderInsertData holds order data from an order response.
OrderNewBulkParams contains all the parameters to send to the API endpoint.
OrderNewParams contains all the parameters to send to the API endpoint.
OrdersRequest used for GetOrderHistory.
Position Summary of Open and Closed Positions.
PositionGetParams contains all the parameters to send to the API endpoint.
PositionIsolateMarginParams contains all the parameters to send to the API endpoint.
PositionTransferIsolatedMarginParams contains all the parameters to send to the API endpoint.
PositionUpdateLeverageParams contains all the parameters to send to the API endpoint.
PositionUpdateRiskLimitParams contains all the parameters to send to the API endpoint.
Quote Best Bid/Offer Snapshots & Historical Bins.
QuoteGetBucketedParams contains all the parameters to send to the API endpoint.
RequestError allows for a general error capture from requests.
Settlement Historical Settlement Data.
Stats Exchange Statistics.
StatsHistory stats history.
StatsUSD contains summary of exchange stats.
Trade Individual & Bucketed Trades.
TradeData contains trade resp data with action to be taken.
TradeGetBucketedParams contains all the parameters to send to the API endpoint.
TransactionInfo Information.
User Account Operations.
UserCheckReferralCodeParams contains all the parameters to send to the API endpoint.
UserCommission user commission.
UserConfirmTFAParams contains all the parameters to send to the API endpoint.
UserCurrencyParams contains all the parameters to send to the API endpoint.
UserMargin margin information.
UserPreferences user preferences.
UserPreferencesParams contains all the parameters to send to the API endpoint.
UserRequestWithdrawalParams contains all the parameters to send to the API endpoint.
UserTokenParams contains all the parameters to send to the API endpoint.
UserUpdateParams contains all the parameters to send to the API endpoint.
WalletInfo wallet information.
WebsocketErrorResponse main error response.
WebsocketMainResponse main table defined response.
WebsocketRequest is the main request type.
WebsocketSubscribeResp is a response that occurs after a subscription.
WebsocketWelcome initial welcome type.
WsAffiliateResponse private api response.
WsAffiliateResponseAttributes private api data.
WsAffiliateResponseFilter private api data.
WsDataResponse contains common elements.
WsExecutionResponse private api response.
WsExecutionResponseAttributes private api data.
WsExecutionResponseFilter private api data.
WsExecutionResponseForeignKeys private api data.
WsMarginResponse private api response.
WsMarginResponseAttributes private api data.
WsMarginResponseData private api data.
WsMarginResponseFilter private api data.
WsOrderResponse private api response.
WsOrderResponseAttributes private api data.
WsOrderResponseFilter private api data.
WsOrderResponseForeignKeys private api data.
WsPositionResponse private api response.
WsPositionResponseAttributes private api data.
WsPositionResponseFilter private api data.
WsPositionResponseForeignKeys private api data.
WsPrivateNotificationsResponse private api response.
WsTransactResponse private api response.
WsTransactResponseAttributes private api data.
WsTransactResponseFilter private api data.
WsWalletResponse private api response.
WsWalletResponseAttributes private api data.
WsWalletResponseData private api data.
WsWalletResponseFilter private api data.

# Interfaces

Parameter just enforces a check on all outgoing data.