rest

Apr 26, 2024

Changes in this version

type ClientRest

+ func NewClientWithIP(apiKey, secretKey, passphrase string, baseURL okx.BaseURL, ...) *ClientRest

Mar 17, 2024

Changes in this version

type Account

+ func (c *Account) SetAccountLevel(req requests.SetAccountLevel) (response responses.SetAccountLevel, err error)

Mar 17, 2024

Changes in this version

type PublicData

+ func (c *PublicData) GetFundingRate(req requests.GetFundingRate) (response responses.GetFundingRate, err error)

Mar 16, 2024

Changes in this version

type Account

+ func (c *Account) GetInterestLimits(req requests.GetInterestLimits) (response responses.GetInterestLimits, err error)

Mar 13, 2024

Changes in this version

type Account

+ func (c *Account) SetAutoLoan(req requests.SetAutoLoan) (response responses.SetAutoLoan, err error)

Feb 27, 2024

Changes in this version

+ type Account struct

+ func NewAccount(c *ClientRest) *Account

+ func (c *Account) GetAccountAndPositionRisk(req requests.GetAccountAndPositionRisk) (response responses.GetAccountAndPositionRisk, err error)

+ func (c *Account) GetBalance(req requests.GetBalance) (response responses.GetBalance, err error)

+ func (c *Account) GetBills(req requests.GetBills, arc bool) (response responses.GetBills, err error)

+ func (c *Account) GetConfig() (response responses.GetConfig, err error)

+ func (c *Account) GetFeeRates(req requests.GetFeeRates) (response responses.GetFeeRates, err error)

+ func (c *Account) GetInterestAccrued(req requests.GetInterestAccrued) (response responses.GetInterestAccrued, err error)

+ func (c *Account) GetInterestRates(req requests.GetBalance) (response responses.GetInterestRates, err error)

+ func (c *Account) GetLeverage(req requests.GetLeverage) (response responses.Leverage, err error)

+ func (c *Account) GetMaxAvailableTradeAmount(req requests.GetMaxAvailableTradeAmount) (response responses.GetMaxAvailableTradeAmount, err error)

+ func (c *Account) GetMaxBuySellAmount(req requests.GetMaxBuySellAmount) (response responses.GetMaxBuySellAmount, err error)

+ func (c *Account) GetMaxLoan(req requests.GetMaxLoan) (response responses.GetMaxLoan, err error)

+ func (c *Account) GetMaxWithdrawals(req requests.GetBalance) (response responses.GetMaxWithdrawals, err error)

+ func (c *Account) GetPositions(req requests.GetPositions) (response responses.GetPositions, err error)

+ func (c *Account) IncreaseDecreaseMargin(req requests.IncreaseDecreaseMargin) (response responses.IncreaseDecreaseMargin, err error)

+ func (c *Account) SetGreeks(req requests.SetGreeks) (response responses.SetGreeks, err error)

+ func (c *Account) SetLeverage(req requests.SetLeverage) (response responses.Leverage, err error)

+ func (c *Account) SetPositionMode(req requests.SetPositionMode) (response responses.SetPositionMode, err error)

+ type ClientRest struct

+ Account *Account

+ Client *http.Client

+ Funding *Funding

+ Market *Market

+ PublicData *PublicData

+ SubAccount *SubAccount

+ Trade *Trade

+ TradeData *TradeData

+ func NewClient(apiKey, secretKey, passphrase string, baseURL okex.BaseURL, ...) *ClientRest

+ func (c *ClientRest) Do(method, path string, private bool, params ...map[string]string) (*http.Response, error)

+ func (c *ClientRest) DoBatch(path string, params interface{}) (*http.Response, error)

+ func (c *ClientRest) Status(req requests.Status) (response responses.Status, err error)

+ type Funding struct

+ func NewFunding(c *ClientRest) *Funding

+ func (c *Funding) AssetBillsDetails(req requests.AssetBillsDetails) (response responses.AssetBillsDetails, err error)

+ func (c *Funding) FundsTransfer(req requests.FundsTransfer) (response responses.FundsTransfer, err error)

+ func (c *Funding) FundsTransferState(req requests.FundsTransferState) (response responses.FundsTransferState, err error)

+ func (c *Funding) GetBalance(req requests.GetBalance) (response responses.GetBalance, err error)

+ func (c *Funding) GetCurrencies() (response responses.GetCurrencies, err error)

+ func (c *Funding) GetDepositAddress(req requests.GetDepositAddress) (response responses.GetDepositAddress, err error)

+ func (c *Funding) GetDepositHistory(req requests.GetDepositHistory) (response responses.GetDepositHistory, err error)

+ func (c *Funding) GetPiggyBankBalance(req requests.GetPiggyBankBalance) (response responses.GetPiggyBankBalance, err error)

+ func (c *Funding) GetWithdrawalHistory(req requests.GetWithdrawalHistory) (response responses.GetWithdrawalHistory, err error)

+ func (c *Funding) PiggyBankPurchaseRedemption(req requests.PiggyBankPurchaseRedemption) (response responses.PiggyBankPurchaseRedemption, err error)

+ func (c *Funding) SmallAssetConvert(req requests.SmallAssetConvert) (response responses.SmallAssetConvert, err error)

+ func (c *Funding) Withdrawal(req requests.Withdrawal) (response responses.Withdrawal, err error)

+ type Market struct

+ func NewMarket(c *ClientRest) *Market

+ func (c *Market) Candlesticks(req requests.Candlesticks) (response responses.Candlesticks, err error)

+ func (c *Market) CandlesticksHistory(req requests.Candlesticks) (response responses.Candlesticks, err error)

+ func (c *Market) Get24HTotalVolume() (response responses.TotalVolume24H, err error)

+ func (c *Market) GetIndexCandlesticks(req requests.GetCandlesticks) (response responses.IndexCandle, err error)

+ func (c *Market) GetIndexComponents(req requests.GetIndexComponents) (response responses.IndexComponent, err error)

+ func (c *Market) GetIndexTickers(req requests.GetIndexTickers) (response responses.Ticker, err error)

+ func (c *Market) GetMarkPriceCandlesticks(req requests.GetCandlesticks) (response responses.CandleMarket, err error)

+ func (c *Market) GetOrderBook(req requests.GetOrderBook) (response responses.OrderBook, err error)

+ func (c *Market) GetTicker(req requests.GetTicker) (response responses.Ticker, err error)

+ func (c *Market) GetTickers(req requests.GetTickers) (response responses.Ticker, err error)

+ func (c *Market) GetTrades(req requests.GetTrades) (response responses.Trade, err error)

+ type PublicData struct

+ func NewPublicData(c *ClientRest) *PublicData

+ func (c *PublicData) ConvertUnit(req requests.UnitConvert) (response responses.UnitConvert, err error)

+ func (c *PublicData) GetDeliveryExerciseHistory(req requests.GetDeliveryExerciseHistory) (response responses.GetDeliveryExerciseHistory, err error)

+ func (c *PublicData) GetDiscountRateAndInterestFreeQuota(req requests.GetDiscountRateAndInterestFreeQuota) (response responses.GetDiscountRateAndInterestFreeQuota, err error)

+ func (c *PublicData) GetEstimatedDeliveryExercisePrice(req requests.GetEstimatedDeliveryExercisePrice) (response responses.GetEstimatedDeliveryExercisePrice, err error)

+ func (c *PublicData) GetInstruments(req requests.GetInstruments) (response responses.GetInstruments, err error)

+ func (c *PublicData) GetInterestRateAndLoanQuota() (response responses.GetInterestRateAndLoanQuota, err error)

+ func (c *PublicData) GetLimitPrice(req requests.GetLimitPrice) (response responses.GetLimitPrice, err error)

+ func (c *PublicData) GetLiquidationOrders(req requests.GetLiquidationOrders) (response responses.GetLiquidationOrders, err error)

+ func (c *PublicData) GetMarkPrice(req requests.GetMarkPrice) (response responses.GetMarkPrice, err error)

+ func (c *PublicData) GetOpenInterest(req requests.GetOpenInterest) (response responses.GetOpenInterest, err error)

+ func (c *PublicData) GetOptionMarketData(req requests.GetOptionMarketData) (response responses.GetOptionMarketData, err error)

+ func (c *PublicData) GetPositionTiers(req requests.GetPositionTiers) (response responses.GetPositionTiers, err error)

+ func (c *PublicData) GetSystemTime() (response responses.GetSystemTime, err error)

+ func (c *PublicData) GetUnderlying(req requests.GetUnderlying) (response responses.GetUnderlying, err error)

+ type SubAccount struct

+ func NewSubAccount(c *ClientRest) *SubAccount

+ func (c *SubAccount) CreateAPIKey(req requests.CreateAPIKey) (response responses.APIKey, err error)

+ func (c *SubAccount) CreateAPIKeySubAccount(req requests.CreatAPIKeySubAccount) (response responses.CreatAPIKeySubAccount, err error)

+ func (c *SubAccount) CreateDepositAddressSubAccount(req requests.CreateDepositAddress) (response responses.CreateDepositAddress, err error)

+ func (c *SubAccount) CreateSubAccount(req requests.CreateSubAccount) (response responses.CreateSubAccount, err error)

+ func (c *SubAccount) DeleteAPIKEySubAccount(req requests.DeleteAPIKeySubAccount) (response responses.DeleteAPIKeySubAccount, err error)

+ func (c *SubAccount) DeleteAPIKey(req requests.DeleteAPIKey) (response responses.APIKey, err error)

+ func (c *SubAccount) DeleteSubAccount(req requests.DeleteSubAccount) (response responses.DeleteSubAccount, err error)

+ func (c *SubAccount) GetBalance(req requests.GetBalance) (response responses.GetBalance, err error)

+ func (c *SubAccount) GetBalancesFunding(req requests.GetBalancesFunding) (response responses.GetBalancesFunding, err error)

+ func (c *SubAccount) GetDepositAddressSubAccount(req requests.GetDepositAddress) (response responses.GetDepositAddress, err error)

+ func (c *SubAccount) GetDepositHistorySubAccount(req requests.GetDepositHistory) (response responses.GetDepositHistory, err error)

+ func (c *SubAccount) GetFeeRatesSubAccount(req requests.GetFeeRatesSubAccount) (response responses.GetFeeRatesSubAccount, err error)

+ func (c *SubAccount) GetWithdrawHistorySubAccount(req requests.GetWithdrawHistory) (response responses.GetWithdrawHistory, err error)

+ func (c *SubAccount) HistoryTransfer(req requests.HistoryTransfer) (response responses.HistoryTransfer, err error)

+ func (c *SubAccount) ListSubAccount(req requests.ListSubAccount) (response responses.ListSubAccount, err error)

+ func (c *SubAccount) ManageTransfers(req requests.ManageTransfers) (response responses.ManageTransfer, err error)

+ func (c *SubAccount) QueryAPIKey(req requests.QueryAPIKey) (response responses.QueryAPIKey, err error)

+ func (c *SubAccount) ResetAPIKey(req requests.ResetAPIKey) (response responses.ResetAPIKey, err error)

+ func (c *SubAccount) SetFeeRateSubAccount(req requests.SetFeeRateSubAccount) (response responses.SetFeeRateSubAccount, err error)

+ func (c *SubAccount) SetLevelSubAccount(req requests.SetLevelSubAccount) (response responses.SetLevelSubAccount, err error)

+ func (c *SubAccount) UpdateAPIKeySubAccount(req requests.UpdateAPIKEySubAccount) (response responses.UpdateAPIKEySubAccount, err error)

+ func (c *SubAccount) UpdateDepositAddressSubAccount(req requests.UpdateDepositAddress) (response responses.UpdateDepositAddress, err error)

+ func (c *SubAccount) ViewList(req requests.ViewList) (response responses.ViewList, err error)

+ type Trade struct

+ func NewTrade(c *ClientRest) *Trade

+ func (c *Trade) AmendOrder(req []requests.AmendOrder) (response responses.AmendOrder, err error)

+ func (c *Trade) CancelAdvanceAlgoOrder(req []requests.CancelAlgoOrder) (response responses.CancelAlgoOrder, err error)

+ func (c *Trade) CancelAlgoOrder(req []requests.CancelAlgoOrder) (response responses.CancelAlgoOrder, err error)

+ func (c *Trade) CancelOrder(req []requests.CancelOrder) (response responses.CancelOrder, err error)

+ func (c *Trade) ClosePosition(req requests.ClosePosition) (response responses.ClosePosition, err error)

+ func (c *Trade) GetAlgoOrderList(req requests.AlgoOrderList, arch bool) (response responses.AlgoOrderList, err error)

+ func (c *Trade) GetOrderDetail(req requests.OrderDetails) (response responses.OrderList, err error)

+ func (c *Trade) GetOrderHistory(req requests.OrderList, arch bool) (response responses.OrderList, err error)

+ func (c *Trade) GetOrderList(req requests.OrderList) (response responses.OrderList, err error)

+ func (c *Trade) GetTransactionDetails(req requests.TransactionDetails, arch bool) (response responses.TransactionDetail, err error)

+ func (c *Trade) PlaceAlgoOrder(req requests.PlaceAlgoOrder) (response responses.PlaceAlgoOrder, err error)

+ func (c *Trade) PlaceMultipleOrders(req []requests.PlaceOrder) (response responses.PlaceOrder, err error)

+ func (c *Trade) PlaceOrder(req requests.PlaceOrder) (response responses.PlaceOrder, err error)

+ type TradeData struct

+ func NewTradeData(c *ClientRest) *TradeData

+ func (c *TradeData) GetContractsOpenInterestAndVolume(req requests.GetRatio) (response responses.GetOpenInterestAndVolume, err error)

+ func (c *TradeData) GetLongShortRatio(req requests.GetRatio) (response responses.GetRatio, err error)

+ func (c *TradeData) GetMarginLendingRatio(req requests.GetRatio) (response responses.GetRatio, err error)

+ func (c *TradeData) GetOpenInterestAndVolumeExpiry(req requests.GetRatio) (response responses.GetOpenInterestAndVolumeExpiry, err error)

+ func (c *TradeData) GetOpenInterestAndVolumeStrike(req requests.GetOpenInterestAndVolumeStrike) (response responses.GetOpenInterestAndVolumeStrike, err error)

+ func (c *TradeData) GetOptionsOpenInterestAndVolume(req requests.GetRatio) (response responses.GetOpenInterestAndVolume, err error)

+ func (c *TradeData) GetPutCallRatio(req requests.GetRatio) (response responses.GetPutCallRatio, err error)

+ func (c *TradeData) GetSupportCoin() (response responses.GetSupportCoin, err error)

+ func (c *TradeData) GetTakerFlow(req requests.GetRatio) (response responses.GetTakerFlow, err error)

+ func (c *TradeData) GetTakerVolume(req requests.GetTakerVolume) (response responses.GetTakerVolume, err error)