# README
GoCryptoTrader package Bitflyer

This bitflyer 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
Bitflyer Exchange
Current Features
- REST Support
How to enable
-
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 b exchange.IBotExchange
for i := range bot.Exchanges {
if bot.Exchanges[i].GetName() == "Bitflyer" {
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
}
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.
# Structs
AccountBalance holds account balance information.
BankAccount holds bank account information.
Bitflyer is the overarching type across this package.
CancellationHistory cancellation history.
CashDeposit holds cash deposit information.
ChainAnalysisAddress holds address information from the bitcoin network.
ChainAnalysisBlock holds block information from the bitcoin network.
ChainAnalysisTransaction holds transaction data from the bitcoin network.
ChatLog holds chat log information.
CollateralAccounts holds collateral balances.
CollateralHistory holds collateral history data.
DepositAddress hold depositing address information.
DepositHistory holds deposit history information.
ExecutedTrade holds past trade information.
Executions holds past executed trade details.
MarginStatus holds margin status information.
MarketInfo holds market information returned from bitflyer.
NewOrder to send a new order.
OpenInterest holds open interest information.
Orderbook holds orderbook information.
Orders holds order full order information.
ParentOrderDetail holds detailed information about an order.
ParentOrders holds order full order information.
Ticker holds ticker information.
TransactionHistory holds prior transaction history data.