gocryptotrader/exchanges/deribit/README.md

GoCryptoTrader package Deribit

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

• Enable via configuration

• Individual package example below:

	// 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.FetchTicker()
if err != nil {
	// Handle error
}

// Fetches current orderbook information
ob, err := d.FetchOrderbook()
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