-- import "github.com/bitfinexcom/bitfinex-api-go/v2/rest"
const (
DERIV_TYPE = "deriv"
)type AveragePriceRequest struct {
Symbol string
Amount string
RateLimit string
Period int
}AveragePriceRequest data structure for constructing average price query params
type BookService struct {
Synchronous
}func (b *BookService) All(symbol string, precision common.BookPrecision, priceLevels int) (*book.Snapshot, error)All - retrieve all books for the given symbol with the given precision at the given price level see https://docs.bitfinex.com/reference#rest-public-books for more info
type CancelOrderMultiRequest struct {
OrderIDs OrderIDs `json:"id,omitempty"`
GroupOrderIDs GroupOrderIDs `json:"gid,omitempty"`
ClientOrderIDs ClientOrderIDs `json:"cid,omitempty"`
All int `json:"all,omitempty"`
}CancelOrderMultiRequest - data structure for constructing cancel order multi request payload
type CandleService struct {
Synchronous
}CandleService manages the Candles endpoint.
func (c *CandleService) History(symbol string, resolution common.CandleResolution) (*candle.Snapshot, error)History - retrieves all candles (Max=1000) with the given symbol and the given candle resolution See https://docs.bitfinex.com/reference#rest-public-candles for more info
func (c *CandleService) HistoryWithQuery(
symbol string,
resolution common.CandleResolution,
start common.Mts,
end common.Mts,
limit common.QueryLimit,
sort common.SortOrder,
) (*candle.Snapshot, error)HistoryWithQuery - retrieves all candles (Max=1000) that fit the given query criteria See https://docs.bitfinex.com/reference#rest-public-candles for more info
func (c *CandleService) Last(symbol string, resolution common.CandleResolution) (*candle.Candle, error)Last - retrieve the last candle for the given symbol with the given resolution See https://docs.bitfinex.com/reference#rest-public-candles for more info
type Client struct {
// service providers
Candles CandleService
Orders OrderService
Positions PositionService
Trades TradeService
Tickers TickerService
Currencies CurrenciesService
Platform PlatformService
Book BookService
Wallet WalletService
Ledgers LedgerService
Stats StatsService
Status StatusService
Derivatives DerivativesService
Funding FundingService
Pulse PulseService
Invoice InvoiceService
Market MarketService
Synchronous
}func NewClient() *ClientCreate a new Rest client
func NewClientWithHttpDo(httpDo func(c *http.Client, r *http.Request) (*http.Response, error)) *ClientCreate a new Rest client with a custom http handler
func NewClientWithSynchronousNonce(sync Synchronous, nonce utils.NonceGenerator) *ClientCreate a new Rest client with a synchronous HTTP handler and a custom nonce generaotr
func NewClientWithSynchronousURLNonce(sync Synchronous, url string, nonce utils.NonceGenerator) *ClientCreate a new Rest client with a synchronous HTTP handler and a custom base url and nonce generator
func NewClientWithURL(url string) *ClientCreate a new Rest client with a custom base url
func NewClientWithURLHttpDo(base string, httpDo func(c *http.Client, r *http.Request) (*http.Response, error)) *ClientCreate a new Rest client with a custom base url and HTTP handler
func NewClientWithURLHttpDoNonce(base string, httpDo func(c *http.Client, r *http.Request) (*http.Response, error), nonce utils.NonceGenerator) *ClientCreate a new Rest client with a custom base url, HTTP handler and none generator
func NewClientWithURLNonce(url string, nonce utils.NonceGenerator) *ClientCreate a new Rest client with a custom nonce generator
func (c *Client) Credentials(key string, secret string) *ClientSet the clients credentials in order to make authenticated requests
func (c *Client) NewAuthenticatedRequest(permissionType common.PermissionType, refURL string) (Request, error)Create a new authenticated GET request with the given permission type and endpoint url For example permissionType = "r" and refUrl = "/orders" then the target endpoint will be https://api.bitfinex.com/v2/auth/r/orders/:Symbol
func (c *Client) NewAuthenticatedRequestWithBytes(permissionType common.PermissionType, refURL string, data []byte) (Request, error)Create a new authenticated POST request with the given permission type,endpoint url and data (bytes) as the body For example permissionType = "r" and refUrl = "/orders" then the target endpoint will be https://api.bitfinex.com/v2/auth/r/orders/:Symbol
func (c *Client) NewAuthenticatedRequestWithData(permissionType common.PermissionType, refURL string, data map[string]interface{}) (Request, error)Create a new authenticated POST request with the given permission type,endpoint url and data (map[string]interface{}) as the body For example permissionType = "r" and refUrl = "/orders" then the target endpoint will be https://api.bitfinex.com/v2/auth/r/orders/:Symbol
type ClientOrderIDs [][]interface{}type CurrenciesService struct {
Synchronous
}CurrenciesService manages the conf endpoint.
func (cs *CurrenciesService) Conf(label, symbol, unit, explorer, pairs bool) ([]currency.Conf, error)Conf - retreive currency and symbol service configuration data see https://docs.bitfinex.com/reference#rest-public-conf for more info
type DepositInvoiceRequest struct {
Currency string `json:"currency,omitempty"`
Wallet string `json:"wallet,omitempty"`
Amount string `json:"amount,omitempty"`
}DepositInvoiceRequest - data structure for constructing deposit invoice request payload
type DerivativesService struct {
Synchronous
}OrderService manages data flow for the Order API endpoint
type ErrorResponse struct {
Response *Response
Message string `json:"message"`
Code int `json:"code"`
}In case if API will wrong response code ErrorResponse will be returned to caller
func (r *ErrorResponse) Error() stringtype ForeignExchangeRateRequest struct {
FirstCurrency string `json:"ccy1"`
SecondCurrency string `json:"ccy2"`
}ForeignExchangeRateRequest data structure for constructing foreign exchange rate request payload
type FundingService struct {
Synchronous
}FundingService manages the Funding endpoint.
func (fs *FundingService) CancelOffer(fc *fundingoffer.CancelRequest) (*notification.Notification, error)Submits a request to cancel the given offer see https://docs.bitfinex.com/reference#cancel-funding-offer for more info
func (fs *FundingService) Credits(symbol string) (*fundingcredit.Snapshot, error)Retreive all of the active credits used in positions see https://docs.bitfinex.com/reference#rest-auth-funding-credits for more info
func (fs *FundingService) CreditsHistory(symbol string) (*fundingcredit.Snapshot, error)Retreive all of the past in-active credits used in positions see https://docs.bitfinex.com/reference#rest-auth-funding-credits-hist for more info
func (fs *FundingService) KeepFunding(args KeepFundingRequest) (*notification.Notification, error)KeepFunding - toggle to keep funding taken. Specify loan for unused funding and credit for used funding. see https://docs.bitfinex.com/reference#rest-auth-keep-funding for more info
func (fs *FundingService) Loans(symbol string) (*fundingloan.Snapshot, error)Retreive all of the active funding loans see https://docs.bitfinex.com/reference#rest-auth-funding-loans for more info
func (fs *FundingService) LoansHistory(symbol string) (*fundingloan.Snapshot, error)Retreive all of the past in-active funding loans see https://docs.bitfinex.com/reference#rest-auth-funding-loans-hist for more info
func (fs *FundingService) OfferHistory(symbol string) (*fundingoffer.Snapshot, error)Retreive all of the past in-active funding offers see https://docs.bitfinex.com/reference#rest-auth-funding-offers-hist for more info
func (fs *FundingService) Offers(symbol string) (*fundingoffer.Snapshot, error)Retreive all of the active fundign offers see https://docs.bitfinex.com/reference#rest-auth-funding-offers for more info
func (fs *FundingService) SubmitOffer(fo *fundingoffer.SubmitRequest) (*notification.Notification, error)Submits a request to create a new funding offer see https://docs.bitfinex.com/reference#submit-funding-offer for more info
func (fs *FundingService) Trades(symbol string) (*fundingtrade.Snapshot, error)Retreive all of the matched funding trades see https://docs.bitfinex.com/reference#rest-auth-funding-trades-hist for more info
type GroupOrderIDs []inttype HttpTransport struct {
BaseURL *url.URL
HTTPClient *http.Client
}func (h HttpTransport) Request(req Request) ([]interface{}, error)type InvoiceService struct {
Synchronous
}InvoiceService manages Invoice endpoint
func (is *InvoiceService) GenerateInvoice(payload DepositInvoiceRequest) (*invoice.Invoice, error)GenerateInvoice generates a Lightning Network deposit invoice Accepts DepositInvoiceRequest type as argument https://docs.bitfinex.com/reference#rest-auth-deposit-invoice
type KeepFundingRequest struct {
Type string `json:"type"`
ID int `json:"id"`
}KeepFundingRequest - data structure for constructing keep funding request payload
type LedgerService struct {
Synchronous
}LedgerService manages the Ledgers endpoint.
func (s *LedgerService) Ledgers(currency string, start int64, end int64, max int32) (*ledger.Snapshot, error)Ledgers - all of the past ledger entreies see https://docs.bitfinex.com/reference#ledgers for more info
type MarketService struct {
Synchronous
}func (ms *MarketService) AveragePrice(pld AveragePriceRequest) ([]float64, error)AveragePrice Calculate the average execution price for Trading or rate for Margin funding. See: https://docs.bitfinex.com/reference#rest-public-calc-market-average-price
func (ms *MarketService) ForeignExchangeRate(pld ForeignExchangeRateRequest) ([]float64, error)ForeignExchangeRate - Calculate the exchange rate between two currencies See: https://docs.bitfinex.com/reference#rest-public-calc-foreign-exchange-rate
type Nickname stringtype OrderIDs []inttype OrderMultiOpsRequest struct {
Ops OrderOps `json:"ops"`
}OrderMultiOpsRequest - data structure for constructing order multi ops request payload
type OrderOps [][]interface{}type OrderService struct {
Synchronous
}OrderService manages data flow for the Order API endpoint
func (s *OrderService) All() (*order.Snapshot, error)Retrieves all of the active orders See https://docs.bitfinex.com/reference#rest-auth-orders for more info
func (s *OrderService) AllHistory() (*order.Snapshot, error)Retrieves all past orders See https://docs.bitfinex.com/reference#orders-history for more info
func (s *OrderService) CancelOrderMulti(args CancelOrderMultiRequest) (*notification.Notification, error)CancelOrderMulti cancels multiple orders simultaneously. Orders can be canceled based on the Order ID, the combination of Client Order ID and Client Order Date, or the Group Order ID. Alternatively, the body param 'all' can be used with a value of 1 to cancel all orders. see https://docs.bitfinex.com/reference#rest-auth-order-cancel-multi for more info
func (s *OrderService) CancelOrderMultiOp(orderID int) (*notification.Notification, error)CancelOrderMultiOp cancels order. Accepts orderID to be canceled. see https://docs.bitfinex.com/reference#rest-auth-order-multi for more info
func (s *OrderService) CancelOrdersMultiOp(ids OrderIDs) (*notification.Notification, error)CancelOrdersMultiOp cancels multiple orders simultaneously. Accepts a slice of order ID's to be canceled. see https://docs.bitfinex.com/reference#rest-auth-order-multi for more info
func (s *OrderService) GetByOrderId(orderID int64) (o *order.Order, err error)Retrieve an active order by the given ID See https://docs.bitfinex.com/reference#rest-auth-orders for more info
func (s *OrderService) GetBySymbol(symbol string) (*order.Snapshot, error)Retrieves all of the active orders with for the given symbol See https://docs.bitfinex.com/reference#rest-auth-orders for more info
func (s *OrderService) GetHistoryByOrderId(orderID int64) (o *order.Order, err error)Retrieve a single order in history with the given id See https://docs.bitfinex.com/reference#orders-history for more info
func (s *OrderService) GetHistoryBySymbol(symbol string) (*order.Snapshot, error)Retrieves all past orders with the given symbol See https://docs.bitfinex.com/reference#orders-history for more info
func (s *OrderService) OrderMultiOp(ops OrderOps) (*notification.Notification, error)OrderMultiOp - send Multiple order-related operations. Please note the sent object has only one property with a value of a slice of slices detailing each order operation. see https://docs.bitfinex.com/reference#rest-auth-order-multi for more info
func (s *OrderService) OrderNewMultiOp(onr order.NewRequest) (*notification.Notification, error)OrderNewMultiOp creates new order. Accepts instance of order.NewRequest see https://docs.bitfinex.com/reference#rest-auth-order-multi for more info
func (s *OrderService) OrderTrades(symbol string, orderID int64) (*tradeexecutionupdate.Snapshot, error)Retrieves the trades generated by an order See https://docs.bitfinex.com/reference#orders-history for more info
func (s *OrderService) OrderUpdateMultiOp(our order.UpdateRequest) (*notification.Notification, error)OrderUpdateMultiOp updates order. Accepts instance of order.UpdateRequest see https://docs.bitfinex.com/reference#rest-auth-order-multi for more info
func (s *OrderService) SubmitCancelOrder(oc *order.CancelRequest) errorSubmit a request to cancel an order with the given Id see https://docs.bitfinex.com/reference#cancel-order for more info
func (s *OrderService) SubmitOrder(onr *order.NewRequest) (*notification.Notification, error)Submit a request to create a new order see https://docs.bitfinex.com/reference#submit-order for more info
func (s *OrderService) SubmitUpdateOrder(our *order.UpdateRequest) (*notification.Notification, error)Submit a request to update an order with the given id with the given changes see https://docs.bitfinex.com/reference#order-update for more info
type PlatformService struct {
Synchronous
}func (p *PlatformService) Status() (bool, error)Retrieves the current status of the platform see https://docs.bitfinex.com/reference#rest-public-platform-status for more info
type PositionService struct {
Synchronous
}PositionService manages the Position endpoint.
func (s *PositionService) All() (*position.Snapshot, error)All - retrieves all of the active positions see https://docs.bitfinex.com/reference#rest-auth-positions for more info
func (s *PositionService) Claim(cp *position.ClaimRequest) (*notification.Notification, error)Claim - submits a request to claim an active position with the given id see https://docs.bitfinex.com/reference#claim-position for more info
type PulseService struct {
Synchronous
}func (ps *PulseService) AddComment(p *pulse.Pulse) (*pulse.Pulse, error)AddComment submits pulse comment see https://docs.bitfinex.com/reference#rest-auth-pulse-add
func (ps *PulseService) AddPulse(p *pulse.Pulse) (*pulse.Pulse, error)AddPulse submits pulse message see https://docs.bitfinex.com/reference#rest-auth-pulse-add
func (ps *PulseService) DeletePulse(pid string) (int, error)DeletePulse removes your pulse message. Returns 0 if no pulse was deleted and 1 if it was see https://docs.bitfinex.com/reference#rest-auth-pulse-del
func (ps *PulseService) PublicPulseHistory(limit int, end common.Mts) ([]*pulse.Pulse, error)PublicPulseHistory returns latest pulse messages. You can specify an end timestamp to view older messages. see https://docs.bitfinex.com/reference#rest-public-pulse-hist
func (ps *PulseService) PublicPulseProfile(nickname Nickname) (*pulseprofile.PulseProfile, error)PublicPulseProfile returns details for a specific Pulse profile https://docs.bitfinex.com/reference#rest-public-pulse-profile
func (ps *PulseService) PulseHistory() ([]*pulse.Pulse, error)PulseHistory allows you to retrieve your pulse history. see https://docs.bitfinex.com/reference#rest-auth-pulse-hist
type Request struct {
RefURL string // ref url
Data []byte // body data
Method string // http method
Params url.Values // query parameters
Headers map[string]string
}Request is a wrapper for standard http.Request. Default method is POST with no data.
func NewRequest(refURL string) RequestCreate new POST request with an empty body as payload
func NewRequestWithBytes(refURL string, data []byte) RequestCreate a new POST request with the given bytes as body
func NewRequestWithData(refURL string, data map[string]interface{}) (Request, error)Create a new POST request with the given data (map[string]interface{}) as body
func NewRequestWithDataMethod(refURL string, data []byte, method string) RequestCreate a new request with a given method (POST | GET) with bytes as body
func NewRequestWithMethod(refURL string, method string) RequestCreate a new request with the given method (POST | GET)
type Response struct {
Response *http.Response
Body []byte
}Response is a wrapper for standard http.Response and provides more methods.
func (r *Response) String() stringString converts response body to string. An empty string will be returned if error.
type StatsService struct {
Synchronous
}StatsService manages the Stats endpoint.
func (ss *StatsService) CreditSizeHistory(symbol string, side common.OrderSide) ([]*stats.Stat, error)Retrieves platform statistics for credit size history see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) CreditSizeLast(symbol string, side common.OrderSide) (*stats.Stat, error)Retrieves platform statistics for credit size last see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) FundingHistory(symbol string) ([]*stats.Stat, error)Retrieves platform statistics for funding history see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) FundingLast(symbol string) (*stats.Stat, error)Retrieves platform statistics for funding last see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) PositionHistory(symbol string, side common.OrderSide) ([]*stats.Stat, error)Retrieves platform statistics for position history see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) PositionLast(symbol string, side common.OrderSide) (*stats.Stat, error)Retrieves platform statistics for position last see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) SymbolCreditSizeHistory(fundingSymbol string, tradingSymbol string) ([]*stats.Stat, error)Retrieves platform statistics for credit size history see https://docs.bitfinex.com/reference#rest-public-stats for more info
func (ss *StatsService) SymbolCreditSizeLast(fundingSymbol string, tradingSymbol string) (*stats.Stat, error)Retrieves platform statistics for credit size last see https://docs.bitfinex.com/reference#rest-public-stats for more info
type StatusService struct {
Synchronous
}TradeService manages the Trade endpoint.
func (ss *StatusService) DerivativeStatus(symbol string) (*derivatives.DerivativeStatus, error)Retrieves derivative status information for the given symbol from the platform see https://docs.bitfinex.com/reference#rest-public-status for more info
func (ss *StatusService) DerivativeStatusAll() ([]*derivatives.DerivativeStatus, error)Retrieves derivative status information for all symbols from the platform see https://docs.bitfinex.com/reference#rest-public-status for more info
func (ss *StatusService) DerivativeStatusMulti(symbols []string) ([]*derivatives.DerivativeStatus, error)Retrieves derivative status information for the given symbols from the platform see https://docs.bitfinex.com/reference#rest-public-status for more info
type Synchronous interface {
Request(request Request) ([]interface{}, error)
}type TickerService struct {
Synchronous
}TickerService manages the Ticker endpoint.
func (s *TickerService) All() ([]*ticker.Ticker, error)All - retrieves all tickers for all symbols see https://docs.bitfinex.com/reference#rest-public-ticker for more info
func (s *TickerService) Get(symbol string) (*ticker.Ticker, error)Get - retrieves the ticker for the given symbol see https://docs.bitfinex.com/reference#rest-public-ticker for more info
func (s *TickerService) GetMulti(symbols []string) ([]*ticker.Ticker, error)GetMulti - retrieves the tickers for the given symbols see https://docs.bitfinex.com/reference#rest-public-ticker for more info
type TradeService struct {
Synchronous
}TradeService manages the Trade endpoint.
func (s *TradeService) AccountAll() (*tradeexecutionupdate.Snapshot, error)Retrieves all matched trades for the account see https://docs.bitfinex.com/reference#rest-auth-trades-hist for more info
func (s *TradeService) AccountAllWithSymbol(symbol string) (*tradeexecutionupdate.Snapshot, error)Retrieves all matched trades with the given symbol for the account see https://docs.bitfinex.com/reference#rest-auth-trades-hist for more info
func (s *TradeService) AccountHistoryWithQuery(
symbol string,
start common.Mts,
end common.Mts,
limit common.QueryLimit,
sort common.SortOrder,
) (*tradeexecutionupdate.Snapshot, error)Queries all matched trades with group of optional parameters see https://docs.bitfinex.com/reference#rest-auth-trades-hist for more info
func (s *TradeService) PublicHistoryWithQuery(
symbol string,
start common.Mts,
end common.Mts,
limit common.QueryLimit,
sort common.SortOrder,
) (*trade.Snapshot, error)Queries all public trades with a group of optional paramters see https://docs.bitfinex.com/reference#rest-public-trades for more info
type WalletService struct {
Synchronous
}WalletService manages data flow for the Wallet API endpoint
func (ws *WalletService) CreateDepositAddress(wallet, method string) (*notification.Notification, error)Submits a request to create a new deposit address for the give Bitfinex wallet. Old addresses are still valid. See https://docs.bitfinex.com/reference#deposit-address for more info
func (ws *WalletService) DepositAddress(wallet, method string) (*notification.Notification, error)Retrieves the deposit address for the given Bitfinex wallet see https://docs.bitfinex.com/reference#deposit-address for more info
func (s *WalletService) SetCollateral(symbol string, amount float64) (bool, error)Update the amount of collateral for a Derivative position see https://docs.bitfinex.com/reference#rest-auth-deriv-pos-collateral-set for more info
func (ws *WalletService) Transfer(from, to, currency, currencyTo string, amount float64) (*notification.Notification, error)Submits a request to transfer funds from one Bitfinex wallet to another see https://docs.bitfinex.com/reference#transfer-between-wallets for more info
func (s *WalletService) Wallet() (*wallet.Snapshot, error)Retrieves all of the wallets for the account see https://docs.bitfinex.com/reference#rest-auth-wallets for more info
func (ws *WalletService) Withdraw(wallet, method string, amount float64, address string) (*notification.Notification, error)Submits a request to withdraw funds from the given Bitfinex wallet to the given address See https://docs.bitfinex.com/reference#withdraw for more info