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

# README

GoCryptoTrader package Deribit

Build Status Software License GoDoc Coverage Status Go Report Card

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

Deribit 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 d exchange.IBotExchange

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

// Public calls - wrapper functions

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

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

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

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

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

Subscriptions

All default subscriptions are for all enabled assets.

Default Public Subscriptions:

  • Candles ( Timeframe: 1 day )
  • Orderbook ( Full depth @ Interval: 100ms )
  • Ticker ( Interval: 100ms )
  • All Trades ( Interval: 100ms )

Default Authenticated Subscriptions:

  • My Account Orders
  • My Account Trades

kline.Raw Interval configurable for a raw orderbook subscription when authenticated

Subscriptions are subject to enabled assets and pairs.

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

GetRateLimits returns the rate limit for the exchange.

# Structs

AccessLog represents access log information.
AccessLogDetail represents detailed access log information.
AccountSummaryData stores data of account summary for a given currency.
AffiliateProgramInfo stores info of affiliate program.
Announcement represents public announcements.
APIKeyData stores data regarding the api key.
BlockTradeData represents a user's block trade data.
BlockTradeMoveResponse represents block trade move response.
BlockTradeParam represents a block trade parameter.
BlockTradeResponse represents a block trade response.
BookSummaryData stores summary data.
CancelOnDisconnect holds scope and status information for cancel-on-disconnect.
CancelResp represents the detail of canceled order.
CancelWithdrawalData stores cancel request data for a withdrawal.
ComboDetail retrieves information about a combo.
ComboParam represents a parameter to sell and buy combo.
ContractSizeData stores contract size for given instrument.
CurrencyData stores data for currencies.
CustodyAccount retrieves user custody accounts list.
DeliveryPriceData stores index delivery_price.
DepositAddressData stores data of a deposit address.
DepositsData stores data of deposits.
Deribit is the overarching type across this package.
ErrInfo represents an error response messages.
FundingChartData stores futures funding chart data.
FundingRateHistory represents a funding rate history item.
HistoricalVolatilityData stores volatility data for requested symbols.
IndexDeliveryPrice store index delivery prices list.
IndexPrice holds index price for the instruments.
IndexPriceData gets index price data.
Info holds version information.
InitialMarginInfo represents an initial margin of an order.
InstrumentData gets data for instruments.
LockedCurrenciesStatus represents locked currencies status information.
MarginsData stores data for margin.
MarkPriceHistory stores data for mark price history.
MMPConfigData gets the current configuration data for MMP.
MultipleCancelResponse represents a response after cancelling multiple orders.
Orderbook stores orderbook data.
OrderBuyAndSellParams represents request parameters for submit order.
OrderData stores order data.
PortfolioMargin represents public portfolio margins.
PortfolioMarginState represents a portfolio margin state information.
PositionData stores data for account's position.
PrivateCancelData stores data of a private cancel.
PrivateSettlementData stores private settlement data.
PrivateSettlementsHistoryData stores data for private settlement history.
PrivateTradeData stores data of a private buy, sell or edit.
PublicTradesData stores data for public trades.
RefreshTokenInfo holds access token information.
RequestForQuote RFQs for instruments in given currency.
SettlementsData stores data for settlement futures.
SubAccountBalanceData represents the subaccount balance information for each currency.
SubAccountData stores subaccount data.
SubAccountDetail represents subaccount positions detail.
TickerData stores data for ticker.
TogglePortfolioMarginResponse represents a response from toggling portfolio margin for currency.
TradeData stores a data for a private trade.
TradeVolumesData stores data for trade volumes.
TransactionLogData stores information regarding an account transaction.
TransactionsData stores multiple transaction logs.
TransferData stores data for a transfer.
TransfersData stores list of transfer data.
TVChartData stores trading view chart data.
UnmarshalError is the struct which is used for unmarshalling errors.
UserLock represents a user lock information for currency.
UserTradeData stores data of user trades.
UserTradesData stores data of user trades.
VersionInformation represents websocket version information.
VolatilityIndexData stores index data for volatility.
VolatilityIndexRawData stores raw index data for volatility.
WebsocketPosition holds position information.
WithdrawalsData stores data of withdrawals.
WithdrawData stores data of withdrawal.
WsIncrementalTicker represents a ticker information for incremental ticker subscriptions.
WsMMPTrigger represents mmp trigger data.
WsOrder represents changes in user's orders for given instrument.
WsRequest defines a request obj for the JSON-RPC endpoints and gets a websocket response.
WsResponse represents generalized websocket subscription push data and immediate websocket call responses.
WsSubscriptionInput defines a request obj for the JSON-RPC and gets a websocket response.
WsUserLock represents a notification data when account is locked/unlocked.