rest

package
v0.0.0-...-05d1cd5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2022 License: MIT Imports: 15 Imported by: 22

Documentation

Index

Constants

View Source 
const (
	DERIV_TYPE = "deriv"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BookService 

type BookService struct {
	Synchronous
}

func (*BookService) All 

func (b *BookService) All(symbol string, precision bitfinex.BookPrecision, priceLevels int) (*bitfinex.BookUpdateSnapshot, error)

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 CandleService 

type CandleService struct {
	Synchronous
}

CandleService manages the Candles endpoint.

func (*CandleService) History 

func (c *CandleService) History(symbol string, resolution bitfinex.CandleResolution) (*bitfinex.CandleSnapshot, error)

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 (*CandleService) HistoryWithQuery 

func (c *CandleService) HistoryWithQuery(
	symbol string,
	resolution bitfinex.CandleResolution,
	start bitfinex.Mts,
	end bitfinex.Mts,
	limit bitfinex.QueryLimit,
	sort bitfinex.SortOrder,
) (*bitfinex.CandleSnapshot, error)

Retrieves all candles (Max=1000) that fit the given query criteria See https://docs.bitfinex.com/reference#rest-public-candles for more info

func (*CandleService) Last 

func (c *CandleService) Last(symbol string, resolution bitfinex.CandleResolution) (*bitfinex.Candle, error)

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 

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

	Synchronous
	// contains filtered or unexported fields
}

func NewClient 

func NewClient() *Client

Create a new Rest client

func NewClientWithHttpDo 

func NewClientWithHttpDo(httpDo func(c *http.Client, r *http.Request) (*http.Response, error)) *Client

Create a new Rest client with a custom http handler

func NewClientWithSynchronousNonce 

func NewClientWithSynchronousNonce(sync Synchronous, nonce utils.NonceGenerator) *Client

Create a new Rest client with a synchronous HTTP handler and a custom nonce generaotr

func NewClientWithSynchronousURLNonce 

func NewClientWithSynchronousURLNonce(sync Synchronous, url string, nonce utils.NonceGenerator) *Client

Create a new Rest client with a synchronous HTTP handler and a custom base url and nonce generator

func NewClientWithURL 

func NewClientWithURL(url string) *Client

Create a new Rest client with a custom base url

func NewClientWithURLHttpDo 

func NewClientWithURLHttpDo(base string, httpDo func(c *http.Client, r *http.Request) (*http.Response, error)) *Client

Create a new Rest client with a custom base url and HTTP handler

func NewClientWithURLHttpDoNonce 

func NewClientWithURLHttpDoNonce(base string, httpDo func(c *http.Client, r *http.Request) (*http.Response, error), nonce utils.NonceGenerator) *Client

Create a new Rest client with a custom base url, HTTP handler and none generator

func NewClientWithURLNonce 

func NewClientWithURLNonce(url string, nonce utils.NonceGenerator) *Client

Create a new Rest client with a custom nonce generator

func (*Client) Credentials 

func (c *Client) Credentials(key string, secret string) *Client

Set the clients credentials in order to make authenticated requests

func (*Client) NewAuthenticatedRequest 

func (c *Client) NewAuthenticatedRequest(permissionType bitfinex.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 (*Client) NewAuthenticatedRequestWithBytes 

func (c *Client) NewAuthenticatedRequestWithBytes(permissionType bitfinex.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 (*Client) NewAuthenticatedRequestWithData 

func (c *Client) NewAuthenticatedRequestWithData(permissionType bitfinex.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 CurrenciesService 

type CurrenciesService struct {
	Synchronous
	// contains filtered or unexported fields
}

TradeService manages the Trade endpoint.

func (*CurrenciesService) Conf 

func (cs *CurrenciesService) Conf(label, symbol, unit, explorer, pairs bool) ([]bitfinex.CurrencyConf, error)

Retreive currency and symbol service configuration data see https://docs.bitfinex.com/reference#rest-public-conf for more info

type DerivativesService 

type DerivativesService struct {
	Synchronous
	// contains filtered or unexported fields
}

OrderService manages data flow for the Order API endpoint

type ErrorResponse 

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 (*ErrorResponse) Error 

func (r *ErrorResponse) Error() string

type FundingService 

type FundingService struct {
	Synchronous
	// contains filtered or unexported fields
}

LedgerService manages the Ledgers endpoint.

func (*FundingService) CancelOffer 

func (fs *FundingService) CancelOffer(fc *bitfinex.FundingOfferCancelRequest) (*bitfinex.Notification, error)

Submits a request to cancel the given offer see https://docs.bitfinex.com/reference#cancel-funding-offer for more info

func (*FundingService) Credits 

func (fs *FundingService) Credits(symbol string) (*bitfinex.FundingCreditSnapshot, error)

Retreive all of the active credits used in positions see https://docs.bitfinex.com/reference#rest-auth-funding-credits for more info

func (*FundingService) CreditsHistory 

func (fs *FundingService) CreditsHistory(symbol string) (*bitfinex.FundingCreditSnapshot, 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 (*FundingService) CreditsHistoryWithDate 

func (fs *FundingService) CreditsHistoryWithDate(symbol string, start int64, end int64) (*bitfinex.FundingCreditSnapshot, 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 (*FundingService) Loans 

func (fs *FundingService) Loans(symbol string) (*bitfinex.FundingLoanSnapshot, error)

Retreive all of the active funding loans see https://docs.bitfinex.com/reference#rest-auth-funding-loans for more info

func (*FundingService) LoansHistory 

func (fs *FundingService) LoansHistory(symbol string) (*bitfinex.FundingLoanSnapshot, 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 (*FundingService) OfferHistory 

func (fs *FundingService) OfferHistory(symbol string) (*bitfinex.FundingOfferSnapshot, 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 (*FundingService) Offers 

func (fs *FundingService) Offers(symbol string) (*bitfinex.FundingOfferSnapshot, error)

Retreive all of the active fundign offers see https://docs.bitfinex.com/reference#rest-auth-funding-offers for more info

func (*FundingService) SubmitOffer 

func (fs *FundingService) SubmitOffer(fo *bitfinex.FundingOfferRequest) (*bitfinex.Notification, error)

Submits a request to create a new funding offer see https://docs.bitfinex.com/reference#submit-funding-offer for more info

func (*FundingService) Trades 

func (fs *FundingService) Trades(symbol string) (*bitfinex.FundingTradeSnapshot, error)

Retreive all of the matched funding trades see https://docs.bitfinex.com/reference#rest-auth-funding-trades-hist for more info

type HttpTransport 

type HttpTransport struct {
	BaseURL    *url.URL
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

func (HttpTransport) Request 

func (h HttpTransport) Request(req Request) ([]interface{}, error)

type LedgerService 

type LedgerService struct {
	Synchronous
	// contains filtered or unexported fields
}

LedgerService manages the Ledgers endpoint.

func (*LedgerService) Ledgers 

func (s *LedgerService) Ledgers(currency string, start int64, end int64, max int32, category int32) (*bitfinex.LedgerSnapshot, error)

Retrieves all of the past ledger entreies see https://docs.bitfinex.com/reference#ledgers for more info

type OrderService 

type OrderService struct {
	Synchronous
	// contains filtered or unexported fields
}

OrderService manages data flow for the Order API endpoint

func (*OrderService) All 

func (s *OrderService) All() (*bitfinex.OrderSnapshot, error)

Retrieves all of the active orders See https://docs.bitfinex.com/reference#rest-auth-orders for more info

func (*OrderService) AllHistory 

func (s *OrderService) AllHistory() (*bitfinex.OrderSnapshot, error)

Retrieves all past orders See https://docs.bitfinex.com/reference#orders-history for more info

func (*OrderService) GetByOrderId 

func (s *OrderService) GetByOrderId(orderID int64) (o *bitfinex.Order, err error)

Retrieve an active order by the given ID See https://docs.bitfinex.com/reference#rest-auth-orders for more info

func (*OrderService) GetBySymbol 

func (s *OrderService) GetBySymbol(symbol string) (*bitfinex.OrderSnapshot, 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 (*OrderService) GetHistoryByOrderId 

func (s *OrderService) GetHistoryByOrderId(orderID int64) (o *bitfinex.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 (*OrderService) GetHistoryBySymbol 

func (s *OrderService) GetHistoryBySymbol(symbol string) (*bitfinex.OrderSnapshot, error)

Retrieves all past orders with the given symbol See https://docs.bitfinex.com/reference#orders-history for more info

func (*OrderService) OrderTrades 

func (s *OrderService) OrderTrades(symbol string, orderID int64) (*bitfinex.TradeExecutionUpdateSnapshot, error)

Retrieves the trades generated by an order See https://docs.bitfinex.com/reference#orders-history for more info

func (*OrderService) SubmitCancelOrder 

func (s *OrderService) SubmitCancelOrder(oc *bitfinex.OrderCancelRequest) error

Submit a request to cancel an order with the given Id see https://docs.bitfinex.com/reference#cancel-order for more info

func (*OrderService) SubmitOrder 

func (s *OrderService) SubmitOrder(order *bitfinex.OrderNewRequest) (*bitfinex.Notification, error)

Submit a request to create a new order see https://docs.bitfinex.com/reference#submit-order for more info

func (*OrderService) SubmitUpdateOrder 

func (s *OrderService) SubmitUpdateOrder(order *bitfinex.OrderUpdateRequest) (*bitfinex.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 

type PlatformService struct {
	Synchronous
}

func (*PlatformService) Status 

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 

type PositionService struct {
	Synchronous
	// contains filtered or unexported fields
}

PositionService manages the Position endpoint.

func (*PositionService) All 

func (s *PositionService) All() (*bitfinex.PositionSnapshot, error)

Retrieves all of the active positions see https://docs.bitfinex.com/reference#rest-auth-positions for more info

func (*PositionService) Claim 

func (s *PositionService) Claim(cp *bitfinex.ClaimPositionRequest) (*bitfinex.Notification, error)

Submits a request to claim an active position with the given id see https://docs.bitfinex.com/reference#claim-position for more info

type Request 

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 

func NewRequest(refURL string) Request

Create new POST request with an empty body as payload

func NewRequestWithBytes 

func NewRequestWithBytes(refURL string, data []byte) Request

Create a new POST request with the given bytes as body

func NewRequestWithData 

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 

func NewRequestWithDataMethod(refURL string, data []byte, method string) Request

Create a new request with a given method (POST | GET) with bytes as body

func NewRequestWithMethod 

func NewRequestWithMethod(refURL string, method string) Request

Create a new request with the given method (POST | GET)

type Response 

type Response struct {
	Response *http.Response
	Body     []byte
}

Response is a wrapper for standard http.Response and provides more methods.

func (*Response) String 

func (r *Response) String() string

String converts response body to string. An empty string will be returned if error.

type StatsService 

type StatsService struct {
	Synchronous
	// contains filtered or unexported fields
}

TradeService manages the Trade endpoint.

func (*StatsService) CreditSizeHistory 

func (ss *StatsService) CreditSizeHistory(symbol string, side bitfinex.OrderSide) ([]bitfinex.Stat, error)

Retrieves platform statistics for credit size history see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) CreditSizeLast 

func (ss *StatsService) CreditSizeLast(symbol string, side bitfinex.OrderSide) (*bitfinex.Stat, error)

Retrieves platform statistics for credit size last see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) FundingHistory 

func (ss *StatsService) FundingHistory(symbol string) ([]bitfinex.Stat, error)

Retrieves platform statistics for funding history see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) FundingLast 

func (ss *StatsService) FundingLast(symbol string) (*bitfinex.Stat, error)

Retrieves platform statistics for funding last see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) PositionHistory 

func (ss *StatsService) PositionHistory(symbol string, side bitfinex.OrderSide) ([]bitfinex.Stat, error)

Retrieves platform statistics for position history see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) PositionLast 

func (ss *StatsService) PositionLast(symbol string, side bitfinex.OrderSide) (*bitfinex.Stat, error)

Retrieves platform statistics for position last see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) SymbolCreditSizeHistory 

func (ss *StatsService) SymbolCreditSizeHistory(fundingSymbol string, tradingSymbol string) ([]bitfinex.Stat, error)

Retrieves platform statistics for credit size history see https://docs.bitfinex.com/reference#rest-public-stats for more info

func (*StatsService) SymbolCreditSizeLast 

func (ss *StatsService) SymbolCreditSizeLast(fundingSymbol string, tradingSymbol string) (*bitfinex.Stat, error)

Retrieves platform statistics for credit size last see https://docs.bitfinex.com/reference#rest-public-stats for more info

type StatusService 

type StatusService struct {
	Synchronous
	// contains filtered or unexported fields
}

TradeService manages the Trade endpoint.

func (*StatusService) DerivativeStatus 

func (ss *StatusService) DerivativeStatus(symbol string) (*bitfinex.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 (*StatusService) DerivativeStatusAll 

func (ss *StatusService) DerivativeStatusAll() ([]*bitfinex.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 (*StatusService) DerivativeStatusMulti 

func (ss *StatusService) DerivativeStatusMulti(symbols []string) ([]*bitfinex.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 

type Synchronous interface {
	Request(request Request) ([]interface{}, error)
}

type TickerService 

type TickerService struct {
	Synchronous
	// contains filtered or unexported fields
}

TradeService manages the Trade endpoint.

func (*TickerService) All 

func (s *TickerService) All() (*[]bitfinex.Ticker, error)

Retrieves all tickers for all symbols see https://docs.bitfinex.com/reference#rest-public-ticker for more info

func (*TickerService) Get 

func (s *TickerService) Get(symbol string) (*bitfinex.Ticker, error)

Retrieves the ticker for the given symbol see https://docs.bitfinex.com/reference#rest-public-ticker for more info

func (*TickerService) GetMulti 

func (s *TickerService) GetMulti(symbols []string) (*[]bitfinex.Ticker, error)

Retrieves the tickers for the given symbols see https://docs.bitfinex.com/reference#rest-public-ticker for more info

type TradeService 

type TradeService struct {
	Synchronous
	// contains filtered or unexported fields
}

TradeService manages the Trade endpoint.

func (*TradeService) AccountAll 

func (s *TradeService) AccountAll() (*bitfinex.TradeExecutionUpdateSnapshot, error)

Retrieves all matched trades for the account see https://docs.bitfinex.com/reference#rest-auth-trades-hist for more info

func (*TradeService) AccountAllWithSymbol 

func (s *TradeService) AccountAllWithSymbol(symbol string) (*bitfinex.TradeExecutionUpdateSnapshot, 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 (*TradeService) AccountHistoryWithQuery 

func (s *TradeService) AccountHistoryWithQuery(
	symbol string,
	start bitfinex.Mts,
	end bitfinex.Mts,
	limit bitfinex.QueryLimit,
	sort bitfinex.SortOrder,
) (*bitfinex.TradeExecutionUpdateSnapshot, error)

Queries all matched trades with group of optional parameters see https://docs.bitfinex.com/reference#rest-auth-trades-hist for more info

func (*TradeService) PublicHistoryWithQuery 

func (s *TradeService) PublicHistoryWithQuery(
	symbol string,
	start bitfinex.Mts,
	end bitfinex.Mts,
	limit bitfinex.QueryLimit,
	sort bitfinex.SortOrder,
) (*bitfinex.TradeSnapshot, 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 

type WalletService struct {
	Synchronous
	// contains filtered or unexported fields
}

WalletService manages data flow for the Wallet API endpoint

func (*WalletService) CreateDepositAddress 

func (ws *WalletService) CreateDepositAddress(wallet, method string) (*bitfinex.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 (*WalletService) DepositAddress 

func (ws *WalletService) DepositAddress(wallet, method string) (*bitfinex.Notification, error)

Retrieves the deposit address for the given Bitfinex wallet see https://docs.bitfinex.com/reference#deposit-address for more info

func (*WalletService) SetCollateral 

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 (*WalletService) Transfer 

func (ws *WalletService) Transfer(from, to, currency, currencyTo string, amount float64) (*bitfinex.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 (*WalletService) Wallet 

func (s *WalletService) Wallet() (*bitfinex.WalletSnapshot, error)

Retrieves all of the wallets for the account see https://docs.bitfinex.com/reference#rest-auth-wallets for more info

func (*WalletService) Withdraw 

func (ws *WalletService) Withdraw(wallet, method string, amount float64, address string) (*bitfinex.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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.