rest

README

Usage

ftxClientHead = FtxClientHeader{
    ApiKey: "YOUR_FTX_API_KEY",
    ApiSecret: "YOUR_FTX_API_SECRET",
    Subaccount: "(OPTIONAL)_SUBACCOUNT"
}

Documentation

Index

• Constants
• func Do(header *FtxClientHeader, httpMethod string, ftxResource string, ...)
• type FtxClientHeader
  • func (header *FtxClientHeader) CreateSavedAddresses(coin string, address string, addressName string, isPrimetrust string, ...)
  • func (header *FtxClientHeader) DeleteSavedAddress(saved_address_id string)
  • func (header *FtxClientHeader) GetAccount()
  • func (header *FtxClientHeader) GetAirdrops(params ...string)
  • func (header *FtxClientHeader) GetAllBalances()
  • func (header *FtxClientHeader) GetBalances()
  • func (header *FtxClientHeader) GetCoins()
  • func (header *FtxClientHeader) GetDepositAddressOf(coin string, method ...string)
  • func (header *FtxClientHeader) GetDeposits(params ...string)
  • func (header *FtxClientHeader) GetExpiredFutures()
  • func (header *FtxClientHeader) GetFundingRates()
  • func (header *FtxClientHeader) GetFutureOf(futureName string)
  • func (header *FtxClientHeader) GetFutureStatsOf(futureName string)
  • func (header *FtxClientHeader) GetFutures()
  • func (header *FtxClientHeader) GetHistoricalIndexOf(marketName string, resolution string, params ...string)
  • func (header *FtxClientHeader) GetIndexWeightOf(index string)
  • func (header *FtxClientHeader) GetMarketOf(marketName string)
  • func (header *FtxClientHeader) GetMarkets()
  • func (header *FtxClientHeader) GetOrderbookOf(marketName string, depth string)
  • func (header *FtxClientHeader) GetPositions()
  • func (header *FtxClientHeader) GetSavedAddresses(coin ...string)
  • func (header *FtxClientHeader) GetSubaccounts()
  • func (header *FtxClientHeader) GetTrades(marketName string, params ...int)
  • func (header *FtxClientHeader) GetWithdrawals(params ...string)

Constants

const (
	// Basic
	FtxServer        = "https://ftx.com/api"
	FtxAPISubaccount = "subaccounts"
	//
	FtxAPIMarkets   = "markets"
	FtxAPIOrderbook = "orderbook"
	FtxAPITrades    = "trades"
	//
	FtxAPIFutures        = "futures"
	FtxAPIFutureStats    = "stats"
	FtxAPIFundingRates   = "funding_rates"
	FtxAPIIndexes        = "indexes"
	FtxAPIIndexesWeights = "weights"
	FtxAPIExpiredFutures = "expired_futures"
	FtxAPIIndexesCandles = "candles"
	//
	FtxAPIAccount   = "account"
	FtxAPIPositions = "positions"
	//
	FtxAPIWallet               = "wallet"
	FtxAPIWalletCoins          = "coins"
	FtxAPIWalletBalances       = "balances"
	FtxAPIWalletAllBalances    = "all_balances"
	FtxAPIWalletDepositAddress = "deposit_address"
	FtxAPIWalletDeposits       = "deposits"
	FtxAPIWalletWithdrawals    = "withdrawals"
	FtxAPIWalletAirdrops       = "airdrops"
	FtxAPIWalletSavedAddresses = "saved_addresses"
)

Functions

func Do

func Do(header *FtxClientHeader, httpMethod string, ftxResource string, queryMap map[string]string)

Types

type FtxClientHeader

type FtxClientHeader struct {
	ApiKey     string
	ApiSecret  string
	Subaccount string
	// contains filtered or unexported fields
}

FtxClientHeader header object

func (*FtxClientHeader) CreateSavedAddresses

func (header *FtxClientHeader) CreateSavedAddresses(coin string, address string, addressName string, isPrimetrust string, tag ...string)

CreateSavedAddresses https://docs.ftx.com/#create-saved-addresses

func (*FtxClientHeader) DeleteSavedAddress

func (header *FtxClientHeader) DeleteSavedAddress(saved_address_id string)

DeleteSavedAddress Delete saved addresses https://docs.ftx.com/#delete-saved-addresses

func (*FtxClientHeader) GetAccount

func (header *FtxClientHeader) GetAccount()

func (*FtxClientHeader) GetAirdrops

func (header *FtxClientHeader) GetAirdrops(params ...string)

GetAirdrops params 1 element: index 0 == limit params 2 elements: index 0 == start_time, index 1 == end_time params 3 elements: index 0 == limit, index 1 == start_time, index 2 == end_time https://docs.ftx.com/#get-deposit-history

func (*FtxClientHeader) GetAllBalances

func (header *FtxClientHeader) GetAllBalances()

func (*FtxClientHeader) GetBalances

func (header *FtxClientHeader) GetBalances()

func (*FtxClientHeader) GetCoins

func (header *FtxClientHeader) GetCoins()

func (*FtxClientHeader) GetDepositAddressOf

func (header *FtxClientHeader) GetDepositAddressOf(coin string, method ...string)

GetDepositAddressOf https://docs.ftx.com/#get-deposit-address

func (*FtxClientHeader) GetDeposits

func (header *FtxClientHeader) GetDeposits(params ...string)

GetDeposits params 1 element: index 0 == limit params 2 elements: index 0 == start_time, index 1 == end_time params 3 elements: index 0 == limit, index 1 == start_time, index 2 == end_time https://docs.ftx.com/#get-deposit-history

func (*FtxClientHeader) GetExpiredFutures

func (header *FtxClientHeader) GetExpiredFutures()

func (*FtxClientHeader) GetFundingRates

func (header *FtxClientHeader) GetFundingRates()

func (*FtxClientHeader) GetFutureOf

func (header *FtxClientHeader) GetFutureOf(futureName string)

func (*FtxClientHeader) GetFutureStatsOf

func (header *FtxClientHeader) GetFutureStatsOf(futureName string)

func (*FtxClientHeader) GetFutures

func (header *FtxClientHeader) GetFutures()

func (*FtxClientHeader) GetHistoricalIndexOf

func (header *FtxClientHeader) GetHistoricalIndexOf(marketName string, resolution string, params ...string)

GetHistoricalIndexOf /indexes/{market_name}/candles?resolution={resolution}&limit={limit}&start_time={start_time}&end_time={end_time} marketName, resolution: required params 1 element: index 0 == limit params 2 elements: index 0 == start_time, index 1 == end_time params 3 elements: index 0 == limit, index 1 == start_time, index 2 == end_time

func (*FtxClientHeader) GetIndexWeightOf

func (header *FtxClientHeader) GetIndexWeightOf(index string)

func (*FtxClientHeader) GetMarketOf

func (header *FtxClientHeader) GetMarketOf(marketName string)

func (*FtxClientHeader) GetMarkets

func (header *FtxClientHeader) GetMarkets()

func (*FtxClientHeader) GetOrderbookOf

func (header *FtxClientHeader) GetOrderbookOf(marketName string, depth string)

func (*FtxClientHeader) GetPositions

func (header *FtxClientHeader) GetPositions()

func (*FtxClientHeader) GetSavedAddresses

func (header *FtxClientHeader) GetSavedAddresses(coin ...string)

GetSavedAddresses https://docs.ftx.com/#get-saved-addresses

func (*FtxClientHeader) GetSubaccounts

func (header *FtxClientHeader) GetSubaccounts()

func (*FtxClientHeader) GetTrades

func (header *FtxClientHeader) GetTrades(marketName string, params ...int)

func (*FtxClientHeader) GetWithdrawals

func (header *FtxClientHeader) GetWithdrawals(params ...string)

GetWithdrawals params 1 element: index 0 == limit params 2 elements: index 0 == start_time, index 1 == end_time params 3 elements: index 0 == limit, index 1 == start_time, index 2 == end_time https://docs.ftx.com/#get-deposit-history