2551 lines
93 KiB
Go
2551 lines
93 KiB
Go
package ccxt
|
||
|
||
type Okx struct {
|
||
*okx
|
||
Core *okx
|
||
}
|
||
|
||
func NewOkx(userConfig map[string]interface{}) Okx {
|
||
p := &okx{}
|
||
p.Init(userConfig)
|
||
return Okx{
|
||
okx: p,
|
||
Core: p,
|
||
}
|
||
}
|
||
|
||
// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
|
||
// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
|
||
|
||
|
||
/**
|
||
* @method
|
||
* @name okx#fetchStatus
|
||
* @description the latest known information on the availability of the exchange API
|
||
* @see https://www.okx.com/docs-v5/en/#status-get-status
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [status structure]{@link https://docs.ccxt.com/#/?id=exchange-status-structure}
|
||
*/
|
||
func (this *Okx) FetchStatus(params ...interface{}) (map[string]interface{}, error) {
|
||
res := <- this.Core.FetchStatus(params...)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTime
|
||
* @description fetches the current integer timestamp in milliseconds from the exchange server
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-system-time
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {int} the current integer timestamp in milliseconds from the exchange server
|
||
*/
|
||
func (this *Okx) FetchTime(params ...interface{}) ( int64, error) {
|
||
res := <- this.Core.FetchTime(params...)
|
||
if IsError(res) {
|
||
return -1, CreateReturnError(res)
|
||
}
|
||
return (res).(int64), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchAccounts
|
||
* @description fetch all the accounts associated with a profile
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [account structures]{@link https://docs.ccxt.com/#/?id=account-structure} indexed by the account type
|
||
*/
|
||
func (this *Okx) FetchAccounts(params ...interface{}) ([]Account, error) {
|
||
res := <- this.Core.FetchAccounts(params...)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewAccountArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMarkets
|
||
* @description retrieves data on all markets for okx
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-instruments
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object[]} an array of objects representing market data
|
||
*/
|
||
func (this *Okx) FetchMarkets(params ...interface{}) ([]MarketInterface, error) {
|
||
res := <- this.Core.FetchMarkets(params...)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewMarketInterfaceArray(res), nil
|
||
}
|
||
func (this *Okx) FetchMarketsByType(typeVar interface{}, options ...FetchMarketsByTypeOptions) ([]MarketInterface, error) {
|
||
|
||
opts := FetchMarketsByTypeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMarketsByType(typeVar, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewMarketInterfaceArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOrderBook
|
||
* @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-order-book
|
||
* @param {string} symbol unified symbol of the market to fetch the order book for
|
||
* @param {int} [limit] the maximum amount of order book entries to return
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.method] 'publicGetMarketBooksFull' or 'publicGetMarketBooks' default is 'publicGetMarketBooks'
|
||
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
|
||
*/
|
||
func (this *Okx) FetchOrderBook(symbol string, options ...FetchOrderBookOptions) (OrderBook, error) {
|
||
|
||
opts := FetchOrderBookOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOrderBook(symbol, limit, params)
|
||
if IsError(res) {
|
||
return OrderBook{}, CreateReturnError(res)
|
||
}
|
||
return NewOrderBook(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTicker
|
||
* @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker
|
||
* @param {string} symbol unified symbol of the market to fetch the ticker for
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
||
*/
|
||
func (this *Okx) FetchTicker(symbol string, options ...FetchTickerOptions) (Ticker, error) {
|
||
|
||
opts := FetchTickerOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTicker(symbol, params)
|
||
if IsError(res) {
|
||
return Ticker{}, CreateReturnError(res)
|
||
}
|
||
return NewTicker(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTickers
|
||
* @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers
|
||
* @param {string[]} [symbols] unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
||
*/
|
||
func (this *Okx) FetchTickers(options ...FetchTickersOptions) (Tickers, error) {
|
||
|
||
opts := FetchTickersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbols interface{} = nil
|
||
if opts.Symbols != nil {
|
||
symbols = *opts.Symbols
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTickers(symbols, params)
|
||
if IsError(res) {
|
||
return Tickers{}, CreateReturnError(res)
|
||
}
|
||
return NewTickers(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMarkPrice
|
||
* @description fetches mark price for the market
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-mark-price
|
||
* @param {string} symbol unified symbol of the market to fetch the ticker for
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
||
*/
|
||
func (this *Okx) FetchMarkPrice(symbol string, options ...FetchMarkPriceOptions) (Ticker, error) {
|
||
|
||
opts := FetchMarkPriceOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMarkPrice(symbol, params)
|
||
if IsError(res) {
|
||
return Ticker{}, CreateReturnError(res)
|
||
}
|
||
return NewTicker(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMarkPrices
|
||
* @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-mark-price
|
||
* @param {string[]} [symbols] unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
||
*/
|
||
func (this *Okx) FetchMarkPrices(options ...FetchMarkPricesOptions) (Tickers, error) {
|
||
|
||
opts := FetchMarkPricesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbols interface{} = nil
|
||
if opts.Symbols != nil {
|
||
symbols = *opts.Symbols
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMarkPrices(symbols, params)
|
||
if IsError(res) {
|
||
return Tickers{}, CreateReturnError(res)
|
||
}
|
||
return NewTickers(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTrades
|
||
* @description get the list of most recent trades for a particular symbol
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-trades
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-option-trades
|
||
* @param {string} symbol unified symbol of the market to fetch trades for
|
||
* @param {int} [since] timestamp in ms of the earliest trade to fetch
|
||
* @param {int} [limit] the maximum amount of trades to fetch
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.method] 'publicGetMarketTrades' or 'publicGetMarketHistoryTrades' default is 'publicGetMarketTrades'
|
||
* @param {boolean} [params.paginate] *only applies to publicGetMarketHistoryTrades* default false, when true will automatically paginate by calling this endpoint multiple times
|
||
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
|
||
*/
|
||
func (this *Okx) FetchTrades(symbol string, options ...FetchTradesOptions) ([]Trade, error) {
|
||
|
||
opts := FetchTradesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTrades(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTradeArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOHLCV
|
||
* @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks-history
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks-history
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks-history
|
||
* @param {string} symbol unified symbol of the market to fetch OHLCV data for
|
||
* @param {string} timeframe the length of time each candle represents
|
||
* @param {int} [since] timestamp in ms of the earliest candle to fetch
|
||
* @param {int} [limit] the maximum amount of candles to fetch
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.price] "mark" or "index" for mark price and index price candles
|
||
* @param {int} [params.until] timestamp in ms of the latest candle to fetch
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
|
||
*/
|
||
func (this *Okx) FetchOHLCV(symbol string, options ...FetchOHLCVOptions) ([]OHLCV, error) {
|
||
|
||
opts := FetchOHLCVOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var timeframe interface{} = nil
|
||
if opts.Timeframe != nil {
|
||
timeframe = *opts.Timeframe
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOHLCV(symbol, timeframe, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOHLCVArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchFundingRateHistory
|
||
* @description fetches historical funding rate prices
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate-history
|
||
* @param {string} symbol unified symbol of the market to fetch the funding rate history for
|
||
* @param {int} [since] timestamp in ms of the earliest funding rate to fetch
|
||
* @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure}
|
||
*/
|
||
func (this *Okx) FetchFundingRateHistory(options ...FetchFundingRateHistoryOptions) ([]FundingRateHistory, error) {
|
||
|
||
opts := FetchFundingRateHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchFundingRateHistory(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewFundingRateHistoryArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTradingFee
|
||
* @description fetch the trading fees for a market
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-fee-rates
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [fee structure]{@link https://docs.ccxt.com/#/?id=fee-structure}
|
||
*/
|
||
func (this *Okx) FetchTradingFee(symbol string, options ...FetchTradingFeeOptions) (TradingFeeInterface, error) {
|
||
|
||
opts := FetchTradingFeeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTradingFee(symbol, params)
|
||
if IsError(res) {
|
||
return TradingFeeInterface{}, CreateReturnError(res)
|
||
}
|
||
return NewTradingFeeInterface(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchBalance
|
||
* @description query for balance and get the amount of funds available for trading or funds locked in orders
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-balance
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-balance
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.type] wallet type, ['funding' or 'trading'] default is 'trading'
|
||
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
|
||
*/
|
||
func (this *Okx) FetchBalance(params ...interface{}) (Balances, error) {
|
||
res := <- this.Core.FetchBalance(params...)
|
||
if IsError(res) {
|
||
return Balances{}, CreateReturnError(res)
|
||
}
|
||
return NewBalances(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#createMarketBuyOrderWithCost
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order
|
||
* @description create a market buy order by providing the symbol and cost
|
||
* @param {string} symbol unified symbol of the market to create an order in
|
||
* @param {float} cost how much you want to trade in units of the quote currency
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CreateMarketBuyOrderWithCost(symbol string, cost float64, options ...CreateMarketBuyOrderWithCostOptions) (Order, error) {
|
||
|
||
opts := CreateMarketBuyOrderWithCostOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CreateMarketBuyOrderWithCost(symbol, cost, params)
|
||
if IsError(res) {
|
||
return Order{}, CreateReturnError(res)
|
||
}
|
||
return NewOrder(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#createMarketSellOrderWithCost
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order
|
||
* @description create a market buy order by providing the symbol and cost
|
||
* @param {string} symbol unified symbol of the market to create an order in
|
||
* @param {float} cost how much you want to trade in units of the quote currency
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CreateMarketSellOrderWithCost(symbol string, cost float64, options ...CreateMarketSellOrderWithCostOptions) (Order, error) {
|
||
|
||
opts := CreateMarketSellOrderWithCostOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CreateMarketSellOrderWithCost(symbol, cost, params)
|
||
if IsError(res) {
|
||
return Order{}, CreateReturnError(res)
|
||
}
|
||
return NewOrder(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#createOrder
|
||
* @description create a trade order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-place-algo-order
|
||
* @param {string} symbol unified symbol of the market to create an order in
|
||
* @param {string} type 'market' or 'limit'
|
||
* @param {string} side 'buy' or 'sell'
|
||
* @param {float} amount how much of currency you want to trade in units of base currency
|
||
* @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {bool} [params.reduceOnly] a mark to reduce the position size for margin, swap and future orders
|
||
* @param {bool} [params.postOnly] true to place a post only order
|
||
* @param {object} [params.takeProfit] *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
|
||
* @param {float} [params.takeProfit.triggerPrice] take profit trigger price
|
||
* @param {float} [params.takeProfit.price] used for take profit limit orders, not used for take profit market price orders
|
||
* @param {string} [params.takeProfit.type] 'market' or 'limit' used to specify the take profit price type
|
||
* @param {object} [params.stopLoss] *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
|
||
* @param {float} [params.stopLoss.triggerPrice] stop loss trigger price
|
||
* @param {float} [params.stopLoss.price] used for stop loss limit orders, not used for stop loss market price orders
|
||
* @param {string} [params.stopLoss.type] 'market' or 'limit' used to specify the stop loss price type
|
||
* @param {string} [params.positionSide] if position mode is one-way: set to 'net', if position mode is hedge-mode: set to 'long' or 'short'
|
||
* @param {string} [params.trailingPercent] the percent to trail away from the current market price
|
||
* @param {string} [params.tpOrdKind] 'condition' or 'limit', the default is 'condition'
|
||
* @param {bool} [params.hedged] *swap and future only* true for hedged mode, false for one way mode
|
||
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CreateOrder(symbol string, typeVar string, side string, amount float64, options ...CreateOrderOptions) (Order, error) {
|
||
|
||
opts := CreateOrderOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var price interface{} = nil
|
||
if opts.Price != nil {
|
||
price = *opts.Price
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CreateOrder(symbol, typeVar, side, amount, price, params)
|
||
if IsError(res) {
|
||
return Order{}, CreateReturnError(res)
|
||
}
|
||
return NewOrder(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#createOrders
|
||
* @description create a list of trade orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders
|
||
* @param {Array} orders list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CreateOrders(orders []OrderRequest, options ...CreateOrdersOptions) ([]Order, error) {
|
||
|
||
opts := CreateOrdersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CreateOrders(orders, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#editOrder
|
||
* @description edit a trade order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-amend-order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-amend-algo-order
|
||
* @param {string} id order id
|
||
* @param {string} symbol unified symbol of the market to create an order in
|
||
* @param {string} type 'market' or 'limit'
|
||
* @param {string} side 'buy' or 'sell'
|
||
* @param {float} amount how much of the currency you want to trade in units of the base currency
|
||
* @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.clientOrderId] client order id, uses id if not passed
|
||
* @param {float} [params.stopLossPrice] stop loss trigger price
|
||
* @param {float} [params.newSlOrdPx] the stop loss order price, set to stopLossPrice if the type is market
|
||
* @param {string} [params.newSlTriggerPxType] 'last', 'index' or 'mark' used to specify the stop loss trigger price type, default is 'last'
|
||
* @param {float} [params.takeProfitPrice] take profit trigger price
|
||
* @param {float} [params.newTpOrdPx] the take profit order price, set to takeProfitPrice if the type is market
|
||
* @param {string} [params.newTpTriggerPxType] 'last', 'index' or 'mark' used to specify the take profit trigger price type, default is 'last'
|
||
* @param {object} [params.stopLoss] *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered
|
||
* @param {float} [params.stopLoss.triggerPrice] stop loss trigger price
|
||
* @param {float} [params.stopLoss.price] used for stop loss limit orders, not used for stop loss market price orders
|
||
* @param {string} [params.stopLoss.type] 'market' or 'limit' used to specify the stop loss price type
|
||
* @param {object} [params.takeProfit] *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered
|
||
* @param {float} [params.takeProfit.triggerPrice] take profit trigger price
|
||
* @param {float} [params.takeProfit.price] used for take profit limit orders, not used for take profit market price orders
|
||
* @param {string} [params.takeProfit.type] 'market' or 'limit' used to specify the take profit price type
|
||
* @param {string} [params.newTpOrdKind] 'condition' or 'limit', the default is 'condition'
|
||
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) EditOrder(id string, symbol string, typeVar string, side string, options ...EditOrderOptions) (Order, error) {
|
||
|
||
opts := EditOrderOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var amount interface{} = nil
|
||
if opts.Amount != nil {
|
||
amount = *opts.Amount
|
||
}
|
||
|
||
var price interface{} = nil
|
||
if opts.Price != nil {
|
||
price = *opts.Price
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.EditOrder(id, symbol, typeVar, side, amount, price, params)
|
||
if IsError(res) {
|
||
return Order{}, CreateReturnError(res)
|
||
}
|
||
return NewOrder(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#cancelOrder
|
||
* @description cancels an open order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order
|
||
* @param {string} id order id
|
||
* @param {string} symbol unified symbol of the market the order was made in
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {boolean} [params.trigger] true if trigger orders
|
||
* @param {boolean} [params.trailing] set to true if you want to cancel a trailing order
|
||
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CancelOrder(id string, options ...CancelOrderOptions) (map[string]interface{}, error) {
|
||
|
||
opts := CancelOrderOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CancelOrder(id, symbol, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#cancelOrders
|
||
* @description cancel multiple orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order
|
||
* @param {string[]} ids order ids
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {boolean} [params.trigger] whether the order is a stop/trigger order
|
||
* @param {boolean} [params.trailing] set to true if you want to cancel trailing orders
|
||
* @returns {object} an list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CancelOrders(ids interface{}, options ...CancelOrdersOptions) ([]Order, error) {
|
||
|
||
opts := CancelOrdersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CancelOrders(ids, symbol, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#cancelOrdersForSymbols
|
||
* @description cancel multiple orders for multiple symbols
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order
|
||
* @param {CancellationRequest[]} orders each order should contain the parameters required by cancelOrder namely id and symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}]
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {boolean} [params.trigger] whether the order is a stop/trigger order
|
||
* @param {boolean} [params.trailing] set to true if you want to cancel trailing orders
|
||
* @returns {object} an list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) CancelOrdersForSymbols(orders []CancellationRequest, options ...CancelOrdersForSymbolsOptions) ([]Order, error) {
|
||
|
||
opts := CancelOrdersForSymbolsOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CancelOrdersForSymbols(orders, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#cancelAllOrdersAfter
|
||
* @description dead man's switch, cancel all orders after the given timeout
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-all-after
|
||
* @param {number} timeout time in milliseconds, 0 represents cancel the timer
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} the api result
|
||
*/
|
||
func (this *Okx) CancelAllOrdersAfter(timeout int64, options ...CancelAllOrdersAfterOptions) (map[string]interface{}, error) {
|
||
|
||
opts := CancelAllOrdersAfterOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CancelAllOrdersAfter(timeout, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOrder
|
||
* @description fetch an order by the id
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-details
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-details
|
||
* @param {string} id the order id
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra and exchange specific parameters
|
||
* @param {boolean} [params.trigger] true if fetching trigger orders
|
||
* @returns [an order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) FetchOrder(id string, options ...FetchOrderOptions) (Order, error) {
|
||
|
||
opts := FetchOrderOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOrder(id, symbol, params)
|
||
if IsError(res) {
|
||
return Order{}, CreateReturnError(res)
|
||
}
|
||
return NewOrder(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOpenOrders
|
||
* @description fetch all unfilled currently open orders
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-list
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-list
|
||
* @param {string} symbol unified market symbol
|
||
* @param {int} [since] the earliest time in ms to fetch open orders for
|
||
* @param {int} [limit] the maximum number of open orders structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {bool} [params.trigger] True if fetching trigger or conditional orders
|
||
* @param {string} [params.ordType] "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap"
|
||
* @param {string} [params.algoId] Algo ID "'433845797218942976'"
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @param {boolean} [params.trailing] set to true if you want to fetch trailing orders
|
||
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) FetchOpenOrders(options ...FetchOpenOrdersOptions) ([]Order, error) {
|
||
|
||
opts := FetchOpenOrdersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOpenOrders(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchCanceledOrders
|
||
* @description fetches information on multiple canceled orders made by the user
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
|
||
* @param {string} symbol unified market symbol of the market orders were made in
|
||
* @param {int} [since] timestamp in ms of the earliest order, default is undefined
|
||
* @param {int} [limit] max number of orders to return, default is undefined
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {bool} [params.trigger] True if fetching trigger or conditional orders
|
||
* @param {string} [params.ordType] "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap"
|
||
* @param {string} [params.algoId] Algo ID "'433845797218942976'"
|
||
* @param {int} [params.until] timestamp in ms to fetch orders for
|
||
* @param {boolean} [params.trailing] set to true if you want to fetch trailing orders
|
||
* @returns {object} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) FetchCanceledOrders(options ...FetchCanceledOrdersOptions) ([]Order, error) {
|
||
|
||
opts := FetchCanceledOrdersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchCanceledOrders(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchClosedOrders
|
||
* @description fetches information on multiple closed orders made by the user
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-3-months
|
||
* @param {string} symbol unified market symbol of the market orders were made in
|
||
* @param {int} [since] the earliest time in ms to fetch orders for
|
||
* @param {int} [limit] the maximum number of order structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {bool} [params.trigger] True if fetching trigger or conditional orders
|
||
* @param {string} [params.ordType] "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap"
|
||
* @param {string} [params.algoId] Algo ID "'433845797218942976'"
|
||
* @param {int} [params.until] timestamp in ms to fetch orders for
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @param {string} [params.method] method to be used, either 'privateGetTradeOrdersHistory', 'privateGetTradeOrdersHistoryArchive' or 'privateGetTradeOrdersAlgoHistory' default is 'privateGetTradeOrdersHistory'
|
||
* @param {boolean} [params.trailing] set to true if you want to fetch trailing orders
|
||
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
||
*/
|
||
func (this *Okx) FetchClosedOrders(options ...FetchClosedOrdersOptions) ([]Order, error) {
|
||
|
||
opts := FetchClosedOrdersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchClosedOrders(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOrderArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMyTrades
|
||
* @description fetch all trades made by the user
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
|
||
* @param {string} symbol unified market symbol
|
||
* @param {int} [since] the earliest time in ms to fetch trades for
|
||
* @param {int} [limit] the maximum number of trades structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.until] Timestamp in ms of the latest time to retrieve trades for
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
|
||
*/
|
||
func (this *Okx) FetchMyTrades(options ...FetchMyTradesOptions) ([]Trade, error) {
|
||
|
||
opts := FetchMyTradesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMyTrades(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTradeArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOrderTrades
|
||
* @description fetch all the trades made from a single order
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
|
||
* @param {string} id order id
|
||
* @param {string} symbol unified market symbol
|
||
* @param {int} [since] the earliest time in ms to fetch trades for
|
||
* @param {int} [limit] the maximum number of trades to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
|
||
*/
|
||
func (this *Okx) FetchOrderTrades(id string, options ...FetchOrderTradesOptions) ([]Trade, error) {
|
||
|
||
opts := FetchOrderTradesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOrderTrades(id, symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTradeArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchLedger
|
||
* @description fetch the history of changes, actions done by the user or operations that altered balance of the user
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-7-days
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-3-months
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-asset-bills-details
|
||
* @param {string} [code] unified currency code, default is undefined
|
||
* @param {int} [since] timestamp in ms of the earliest ledger entry, default is undefined
|
||
* @param {int} [limit] max number of ledger entries to return, default is undefined
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.marginMode] 'cross' or 'isolated'
|
||
* @param {int} [params.until] the latest time in ms to fetch entries for
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [available parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {object} a [ledger structure]{@link https://docs.ccxt.com/#/?id=ledger}
|
||
*/
|
||
func (this *Okx) FetchLedger(options ...FetchLedgerOptions) ([]LedgerEntry, error) {
|
||
|
||
opts := FetchLedgerOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchLedger(code, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewLedgerEntryArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchDepositAddressesByNetwork
|
||
* @description fetch a dictionary of addresses for a currency, indexed by network
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
|
||
* @param {string} code unified currency code of the currency for the deposit address
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [address structures]{@link https://docs.ccxt.com/#/?id=address-structure} indexed by the network
|
||
*/
|
||
func (this *Okx) FetchDepositAddressesByNetwork(code string, options ...FetchDepositAddressesByNetworkOptions) ([]DepositAddress, error) {
|
||
|
||
opts := FetchDepositAddressesByNetworkOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchDepositAddressesByNetwork(code, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewDepositAddressArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchDepositAddress
|
||
* @description fetch the deposit address for a currency associated with this account
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
|
||
* @param {string} code unified currency code
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.network] the network name for the deposit address
|
||
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
||
*/
|
||
func (this *Okx) FetchDepositAddress(code string, options ...FetchDepositAddressOptions) (DepositAddress, error) {
|
||
|
||
opts := FetchDepositAddressOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchDepositAddress(code, params)
|
||
if IsError(res) {
|
||
return DepositAddress{}, CreateReturnError(res)
|
||
}
|
||
return NewDepositAddress(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#withdraw
|
||
* @description make a withdrawal
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-withdrawal
|
||
* @param {string} code unified currency code
|
||
* @param {float} amount the amount to withdraw
|
||
* @param {string} address the address to withdraw to
|
||
* @param {string} tag
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
||
*/
|
||
func (this *Okx) Withdraw(code string, amount float64, address string, options ...WithdrawOptions) (Transaction, error) {
|
||
|
||
opts := WithdrawOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var tag interface{} = nil
|
||
if opts.Tag != nil {
|
||
tag = *opts.Tag
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.Withdraw(code, amount, address, tag, params)
|
||
if IsError(res) {
|
||
return Transaction{}, CreateReturnError(res)
|
||
}
|
||
return NewTransaction(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchDeposits
|
||
* @description fetch all deposits made to an account
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history
|
||
* @param {string} code unified currency code
|
||
* @param {int} [since] the earliest time in ms to fetch deposits for
|
||
* @param {int} [limit] the maximum number of deposits structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.until] the latest time in ms to fetch entries for
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
||
*/
|
||
func (this *Okx) FetchDeposits(options ...FetchDepositsOptions) ([]Transaction, error) {
|
||
|
||
opts := FetchDepositsOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchDeposits(code, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTransactionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchDeposit
|
||
* @description fetch data on a currency deposit via the deposit id
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history
|
||
* @param {string} id deposit id
|
||
* @param {string} code filter by currency code
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
||
*/
|
||
func (this *Okx) FetchDeposit(id string, options ...FetchDepositOptions) (Transaction, error) {
|
||
|
||
opts := FetchDepositOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchDeposit(id, code, params)
|
||
if IsError(res) {
|
||
return Transaction{}, CreateReturnError(res)
|
||
}
|
||
return NewTransaction(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchWithdrawals
|
||
* @description fetch all withdrawals made from an account
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history
|
||
* @param {string} code unified currency code
|
||
* @param {int} [since] the earliest time in ms to fetch withdrawals for
|
||
* @param {int} [limit] the maximum number of withdrawals structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.until] the latest time in ms to fetch entries for
|
||
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
||
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
||
*/
|
||
func (this *Okx) FetchWithdrawals(options ...FetchWithdrawalsOptions) ([]Transaction, error) {
|
||
|
||
opts := FetchWithdrawalsOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchWithdrawals(code, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTransactionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchWithdrawal
|
||
* @description fetch data on a currency withdrawal via the withdrawal id
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history
|
||
* @param {string} id withdrawal id
|
||
* @param {string} code unified currency code of the currency withdrawn, default is undefined
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
||
*/
|
||
func (this *Okx) FetchWithdrawal(id string, options ...FetchWithdrawalOptions) (Transaction, error) {
|
||
|
||
opts := FetchWithdrawalOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchWithdrawal(id, code, params)
|
||
if IsError(res) {
|
||
return Transaction{}, CreateReturnError(res)
|
||
}
|
||
return NewTransaction(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchLeverage
|
||
* @description fetch the set leverage for a market
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-leverage
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.marginMode] 'cross' or 'isolated'
|
||
* @returns {object} a [leverage structure]{@link https://docs.ccxt.com/#/?id=leverage-structure}
|
||
*/
|
||
func (this *Okx) FetchLeverage(symbol string, options ...FetchLeverageOptions) (Leverage, error) {
|
||
|
||
opts := FetchLeverageOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchLeverage(symbol, params)
|
||
if IsError(res) {
|
||
return Leverage{}, CreateReturnError(res)
|
||
}
|
||
return NewLeverage(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchPosition
|
||
* @description fetch data on a single open contract trade position
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
|
||
* @param {string} symbol unified market symbol of the market the position is held in, default is undefined
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.instType] MARGIN, SWAP, FUTURES, OPTION
|
||
* @returns {object} a [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
|
||
*/
|
||
func (this *Okx) FetchPosition(symbol string, options ...FetchPositionOptions) (Position, error) {
|
||
|
||
opts := FetchPositionOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchPosition(symbol, params)
|
||
if IsError(res) {
|
||
return Position{}, CreateReturnError(res)
|
||
}
|
||
return NewPosition(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchPositions
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-positions-history history
|
||
* @description fetch all open positions
|
||
* @param {string[]|undefined} symbols list of unified market symbols
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.instType] MARGIN, SWAP, FUTURES, OPTION
|
||
* @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
|
||
*/
|
||
func (this *Okx) FetchPositions(options ...FetchPositionsOptions) ([]Position, error) {
|
||
|
||
opts := FetchPositionsOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbols interface{} = nil
|
||
if opts.Symbols != nil {
|
||
symbols = *opts.Symbols
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchPositions(symbols, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewPositionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchPositionsForSymbol
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
|
||
* @description fetch all open positions for specific symbol
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.instType] MARGIN (if needed)
|
||
* @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
|
||
*/
|
||
func (this *Okx) FetchPositionsForSymbol(symbol string, options ...FetchPositionsForSymbolOptions) ([]Position, error) {
|
||
|
||
opts := FetchPositionsForSymbolOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchPositionsForSymbol(symbol, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewPositionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#transfer
|
||
* @description transfer currency internally between wallets on the same account
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-funds-transfer
|
||
* @param {string} code unified currency code
|
||
* @param {float} amount amount to transfer
|
||
* @param {string} fromAccount account to transfer from
|
||
* @param {string} toAccount account to transfer to
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
||
*/
|
||
func (this *Okx) Transfer(code string, amount float64, fromAccount string, toAccount string, options ...TransferOptions) (TransferEntry, error) {
|
||
|
||
opts := TransferOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.Transfer(code, amount, fromAccount, toAccount, params)
|
||
if IsError(res) {
|
||
return TransferEntry{}, CreateReturnError(res)
|
||
}
|
||
return NewTransferEntry(res), nil
|
||
}
|
||
func (this *Okx) FetchTransfer(id string, options ...FetchTransferOptions) (TransferEntry, error) {
|
||
|
||
opts := FetchTransferOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTransfer(id, code, params)
|
||
if IsError(res) {
|
||
return TransferEntry{}, CreateReturnError(res)
|
||
}
|
||
return NewTransferEntry(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchTransfers
|
||
* @description fetch a history of internal transfers made on an account
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
|
||
* @param {string} code unified currency code of the currency transferred
|
||
* @param {int} [since] the earliest time in ms to fetch transfers for
|
||
* @param {int} [limit] the maximum number of transfers structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object[]} a list of [transfer structures]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
||
*/
|
||
func (this *Okx) FetchTransfers(options ...FetchTransfersOptions) ([]TransferEntry, error) {
|
||
|
||
opts := FetchTransfersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchTransfers(code, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewTransferEntryArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchFundingInterval
|
||
* @description fetch the current funding rate interval
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
|
||
*/
|
||
func (this *Okx) FetchFundingInterval(symbol string, options ...FetchFundingIntervalOptions) (FundingRate, error) {
|
||
|
||
opts := FetchFundingIntervalOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchFundingInterval(symbol, params)
|
||
if IsError(res) {
|
||
return FundingRate{}, CreateReturnError(res)
|
||
}
|
||
return NewFundingRate(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchFundingRate
|
||
* @description fetch the current funding rate
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
|
||
*/
|
||
func (this *Okx) FetchFundingRate(symbol string, options ...FetchFundingRateOptions) (FundingRate, error) {
|
||
|
||
opts := FetchFundingRateOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchFundingRate(symbol, params)
|
||
if IsError(res) {
|
||
return FundingRate{}, CreateReturnError(res)
|
||
}
|
||
return NewFundingRate(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchFundingHistory
|
||
* @description fetch the history of funding payments paid and received on this account
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
|
||
* @param {string} symbol unified market symbol
|
||
* @param {int} [since] the earliest time in ms to fetch funding history for
|
||
* @param {int} [limit] the maximum number of funding history structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [funding history structure]{@link https://docs.ccxt.com/#/?id=funding-history-structure}
|
||
*/
|
||
func (this *Okx) FetchFundingHistory(options ...FetchFundingHistoryOptions) ([]FundingHistory, error) {
|
||
|
||
opts := FetchFundingHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchFundingHistory(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewFundingHistoryArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#setLeverage
|
||
* @description set the level of leverage for a market
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-set-leverage
|
||
* @param {float} leverage the rate of leverage
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.marginMode] 'cross' or 'isolated'
|
||
* @param {string} [params.posSide] 'long' or 'short' or 'net' for isolated margin long/short mode on futures and swap markets, default is 'net'
|
||
* @returns {object} response from the exchange
|
||
*/
|
||
func (this *Okx) SetLeverage(leverage int64, options ...SetLeverageOptions) (map[string]interface{}, error) {
|
||
|
||
opts := SetLeverageOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.SetLeverage(leverage, symbol, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchPositionMode
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration
|
||
* @description fetchs the position mode, hedged or one way, hedged for binance is set identically for all linear markets or all inverse markets
|
||
* @param {string} symbol unified symbol of the market to fetch the order book for
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.accountId] if you have multiple accounts, you must specify the account id to fetch the position mode
|
||
* @returns {object} an object detailing whether the market is in hedged or one-way mode
|
||
*/
|
||
func (this *Okx) FetchPositionMode(options ...FetchPositionModeOptions) (map[string]interface{}, error) {
|
||
|
||
opts := FetchPositionModeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchPositionMode(symbol, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#setPositionMode
|
||
* @description set hedged to true or false for a market
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-position-mode
|
||
* @param {bool} hedged set to true to use long_short_mode, false for net_mode
|
||
* @param {string} symbol not used by okx setPositionMode
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} response from the exchange
|
||
*/
|
||
func (this *Okx) SetPositionMode(hedged bool, options ...SetPositionModeOptions) (map[string]interface{}, error) {
|
||
|
||
opts := SetPositionModeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.SetPositionMode(hedged, symbol, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#setMarginMode
|
||
* @description set margin mode to 'cross' or 'isolated'
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-leverage
|
||
* @param {string} marginMode 'cross' or 'isolated'
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.leverage] leverage
|
||
* @returns {object} response from the exchange
|
||
*/
|
||
func (this *Okx) SetMarginMode(marginMode string, options ...SetMarginModeOptions) (map[string]interface{}, error) {
|
||
|
||
opts := SetMarginModeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.SetMarginMode(marginMode, symbol, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchCrossBorrowRates
|
||
* @description fetch the borrow interest rates of all currencies
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a list of [borrow rate structures]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure}
|
||
*/
|
||
func (this *Okx) FetchCrossBorrowRates(params ...interface{}) (CrossBorrowRates, error) {
|
||
res := <- this.Core.FetchCrossBorrowRates(params...)
|
||
if IsError(res) {
|
||
return CrossBorrowRates{}, CreateReturnError(res)
|
||
}
|
||
return NewCrossBorrowRates(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchCrossBorrowRate
|
||
* @description fetch the rate of interest to borrow a currency for margin trading
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
|
||
* @param {string} code unified currency code
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [borrow rate structure]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure}
|
||
*/
|
||
func (this *Okx) FetchCrossBorrowRate(code string, options ...FetchCrossBorrowRateOptions) (CrossBorrowRate, error) {
|
||
|
||
opts := FetchCrossBorrowRateOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchCrossBorrowRate(code, params)
|
||
if IsError(res) {
|
||
return CrossBorrowRate{}, CreateReturnError(res)
|
||
}
|
||
return NewCrossBorrowRate(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchBorrowRateHistories
|
||
* @description retrieves a history of a multiple currencies borrow interest rate at specific time slots, returns all currencies if no symbols passed, default is undefined
|
||
* @see https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
|
||
* @param {string[]|undefined} codes list of unified currency codes, default is undefined
|
||
* @param {int} [since] timestamp in ms of the earliest borrowRate, default is undefined
|
||
* @param {int} [limit] max number of borrow rate prices to return, default is undefined
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a dictionary of [borrow rate structures]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure} indexed by the market symbol
|
||
*/
|
||
func (this *Okx) FetchBorrowRateHistories(options ...FetchBorrowRateHistoriesOptions) (map[string]interface{}, error) {
|
||
|
||
opts := FetchBorrowRateHistoriesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var codes interface{} = nil
|
||
if opts.Codes != nil {
|
||
codes = *opts.Codes
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchBorrowRateHistories(codes, since, limit, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchBorrowRateHistory
|
||
* @description retrieves a history of a currencies borrow interest rate at specific time slots
|
||
* @see https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
|
||
* @param {string} code unified currency code
|
||
* @param {int} [since] timestamp for the earliest borrow rate
|
||
* @param {int} [limit] the maximum number of [borrow rate structures]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure} to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object[]} an array of [borrow rate structures]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure}
|
||
*/
|
||
func (this *Okx) FetchBorrowRateHistory(code string, options ...FetchBorrowRateHistoryOptions) (map[string]interface{}, error) {
|
||
|
||
opts := FetchBorrowRateHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchBorrowRateHistory(code, since, limit, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMarketLeverageTiers
|
||
* @description retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-position-tiers
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.marginMode] 'cross' or 'isolated'
|
||
* @returns {object} a [leverage tiers structure]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}
|
||
*/
|
||
func (this *Okx) FetchMarketLeverageTiers(symbol string, options ...FetchMarketLeverageTiersOptions) ([]LeverageTier, error) {
|
||
|
||
opts := FetchMarketLeverageTiersOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMarketLeverageTiers(symbol, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewLeverageTierArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchBorrowInterest
|
||
* @description fetch the interest owed by the user for borrowing currency for margin trading
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-account-get-interest-accrued-data
|
||
* @param {string} code the unified currency code for the currency of the interest
|
||
* @param {string} symbol the market symbol of an isolated margin market, if undefined, the interest for cross margin markets is returned
|
||
* @param {int} [since] timestamp in ms of the earliest time to receive interest records for
|
||
* @param {int} [limit] the number of [borrow interest structures]{@link https://docs.ccxt.com/#/?id=borrow-interest-structure} to retrieve
|
||
* @param {object} [params] exchange specific parameters
|
||
* @param {int} [params.type] Loan type 1 - VIP loans 2 - Market loans *Default is Market loans*
|
||
* @param {string} [params.marginMode] 'cross' or 'isolated'
|
||
* @returns {object[]} An list of [borrow interest structures]{@link https://docs.ccxt.com/#/?id=borrow-interest-structure}
|
||
*/
|
||
func (this *Okx) FetchBorrowInterest(options ...FetchBorrowInterestOptions) ([]BorrowInterest, error) {
|
||
|
||
opts := FetchBorrowInterestOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchBorrowInterest(code, symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewBorrowInterestArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOpenInterest
|
||
* @description Retrieves the open interest of a currency
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-open-interest
|
||
* @param {string} symbol Unified CCXT market symbol
|
||
* @param {object} [params] exchange specific parameters
|
||
* @returns {object} an open interest structure{@link https://docs.ccxt.com/#/?id=open-interest-structure}
|
||
*/
|
||
func (this *Okx) FetchOpenInterest(symbol string, options ...FetchOpenInterestOptions) (OpenInterest, error) {
|
||
|
||
opts := FetchOpenInterestOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOpenInterest(symbol, params)
|
||
if IsError(res) {
|
||
return OpenInterest{}, CreateReturnError(res)
|
||
}
|
||
return NewOpenInterest(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOpenInterestHistory
|
||
* @description Retrieves the open interest history of a currency
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-contracts-open-interest-and-volume
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-options-open-interest-and-volume
|
||
* @param {string} symbol Unified CCXT currency code or unified symbol
|
||
* @param {string} timeframe "5m", "1h", or "1d" for option only "1d" or "8h"
|
||
* @param {int} [since] The time in ms of the earliest record to retrieve as a unix timestamp
|
||
* @param {int} [limit] Not used by okx, but parsed internally by CCXT
|
||
* @param {object} [params] Exchange specific parameters
|
||
* @param {int} [params.until] The time in ms of the latest record to retrieve as a unix timestamp
|
||
* @returns An array of [open interest structures]{@link https://docs.ccxt.com/#/?id=open-interest-structure}
|
||
*/
|
||
func (this *Okx) FetchOpenInterestHistory(symbol string, options ...FetchOpenInterestHistoryOptions) ([]OpenInterest, error) {
|
||
|
||
opts := FetchOpenInterestHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var timeframe interface{} = nil
|
||
if opts.Timeframe != nil {
|
||
timeframe = *opts.Timeframe
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOpenInterestHistory(symbol, timeframe, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewOpenInterestArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchDepositWithdrawFees
|
||
* @description fetch deposit and withdraw fees
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies
|
||
* @param {string[]|undefined} codes list of unified currency codes
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object[]} a list of [fees structures]{@link https://docs.ccxt.com/#/?id=fee-structure}
|
||
*/
|
||
func (this *Okx) FetchDepositWithdrawFees(options ...FetchDepositWithdrawFeesOptions) (map[string]interface{}, error) {
|
||
|
||
opts := FetchDepositWithdrawFeesOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var codes interface{} = nil
|
||
if opts.Codes != nil {
|
||
codes = *opts.Codes
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchDepositWithdrawFees(codes, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchSettlementHistory
|
||
* @description fetches historical settlement records
|
||
* @see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-delivery-exercise-history
|
||
* @param {string} symbol unified market symbol to fetch the settlement history for
|
||
* @param {int} [since] timestamp in ms
|
||
* @param {int} [limit] number of records
|
||
* @param {object} [params] exchange specific params
|
||
* @returns {object[]} a list of [settlement history objects]{@link https://docs.ccxt.com/#/?id=settlement-history-structure}
|
||
*/
|
||
func (this *Okx) FetchSettlementHistory(options ...FetchSettlementHistoryOptions) (map[string]interface{}, error) {
|
||
|
||
opts := FetchSettlementHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchSettlementHistory(symbol, since, limit, params)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchUnderlyingAssets
|
||
* @description fetches the market ids of underlying assets for a specific contract market type
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-underlying
|
||
* @param {object} [params] exchange specific params
|
||
* @param {string} [params.type] the contract market type, 'option', 'swap' or 'future', the default is 'option'
|
||
* @returns {object[]} a list of [underlying assets]{@link https://docs.ccxt.com/#/?id=underlying-assets-structure}
|
||
*/
|
||
func (this *Okx) FetchUnderlyingAssets(params ...interface{}) (map[string]interface{}, error) {
|
||
res := <- this.Core.FetchUnderlyingAssets(params...)
|
||
if IsError(res) {
|
||
return map[string]interface{}{}, CreateReturnError(res)
|
||
}
|
||
return res.(map[string]interface{}), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchGreeks
|
||
* @description fetches an option contracts greeks, financial metrics used to measure the factors that affect the price of an options contract
|
||
* @see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-option-market-data
|
||
* @param {string} symbol unified symbol of the market to fetch greeks for
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [greeks structure]{@link https://docs.ccxt.com/#/?id=greeks-structure}
|
||
*/
|
||
func (this *Okx) FetchGreeks(symbol string, options ...FetchGreeksOptions) (Greeks, error) {
|
||
|
||
opts := FetchGreeksOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchGreeks(symbol, params)
|
||
if IsError(res) {
|
||
return Greeks{}, CreateReturnError(res)
|
||
}
|
||
return NewGreeks(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOption
|
||
* @description fetches option data that is commonly found in an option chain
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker
|
||
* @param {string} symbol unified market symbol
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} an [option chain structure]{@link https://docs.ccxt.com/#/?id=option-chain-structure}
|
||
*/
|
||
func (this *Okx) FetchOption(symbol string, options ...FetchOptionOptions) (Option, error) {
|
||
|
||
opts := FetchOptionOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOption(symbol, params)
|
||
if IsError(res) {
|
||
return Option{}, CreateReturnError(res)
|
||
}
|
||
return NewOption(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchOptionChain
|
||
* @description fetches data for an underlying asset that is commonly found in an option chain
|
||
* @see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers
|
||
* @param {string} code base currency to fetch an option chain for
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {string} [params.uly] the underlying asset, can be obtained from fetchUnderlyingAssets ()
|
||
* @returns {object} a list of [option chain structures]{@link https://docs.ccxt.com/#/?id=option-chain-structure}
|
||
*/
|
||
func (this *Okx) FetchOptionChain(code string, options ...FetchOptionChainOptions) (OptionChain, error) {
|
||
|
||
opts := FetchOptionChainOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchOptionChain(code, params)
|
||
if IsError(res) {
|
||
return OptionChain{}, CreateReturnError(res)
|
||
}
|
||
return NewOptionChain(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchConvertQuote
|
||
* @description fetch a quote for converting from one currency to another
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-estimate-quote
|
||
* @param {string} fromCode the currency that you want to sell and convert from
|
||
* @param {string} toCode the currency that you want to buy and convert into
|
||
* @param {float} [amount] how much you want to trade in units of the from currency
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [conversion structure]{@link https://docs.ccxt.com/#/?id=conversion-structure}
|
||
*/
|
||
func (this *Okx) FetchConvertQuote(fromCode string, toCode string, options ...FetchConvertQuoteOptions) (Conversion, error) {
|
||
|
||
opts := FetchConvertQuoteOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var amount interface{} = nil
|
||
if opts.Amount != nil {
|
||
amount = *opts.Amount
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchConvertQuote(fromCode, toCode, amount, params)
|
||
if IsError(res) {
|
||
return Conversion{}, CreateReturnError(res)
|
||
}
|
||
return NewConversion(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#createConvertTrade
|
||
* @description convert from one currency to another
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-convert-trade
|
||
* @param {string} id the id of the trade that you want to make
|
||
* @param {string} fromCode the currency that you want to sell and convert from
|
||
* @param {string} toCode the currency that you want to buy and convert into
|
||
* @param {float} [amount] how much you want to trade in units of the from currency
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [conversion structure]{@link https://docs.ccxt.com/#/?id=conversion-structure}
|
||
*/
|
||
func (this *Okx) CreateConvertTrade(id string, fromCode string, toCode string, options ...CreateConvertTradeOptions) (Conversion, error) {
|
||
|
||
opts := CreateConvertTradeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var amount interface{} = nil
|
||
if opts.Amount != nil {
|
||
amount = *opts.Amount
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.CreateConvertTrade(id, fromCode, toCode, amount, params)
|
||
if IsError(res) {
|
||
return Conversion{}, CreateReturnError(res)
|
||
}
|
||
return NewConversion(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchConvertTrade
|
||
* @description fetch the data for a conversion trade
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-history
|
||
* @param {string} id the id of the trade that you want to fetch
|
||
* @param {string} [code] the unified currency code of the conversion trade
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} a [conversion structure]{@link https://docs.ccxt.com/#/?id=conversion-structure}
|
||
*/
|
||
func (this *Okx) FetchConvertTrade(id string, options ...FetchConvertTradeOptions) (Conversion, error) {
|
||
|
||
opts := FetchConvertTradeOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchConvertTrade(id, code, params)
|
||
if IsError(res) {
|
||
return Conversion{}, CreateReturnError(res)
|
||
}
|
||
return NewConversion(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchConvertTradeHistory
|
||
* @description fetch the users history of conversion trades
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-history
|
||
* @param {string} [code] the unified currency code
|
||
* @param {int} [since] the earliest time in ms to fetch conversions for
|
||
* @param {int} [limit] the maximum number of conversion structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.until] timestamp in ms of the latest conversion to fetch
|
||
* @returns {object[]} a list of [conversion structures]{@link https://docs.ccxt.com/#/?id=conversion-structure}
|
||
*/
|
||
func (this *Okx) FetchConvertTradeHistory(options ...FetchConvertTradeHistoryOptions) ([]Conversion, error) {
|
||
|
||
opts := FetchConvertTradeHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var code interface{} = nil
|
||
if opts.Code != nil {
|
||
code = *opts.Code
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchConvertTradeHistory(code, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewConversionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchConvertCurrencies
|
||
* @description fetches all available currencies that can be converted
|
||
* @see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-currencies
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @returns {object} an associative dictionary of currencies
|
||
*/
|
||
func (this *Okx) FetchConvertCurrencies(params ...interface{}) (Currencies, error) {
|
||
res := <- this.Core.FetchConvertCurrencies(params...)
|
||
if IsError(res) {
|
||
return Currencies{}, CreateReturnError(res)
|
||
}
|
||
return NewCurrencies(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchMarginAdjustmentHistory
|
||
* @description fetches the history of margin added or reduced from contract isolated positions
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-7-days
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
|
||
* @param {string} [symbol] not used by okx fetchMarginAdjustmentHistory
|
||
* @param {string} [type] "add" or "reduce"
|
||
* @param {int} [since] the earliest time in ms to fetch margin adjustment history for
|
||
* @param {int} [limit] the maximum number of entries to retrieve
|
||
* @param {object} params extra parameters specific to the exchange api endpoint
|
||
* @param {boolean} [params.auto] true if fetching auto margin increases
|
||
* @returns {object[]} a list of [margin structures]{@link https://docs.ccxt.com/#/?id=margin-loan-structure}
|
||
*/
|
||
func (this *Okx) FetchMarginAdjustmentHistory(options ...FetchMarginAdjustmentHistoryOptions) ([]MarginModification, error) {
|
||
|
||
opts := FetchMarginAdjustmentHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var typeVar interface{} = nil
|
||
if opts.Type != nil {
|
||
typeVar = *opts.Type
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchMarginAdjustmentHistory(symbol, typeVar, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewMarginModificationArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchPositionsHistory
|
||
* @description fetches historical positions
|
||
* @see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-positions-history
|
||
* @param {string} [symbols] unified market symbols
|
||
* @param {int} [since] timestamp in ms of the earliest position to fetch
|
||
* @param {int} [limit] the maximum amount of records to fetch, default=100, max=100
|
||
* @param {object} params extra parameters specific to the exchange api endpoint
|
||
* @param {string} [params.marginMode] "cross" or "isolated"
|
||
*
|
||
* EXCHANGE SPECIFIC PARAMETERS
|
||
* @param {string} [params.instType] margin, swap, futures or option
|
||
* @param {string} [params.type] the type of latest close position 1: close position partially, 2:close all, 3:liquidation, 4:partial liquidation; 5:adl, is it is the latest type if there are several types for the same position
|
||
* @param {string} [params.posId] position id, there is attribute expiration, the posid will be expired if it is more than 30 days after the last full close position, then position will use new posid
|
||
* @param {string} [params.before] timestamp in ms of the earliest position to fetch based on the last update time of the position
|
||
* @param {string} [params.after] timestamp in ms of the latest position to fetch based on the last update time of the position
|
||
* @returns {object[]} a list of [position structures]{@link https://docs.ccxt.com/#/?id=position-structure}
|
||
*/
|
||
func (this *Okx) FetchPositionsHistory(options ...FetchPositionsHistoryOptions) ([]Position, error) {
|
||
|
||
opts := FetchPositionsHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbols interface{} = nil
|
||
if opts.Symbols != nil {
|
||
symbols = *opts.Symbols
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchPositionsHistory(symbols, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewPositionArray(res), nil
|
||
}
|
||
/**
|
||
* @method
|
||
* @name okx#fetchLongShortRatioHistory
|
||
* @description fetches the long short ratio history for a unified market symbol
|
||
* @see https://www.okx.com/docs-v5/en/#trading-statistics-rest-api-get-contract-long-short-ratio
|
||
* @param {string} symbol unified symbol of the market to fetch the long short ratio for
|
||
* @param {string} [timeframe] the period for the ratio
|
||
* @param {int} [since] the earliest time in ms to fetch ratios for
|
||
* @param {int} [limit] the maximum number of long short ratio structures to retrieve
|
||
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
||
* @param {int} [params.until] timestamp in ms of the latest ratio to fetch
|
||
* @returns {object[]} an array of [long short ratio structures]{@link https://docs.ccxt.com/#/?id=long-short-ratio-structure}
|
||
*/
|
||
func (this *Okx) FetchLongShortRatioHistory(options ...FetchLongShortRatioHistoryOptions) ([]LongShortRatio, error) {
|
||
|
||
opts := FetchLongShortRatioHistoryOptionsStruct{}
|
||
|
||
for _, opt := range options {
|
||
opt(&opts)
|
||
}
|
||
|
||
var symbol interface{} = nil
|
||
if opts.Symbol != nil {
|
||
symbol = *opts.Symbol
|
||
}
|
||
|
||
var timeframe interface{} = nil
|
||
if opts.Timeframe != nil {
|
||
timeframe = *opts.Timeframe
|
||
}
|
||
|
||
var since interface{} = nil
|
||
if opts.Since != nil {
|
||
since = *opts.Since
|
||
}
|
||
|
||
var limit interface{} = nil
|
||
if opts.Limit != nil {
|
||
limit = *opts.Limit
|
||
}
|
||
|
||
var params interface{} = nil
|
||
if opts.Params != nil {
|
||
params = *opts.Params
|
||
}
|
||
res := <- this.Core.FetchLongShortRatioHistory(symbol, timeframe, since, limit, params)
|
||
if IsError(res) {
|
||
return nil, CreateReturnError(res)
|
||
}
|
||
return NewLongShortRatioArray(res), nil
|
||
} |