## okx{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchStatus](#fetchstatus) * [fetchTime](#fetchtime) * [fetchAccounts](#fetchaccounts) * [fetchMarkets](#fetchmarkets) * [fetchCurrencies](#fetchcurrencies) * [fetchOrderBook](#fetchorderbook) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [fetchTrades](#fetchtrades) * [fetchOHLCV](#fetchohlcv) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchTradingFee](#fetchtradingfee) * [fetchBalance](#fetchbalance) * [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost) * [createMarketSellOrderWithCost](#createmarketsellorderwithcost) * [createOrder](#createorder) * [createOrders](#createorders) * [editOrder](#editorder) * [cancelOrder](#cancelorder) * [cancelOrders](#cancelorders) * [cancelOrdersForSymbols](#cancelordersforsymbols) * [cancelAllOrdersAfter](#cancelallordersafter) * [fetchOrder](#fetchorder) * [fetchOpenOrders](#fetchopenorders) * [fetchCanceledOrders](#fetchcanceledorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchMyTrades](#fetchmytrades) * [fetchOrderTrades](#fetchordertrades) * [fetchLedger](#fetchledger) * [fetchDepositAddressesByNetwork](#fetchdepositaddressesbynetwork) * [fetchDepositAddress](#fetchdepositaddress) * [withdraw](#withdraw) * [fetchDeposits](#fetchdeposits) * [fetchDeposit](#fetchdeposit) * [fetchWithdrawals](#fetchwithdrawals) * [fetchWithdrawal](#fetchwithdrawal) * [fetchLeverage](#fetchleverage) * [fetchPosition](#fetchposition) * [fetchPositions](#fetchpositions) * [fetchPositions](#fetchpositions) * [transfer](#transfer) * [fetchTransfers](#fetchtransfers) * [fetchFundingRate](#fetchfundingrate) * [fetchFundingHistory](#fetchfundinghistory) * [setLeverage](#setleverage) * [fetchPositionMode](#fetchpositionmode) * [setPositionMode](#setpositionmode) * [setMarginMode](#setmarginmode) * [fetchCrossBorrowRates](#fetchcrossborrowrates) * [fetchCrossBorrowRate](#fetchcrossborrowrate) * [fetchBorrowRateHistories](#fetchborrowratehistories) * [fetchBorrowRateHistory](#fetchborrowratehistory) * [reduceMargin](#reducemargin) * [addMargin](#addmargin) * [fetchMarketLeverageTiers](#fetchmarketleveragetiers) * [fetchBorrowInterest](#fetchborrowinterest) * [borrowCrossMargin](#borrowcrossmargin) * [repayCrossMargin](#repaycrossmargin) * [fetchOpenInterest](#fetchopeninterest) * [fetchOpenInterestHistory](#fetchopeninteresthistory) * [fetchDepositWithdrawFees](#fetchdepositwithdrawfees) * [fetchSettlementHistory](#fetchsettlementhistory) * [fetchUnderlyingAssets](#fetchunderlyingassets) * [fetchGreeks](#fetchgreeks) * [closePosition](#closeposition) * [fetchOption](#fetchoption) * [fetchOptionChain](#fetchoptionchain) * [fetchConvertQuote](#fetchconvertquote) * [createConvertTrade](#createconverttrade) * [fetchConvertTrade](#fetchconverttrade) * [fetchConvertTradeHistory](#fetchconverttradehistory) * [fetchConvertCurrencies](#fetchconvertcurrencies) * [fetchMarginAdjustmentHistory](#fetchmarginadjustmenthistory) * [fetchPositionsHistory](#fetchpositionshistory) * [watchTrades](#watchtrades) * [watchTradesForSymbols](#watchtradesforsymbols) * [unWatchTradesForSymbols](#unwatchtradesforsymbols) * [unWatchTradesForSymbols](#unwatchtradesforsymbols) * [watchFundingRate](#watchfundingrate) * [watchTicker](#watchticker) * [unWatchTicker](#unwatchticker) * [watchTickers](#watchtickers) * [unWatchTickers](#unwatchtickers) * [watchBidsAsks](#watchbidsasks) * [watchLiquidationsForSymbols](#watchliquidationsforsymbols) * [watchMyLiquidationsForSymbols](#watchmyliquidationsforsymbols) * [watchOHLCV](#watchohlcv) * [unWatchOHLCV](#unwatchohlcv) * [watchOHLCVForSymbols](#watchohlcvforsymbols) * [unWatchOHLCVForSymbols](#unwatchohlcvforsymbols) * [watchOrderBook](#watchorderbook) * [watchOrderBookForSymbols](#watchorderbookforsymbols) * [unWatchOrderBookForSymbols](#unwatchorderbookforsymbols) * [unWatchOrderBook](#unwatchorderbook) * [watchBalance](#watchbalance) * [watchMyTrades](#watchmytrades) * [watchPositions](#watchpositions) * [watchOrders](#watchorders) * [createOrderWs](#createorderws) * [editOrderWs](#editorderws) * [cancelOrderWs](#cancelorderws) * [cancelOrdersWs](#cancelordersws) * [cancelAllOrdersWs](#cancelallordersws) ### fetchStatus{docsify-ignore} the latest known information on the availability of the exchange API **Kind**: instance method of [okx](#okx) **Returns**: object - a [status structure](https://docs.ccxt.com/#/?id=exchange-status-structure) **See**: https://www.okx.com/docs-v5/en/#status-get-status | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchStatus ([params]) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [okx](#okx) **Returns**: int - 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 | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchTime ([params]) ``` ### fetchAccounts{docsify-ignore} fetch all the accounts associated with a profile **Kind**: instance method of [okx](#okx) **Returns**: object - a dictionary of [account structures](https://docs.ccxt.com/#/?id=account-structure) indexed by the account type **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchAccounts ([params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for okx **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - an array of objects representing market data **See**: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-instruments | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchMarkets ([params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [okx](#okx) **Returns**: object - an associative dictionary of currencies **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchCurrencies ([params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [okx](#okx) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-order-book | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | | params.method | string | No | 'publicGetMarketBooksFull' or 'publicGetMarketBooks' default is 'publicGetMarketBooks' | ```javascript okx.fetchOrderBook (symbol[, limit, params]) ``` ### fetchTicker{docsify-ignore} fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchTicker (symbol[, params]) ``` ### fetchTickers{docsify-ignore} fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market **Kind**: instance method of [okx](#okx) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchTickers ([symbols, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [okx](#okx) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-trades - https://www.okx.com/docs-v5/en/#rest-api-public-data-get-option-trades | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.paginate | boolean | No | *only applies to publicGetMarketHistoryTrades* default false, when true will automatically paginate by calling this endpoint multiple times | ```javascript okx.fetchTrades (symbol[, since, limit, params]) ``` ### fetchOHLCV{docsify-ignore} fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [okx](#okx) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks-history - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks-history - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks - https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.price | string | No | "mark" or "index" for mark price and index price candles | | params.until | int | No | timestamp in ms of the latest candle to fetch | | params.paginate | boolean | No | 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) | ```javascript okx.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the funding rate history for | | since | int | No | timestamp in ms of the earliest funding rate to fetch | | limit | int | No | the maximum amount of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.paginate | boolean | No | 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) | ```javascript okx.fetchFundingRateHistory (symbol[, since, limit, params]) ``` ### fetchTradingFee{docsify-ignore} fetch the trading fees for a market **Kind**: instance method of [okx](#okx) **Returns**: object - a [fee structure](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-fee-rates | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchTradingFee (symbol[, params]) ``` ### fetchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [okx](#okx) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-balance - https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | | params.type | string | No | wallet type, ['funding' or 'trading'] default is 'trading' | ```javascript okx.fetchBalance ([params]) ``` ### createMarketBuyOrderWithCost{docsify-ignore} create a market buy order by providing the symbol and cost **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | cost | float | Yes | how much you want to trade in units of the quote currency | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.createMarketBuyOrderWithCost (symbol, cost[, params]) ``` ### createMarketSellOrderWithCost{docsify-ignore} create a market buy order by providing the symbol and cost **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | cost | float | Yes | how much you want to trade in units of the quote currency | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.createMarketSellOrderWithCost (symbol, cost[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-place-algo-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of currency you want to trade in units of base currency | | price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.reduceOnly | bool | No | a mark to reduce the position size for margin, swap and future orders | | params.postOnly | bool | No | true to place a post only order | | params.takeProfit | object | No | *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only) | | params.takeProfit.triggerPrice | float | No | take profit trigger price | | params.takeProfit.price | float | No | used for take profit limit orders, not used for take profit market price orders | | params.takeProfit.type | string | No | 'market' or 'limit' used to specify the take profit price type | | params.stopLoss | object | No | *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only) | | params.stopLoss.triggerPrice | float | No | stop loss trigger price | | params.stopLoss.price | float | No | used for stop loss limit orders, not used for stop loss market price orders | | params.stopLoss.type | string | No | 'market' or 'limit' used to specify the stop loss price type | | params.positionSide | string | No | if position mode is one-way: set to 'net', if position mode is hedge-mode: set to 'long' or 'short' | | params.trailingPercent | string | No | the percent to trail away from the current market price | | params.tpOrdKind | string | No | 'condition' or 'limit', the default is 'condition' | | params.hedged | string | No | true/false, to automatically set exchange-specific params needed when trading in hedge mode | ```javascript okx.createOrder (symbol, type, side, amount[, price, params]) ``` ### createOrders{docsify-ignore} create a list of trade orders **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders | Param | Type | Description | | --- | --- | --- | | orders | Array | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params | ```javascript okx.createOrders (orders, [undefined]) ``` ### editOrder{docsify-ignore} edit a trade order **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-amend-order - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-amend-algo-order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of the currency you want to trade in units of the base currency | | price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.clientOrderId | string | No | client order id, uses id if not passed | | params.stopLossPrice | float | No | stop loss trigger price | | params.newSlOrdPx | float | No | the stop loss order price, set to stopLossPrice if the type is market | | params.newSlTriggerPxType | string | No | 'last', 'index' or 'mark' used to specify the stop loss trigger price type, default is 'last' | | params.takeProfitPrice | float | No | take profit trigger price | | params.newTpOrdPx | float | No | the take profit order price, set to takeProfitPrice if the type is market | | params.newTpTriggerPxType | string | No | 'last', 'index' or 'mark' used to specify the take profit trigger price type, default is 'last' | | params.stopLoss | object | No | *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered | | params.stopLoss.triggerPrice | float | No | stop loss trigger price | | params.stopLoss.price | float | No | used for stop loss limit orders, not used for stop loss market price orders | | params.stopLoss.type | string | No | 'market' or 'limit' used to specify the stop loss price type | | params.takeProfit | object | No | *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered | | params.takeProfit.triggerPrice | float | No | take profit trigger price | | params.takeProfit.price | float | No | used for take profit limit orders, not used for take profit market price orders | | params.takeProfit.type | string | No | 'market' or 'limit' used to specify the take profit price type | | params.newTpOrdKind | string | No | 'condition' or 'limit', the default is 'condition' | ```javascript okx.editOrder (id, symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [okx](#okx) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-order - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | true if trigger orders | | params.trailing | boolean | No | set to true if you want to cancel a trailing order | ```javascript okx.cancelOrder (id, symbol[, params]) ``` ### cancelOrders{docsify-ignore} cancel multiple orders **Kind**: instance method of [okx](#okx) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order | Param | Type | Required | Description | | --- | --- | --- | --- | | ids | Array<string> | Yes | order ids | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | whether the order is a stop/trigger order | | params.trailing | boolean | No | set to true if you want to cancel trailing orders | ```javascript okx.cancelOrders (ids, symbol[, params]) ``` ### cancelOrdersForSymbols{docsify-ignore} cancel multiple orders for multiple symbols **Kind**: instance method of [okx](#okx) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order | Param | Type | Required | Description | | --- | --- | --- | --- | | orders | Array<CancellationRequest> | Yes | each order should contain the parameters required by cancelOrder namely id and symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}] | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | boolean | No | whether the order is a stop/trigger order | | params.trailing | boolean | No | set to true if you want to cancel trailing orders | ```javascript okx.cancelOrdersForSymbols (orders[, params]) ``` ### cancelAllOrdersAfter{docsify-ignore} dead man's switch, cancel all orders after the given timeout **Kind**: instance method of [okx](#okx) **Returns**: object - the api result **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-all-after | Param | Type | Required | Description | | --- | --- | --- | --- | | timeout | number | Yes | time in milliseconds, 0 represents cancel the timer | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.cancelAllOrdersAfter (timeout[, params]) ``` ### fetchOrder{docsify-ignore} fetch an order by the id **Kind**: instance method of [okx](#okx) **Returns**: [an order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-details - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-details | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the order id | | symbol | string | Yes | unified market symbol | | params | object | No | extra and exchange specific parameters | | params.trigger | boolean | No | true if fetching trigger orders | ```javascript okx.fetchOrder (id, symbol[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [okx](#okx) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-list - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-list | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch open orders for | | limit | int | No | the maximum number of open orders structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.stop | bool | No | True if fetching trigger or conditional orders | | params.ordType | string | No | "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap" | | params.algoId | string | No | Algo ID "'433845797218942976'" | | params.paginate | boolean | No | 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) | | params.trailing | boolean | No | set to true if you want to fetch trailing orders | ```javascript okx.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchCanceledOrders{docsify-ignore} fetches information on multiple canceled orders made by the user **Kind**: instance method of [okx](#okx) **Returns**: object - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | timestamp in ms of the earliest order, default is undefined | | limit | int | No | max number of orders to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.stop | bool | No | True if fetching trigger or conditional orders | | params.ordType | string | No | "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap" | | params.algoId | string | No | Algo ID "'433845797218942976'" | | params.until | int | No | timestamp in ms to fetch orders for | | params.trailing | boolean | No | set to true if you want to fetch trailing orders | ```javascript okx.fetchCanceledOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [okx](#okx) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days - https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history - https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.trigger | bool | No | True if fetching trigger or conditional orders | | params.ordType | string | No | "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap" | | params.algoId | string | No | Algo ID "'433845797218942976'" | | params.until | int | No | timestamp in ms to fetch orders for | | params.paginate | boolean | No | 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) | | params.method | string | No | method to be used, either 'privateGetTradeOrdersHistory', 'privateGetTradeOrdersHistoryArchive' or 'privateGetTradeOrdersAlgoHistory' default is 'privateGetTradeOrdersHistory' | | params.trailing | boolean | No | set to true if you want to fetch trailing orders | ```javascript okx.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [okx](#okx) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trades structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | Timestamp in ms of the latest time to retrieve trades for | | params.paginate | boolean | No | 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) | ```javascript okx.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchOrderTrades{docsify-ignore} fetch all the trades made from a single order **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trades to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchOrderTrades (id, symbol[, since, limit, params]) ``` ### fetchLedger{docsify-ignore} fetch the history of changes, actions done by the user or operations that altered balance of the user **Kind**: instance method of [okx](#okx) **Returns**: object - a [ledger structure](https://docs.ccxt.com/#/?id=ledger-structure) **See** - https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-7-days - https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-3-months - https://www.okx.com/docs-v5/en/#rest-api-funding-asset-bills-details | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code, default is undefined | | since | int | No | timestamp in ms of the earliest ledger entry, default is undefined | | limit | int | No | max number of ledger entrys to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' | | params.until | int | No | the latest time in ms to fetch entries for | | params.paginate | boolean | No | 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) | ```javascript okx.fetchLedger (code[, since, limit, params]) ``` ### fetchDepositAddressesByNetwork{docsify-ignore} fetch a dictionary of addresses for a currency, indexed by network **Kind**: instance method of [okx](#okx) **Returns**: object - a dictionary of [address structures](https://docs.ccxt.com/#/?id=address-structure) indexed by the network **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency for the deposit address | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchDepositAddressesByNetwork (code[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [okx](#okx) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchDepositAddress (code[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [okx](#okx) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-withdrawal | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | the amount to withdraw | | address | string | Yes | the address to withdraw to | | tag | string | Yes | | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.withdraw (code, amount, address, tag[, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch deposits for | | limit | int | No | the maximum number of deposits structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | the latest time in ms to fetch entries for | | params.paginate | boolean | No | 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) | ```javascript okx.fetchDeposits (code[, since, limit, params]) ``` ### fetchDeposit{docsify-ignore} fetch data on a currency deposit via the deposit id **Kind**: instance method of [okx](#okx) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | deposit id | | code | string | Yes | filter by currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchDeposit (id, code[, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | the earliest time in ms to fetch withdrawals for | | limit | int | No | the maximum number of withdrawals structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | the latest time in ms to fetch entries for | | params.paginate | boolean | No | 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) | ```javascript okx.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchWithdrawal{docsify-ignore} fetch data on a currency withdrawal via the withdrawal id **Kind**: instance method of [okx](#okx) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | withdrawal id | | code | string | Yes | unified currency code of the currency withdrawn, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchWithdrawal (id, code[, params]) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [okx](#okx) **Returns**: object - a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-account-get-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' | ```javascript okx.fetchLeverage (symbol[, params]) ``` ### fetchPosition{docsify-ignore} fetch data on a single open contract trade position **Kind**: instance method of [okx](#okx) **Returns**: object - a [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-account-get-positions | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market the position is held in, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.instType | string | No | MARGIN, SWAP, FUTURES, OPTION | ```javascript okx.fetchPosition (symbol[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See** - https://www.okx.com/docs-v5/en/#rest-api-account-get-positions - https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-positions-history history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | params.instType | string | No | MARGIN, SWAP, FUTURES, OPTION | ```javascript okx.fetchPositions (symbols[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions for specific symbol **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-account-get-positions | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.instType | string | No | MARGIN (if needed) | ```javascript okx.fetchPositions (symbol[, params]) ``` ### transfer{docsify-ignore} transfer currency internally between wallets on the same account **Kind**: instance method of [okx](#okx) **Returns**: object - a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-funds-transfer | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | amount to transfer | | fromAccount | string | Yes | account to transfer from | | toAccount | string | Yes | account to transfer to | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.transfer (code, amount, fromAccount, toAccount[, params]) ``` ### fetchTransfers{docsify-ignore} fetch a history of internal transfers made on an account **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [transfer structures](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency transferred | | since | int | No | the earliest time in ms to fetch transfers for | | limit | int | No | the maximum number of transfers structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchTransfers (code[, since, limit, params]) ``` ### fetchFundingRate{docsify-ignore} fetch the current funding rate **Kind**: instance method of [okx](#okx) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchFundingRate (symbol[, params]) ``` ### fetchFundingHistory{docsify-ignore} fetch the history of funding payments paid and received on this account **Kind**: instance method of [okx](#okx) **Returns**: object - a [funding history structure](https://docs.ccxt.com/#/?id=funding-history-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch funding history for | | limit | int | No | the maximum number of funding history structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchFundingHistory (symbol[, since, limit, params]) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [okx](#okx) **Returns**: object - response from the exchange **See**: https://www.okx.com/docs-v5/en/#rest-api-account-set-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | leverage | float | Yes | the rate of leverage | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' | | params.posSide | string | No | 'long' or 'short' for isolated margin long/short mode on futures and swap markets | ```javascript okx.setLeverage (leverage, symbol[, params]) ``` ### fetchPositionMode{docsify-ignore} fetchs the position mode, hedged or one way, hedged for binance is set identically for all linear markets or all inverse markets **Kind**: instance method of [okx](#okx) **Returns**: object - an object detailing whether the market is in hedged or one-way mode **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | params | object | No | extra parameters specific to the exchange API endpoint | | param.accountId | string | No | if you have multiple accounts, you must specify the account id to fetch the position mode | ```javascript okx.fetchPositionMode (symbol[, params]) ``` ### setPositionMode{docsify-ignore} set hedged to true or false for a market **Kind**: instance method of [okx](#okx) **Returns**: object - response from the exchange **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-position-mode | Param | Type | Required | Description | | --- | --- | --- | --- | | hedged | bool | Yes | set to true to use long_short_mode, false for net_mode | | symbol | string | Yes | not used by okx setPositionMode | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.setPositionMode (hedged, symbol[, params]) ``` ### setMarginMode{docsify-ignore} set margin mode to 'cross' or 'isolated' **Kind**: instance method of [okx](#okx) **Returns**: object - response from the exchange **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | marginMode | string | Yes | 'cross' or 'isolated' | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.leverage | int | No | leverage | ```javascript okx.setMarginMode (marginMode, symbol[, params]) ``` ### fetchCrossBorrowRates{docsify-ignore} fetch the borrow interest rates of all currencies **Kind**: instance method of [okx](#okx) **Returns**: object - a list of [borrow rate structures](https://docs.ccxt.com/#/?id=borrow-rate-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchCrossBorrowRates ([params]) ``` ### fetchCrossBorrowRate{docsify-ignore} fetch the rate of interest to borrow a currency for margin trading **Kind**: instance method of [okx](#okx) **Returns**: object - a [borrow rate structure](https://docs.ccxt.com/#/?id=borrow-rate-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchCrossBorrowRate (code[, params]) ``` ### fetchBorrowRateHistories{docsify-ignore} retrieves a history of a multiple currencies borrow interest rate at specific time slots, returns all currencies if no symbols passed, default is undefined **Kind**: instance method of [okx](#okx) **Returns**: object - a dictionary of [borrow rate structures](https://docs.ccxt.com/#/?id=borrow-rate-structure) indexed by the market symbol **See**: https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | list of unified currency codes, default is undefined | | since | int | No | timestamp in ms of the earliest borrowRate, default is undefined | | limit | int | No | max number of borrow rate prices to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchBorrowRateHistories (codes[, since, limit, params]) ``` ### fetchBorrowRateHistory{docsify-ignore} retrieves a history of a currencies borrow interest rate at specific time slots **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - an array of [borrow rate structures](https://docs.ccxt.com/#/?id=borrow-rate-structure) **See**: https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | since | int | No | timestamp for the earliest borrow rate | | limit | int | No | the maximum number of [borrow rate structures](https://docs.ccxt.com/#/?id=borrow-rate-structure) to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchBorrowRateHistory (code[, since, limit, params]) ``` ### reduceMargin{docsify-ignore} remove margin from a position **Kind**: instance method of [okx](#okx) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=reduce-margin-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | the amount of margin to remove | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.reduceMargin (symbol, amount[, params]) ``` ### addMargin{docsify-ignore} add margin **Kind**: instance method of [okx](#okx) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | amount of margin to add | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.addMargin (symbol, amount[, params]) ``` ### fetchMarketLeverageTiers{docsify-ignore} retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market **Kind**: instance method of [okx](#okx) **Returns**: object - a [leverage tiers structure](https://docs.ccxt.com/#/?id=leverage-tiers-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-position-tiers | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' | ```javascript okx.fetchMarketLeverageTiers (symbol[, params]) ``` ### fetchBorrowInterest{docsify-ignore} fetch the interest owed by the user for borrowing currency for margin trading **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - An list of [borrow interest structures](https://docs.ccxt.com/#/?id=borrow-interest-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-account-get-interest-accrued-data | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | the unified currency code for the currency of the interest | | symbol | string | Yes | the market symbol of an isolated margin market, if undefined, the interest for cross margin markets is returned | | since | int | No | timestamp in ms of the earliest time to receive interest records for | | limit | int | No | the number of [borrow interest structures](https://docs.ccxt.com/#/?id=borrow-interest-structure) to retrieve | | params | object | No | exchange specific parameters | | params.type | int | No | Loan type 1 - VIP loans 2 - Market loans *Default is Market loans* | | params.marginMode | string | No | 'cross' or 'isolated' | ```javascript okx.fetchBorrowInterest (code, symbol[, since, limit, params]) ``` ### borrowCrossMargin{docsify-ignore} create a loan to borrow margin (need to be VIP 5 and above) **Kind**: instance method of [okx](#okx) **Returns**: object - a [margin loan structure](https://docs.ccxt.com/#/?id=margin-loan-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-vip-loans-borrow-and-repay | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency to borrow | | amount | float | Yes | the amount to borrow | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.borrowCrossMargin (code, amount[, params]) ``` ### repayCrossMargin{docsify-ignore} repay borrowed margin and interest **Kind**: instance method of [okx](#okx) **Returns**: object - a [margin loan structure](https://docs.ccxt.com/#/?id=margin-loan-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-vip-loans-borrow-and-repay | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency to repay | | amount | float | Yes | the amount to repay | | params | object | No | extra parameters specific to the exchange API endpoint | | params.id | string | No | the order ID of borrowing, it is necessary while repaying | ```javascript okx.repayCrossMargin (code, amount[, params]) ``` ### fetchOpenInterest{docsify-ignore} Retrieves the open interest of a currency **Kind**: instance method of [okx](#okx) **Returns**: object - an open interest structure[https://docs.ccxt.com/#/?id=open-interest-structure](https://docs.ccxt.com/#/?id=open-interest-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-open-interest | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | Unified CCXT market symbol | | params | object | No | exchange specific parameters | ```javascript okx.fetchOpenInterest (symbol[, params]) ``` ### fetchOpenInterestHistory{docsify-ignore} Retrieves the open interest history of a currency **Kind**: instance method of [okx](#okx) **Returns**: An array of [open interest structures](https://docs.ccxt.com/#/?id=open-interest-structure) **See** - https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-contracts-open-interest-and-volume - https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-options-open-interest-and-volume | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | Unified CCXT currency code or unified symbol | | timeframe | string | Yes | "5m", "1h", or "1d" for option only "1d" or "8h" | | since | int | No | The time in ms of the earliest record to retrieve as a unix timestamp | | limit | int | No | Not used by okx, but parsed internally by CCXT | | params | object | No | Exchange specific parameters | | params.until | int | No | The time in ms of the latest record to retrieve as a unix timestamp | ```javascript okx.fetchOpenInterestHistory (symbol, timeframe[, since, limit, params]) ``` ### fetchDepositWithdrawFees{docsify-ignore} fetch deposit and withdraw fees **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [fees structures](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | list of unified currency codes | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchDepositWithdrawFees (codes[, params]) ``` ### fetchSettlementHistory{docsify-ignore} fetches historical settlement records **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [settlement history objects](https://docs.ccxt.com/#/?id=settlement-history-structure) **See**: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-delivery-exercise-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol to fetch the settlement history for | | since | int | No | timestamp in ms | | limit | int | No | number of records | | params | object | No | exchange specific params | ```javascript okx.fetchSettlementHistory (symbol[, since, limit, params]) ``` ### fetchUnderlyingAssets{docsify-ignore} fetches the market ids of underlying assets for a specific contract market type **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [underlying assets](https://docs.ccxt.com/#/?id=underlying-assets-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-underlying | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | exchange specific params | | params.type | string | No | the contract market type, 'option', 'swap' or 'future', the default is 'option' | ```javascript okx.fetchUnderlyingAssets ([params]) ``` ### fetchGreeks{docsify-ignore} fetches an option contracts greeks, financial metrics used to measure the factors that affect the price of an options contract **Kind**: instance method of [okx](#okx) **Returns**: object - a [greeks structure](https://docs.ccxt.com/#/?id=greeks-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-option-market-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch greeks for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchGreeks (symbol[, params]) ``` ### closePosition{docsify-ignore} closes open positions for a market **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - [A list of position structures](https://docs.ccxt.com/#/?id=position-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-close-positions | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | Unified CCXT market symbol | | side | string | No | 'buy' or 'sell', leave as undefined in net mode | | params | object | No | extra parameters specific to the okx api endpoint | | params.clientOrderId | string | No | a unique identifier for the order | | params.marginMode | string | No | 'cross' or 'isolated', default is 'cross; | | params.code | string | No | *required in the case of closing cross MARGIN position for Single-currency margin* margin currency EXCHANGE SPECIFIC PARAMETERS | | params.autoCxl | boolean | No | whether any pending orders for closing out needs to be automatically canceled when close position via a market order. false or true, the default is false | | params.tag | string | No | order tag a combination of case-sensitive alphanumerics, all numbers, or all letters of up to 16 characters | ```javascript okx.closePosition (symbol[, side, params]) ``` ### fetchOption{docsify-ignore} fetches option data that is commonly found in an option chain **Kind**: instance method of [okx](#okx) **Returns**: object - an [option chain structure](https://docs.ccxt.com/#/?id=option-chain-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchOption (symbol[, params]) ``` ### fetchOptionChain{docsify-ignore} fetches data for an underlying asset that is commonly found in an option chain **Kind**: instance method of [okx](#okx) **Returns**: object - a list of [option chain structures](https://docs.ccxt.com/#/?id=option-chain-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers | Param | Type | Required | Description | | --- | --- | --- | --- | | currency | string | Yes | base currency to fetch an option chain for | | params | object | No | extra parameters specific to the exchange API endpoint | | params.uly | string | No | the underlying asset, can be obtained from fetchUnderlyingAssets () | ```javascript okx.fetchOptionChain (currency[, params]) ``` ### fetchConvertQuote{docsify-ignore} fetch a quote for converting from one currency to another **Kind**: instance method of [okx](#okx) **Returns**: object - a [conversion structure](https://docs.ccxt.com/#/?id=conversion-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-estimate-quote | Param | Type | Required | Description | | --- | --- | --- | --- | | fromCode | string | Yes | the currency that you want to sell and convert from | | toCode | string | Yes | the currency that you want to buy and convert into | | amount | float | No | how much you want to trade in units of the from currency | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchConvertQuote (fromCode, toCode[, amount, params]) ``` ### createConvertTrade{docsify-ignore} convert from one currency to another **Kind**: instance method of [okx](#okx) **Returns**: object - a [conversion structure](https://docs.ccxt.com/#/?id=conversion-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-convert-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the id of the trade that you want to make | | fromCode | string | Yes | the currency that you want to sell and convert from | | toCode | string | Yes | the currency that you want to buy and convert into | | amount | float | No | how much you want to trade in units of the from currency | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.createConvertTrade (id, fromCode, toCode[, amount, params]) ``` ### fetchConvertTrade{docsify-ignore} fetch the data for a conversion trade **Kind**: instance method of [okx](#okx) **Returns**: object - a [conversion structure](https://docs.ccxt.com/#/?id=conversion-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-history | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the id of the trade that you want to fetch | | code | string | No | the unified currency code of the conversion trade | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchConvertTrade (id[, code, params]) ``` ### fetchConvertTradeHistory{docsify-ignore} fetch the users history of conversion trades **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [conversion structures](https://docs.ccxt.com/#/?id=conversion-structure) **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | the unified currency code | | since | int | No | the earliest time in ms to fetch conversions for | | limit | int | No | the maximum number of conversion structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest conversion to fetch | ```javascript okx.fetchConvertTradeHistory ([code, since, limit, params]) ``` ### fetchConvertCurrencies{docsify-ignore} fetches all available currencies that can be converted **Kind**: instance method of [okx](#okx) **Returns**: object - an associative dictionary of currencies **See**: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-convert-currencies | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.fetchConvertCurrencies ([params]) ``` ### fetchMarginAdjustmentHistory{docsify-ignore} fetches the history of margin added or reduced from contract isolated positions **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [margin structures](https://docs.ccxt.com/#/?id=margin-loan-structure) **See** - https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-7-days - https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | not used by okx fetchMarginAdjustmentHistory | | type | string | No | "add" or "reduce" | | params | object | Yes | extra parameters specific to the exchange api endpoint | | params.auto | boolean | No | true if fetching auto margin increases | ```javascript okx.fetchMarginAdjustmentHistory ([symbol, type, params]) ``` ### fetchPositionsHistory{docsify-ignore} fetches historical positions **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [position structures](https://docs.ccxt.com/#/?id=position-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-positions-history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | string | No | unified market symbols | | since | int | No | timestamp in ms of the earliest position to fetch | | limit | int | No | the maximum amount of records to fetch, default=100, max=100 | | params | object | Yes | extra parameters specific to the exchange api endpoint | | params.marginMode | string | No | "cross" or "isolated" EXCHANGE SPECIFIC PARAMETERS | | params.instType | string | No | margin, swap, futures or option | | params.type | string | No | 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 | | params.posId | string | No | 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 | | params.before | string | No | timestamp in ms of the earliest position to fetch based on the last update time of the position | | params.after | string | No | timestamp in ms of the latest position to fetch based on the last update time of the position | ```javascript okx.fetchPositionsHistory ([symbols, since, limit, params]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchTrades (symbol[, since, limit, params]) ``` ### watchTradesForSymbols{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchTradesForSymbols (symbol[, since, limit, params]) ``` ### unWatchTradesForSymbols{docsify-ignore} unWatches from the stream channel **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.unWatchTradesForSymbols (symbol[, params]) ``` ### unWatchTradesForSymbols{docsify-ignore} unWatches from the stream channel **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.unWatchTradesForSymbols (symbol[, params]) ``` ### watchFundingRate{docsify-ignore} watch the current funding rate **Kind**: instance method of [okx](#okx) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchFundingRate (symbol[, params]) ``` ### watchTicker{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | | params.channel | string | No | the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers | ```javascript okx.watchTicker (symbol[, params]) ``` ### unWatchTicker{docsify-ignore} unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | | params.channel | string | No | the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers | ```javascript okx.unWatchTicker (symbol[, params]) ``` ### watchTickers{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | | params.channel | string | No | the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers | ```javascript okx.watchTickers ([symbols, params]) ``` ### unWatchTickers{docsify-ignore} unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | | params.channel | string | No | the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers | ```javascript okx.unWatchTickers ([symbols, params]) ``` ### watchBidsAsks{docsify-ignore} watches best bid & ask for symbols **Kind**: instance method of [okx](#okx) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchBidsAsks (symbols[, params]) ``` ### watchLiquidationsForSymbols{docsify-ignore} watch the public liquidations of a trading pair **Kind**: instance method of [okx](#okx) **Returns**: object - an array of [liquidation structures](https://github.com/ccxt/ccxt/wiki/Manual#liquidation-structure) **See**: https://www.okx.com/docs-v5/en/#public-data-websocket-liquidation-orders-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified CCXT market symbol | | since | int | No | the earliest time in ms to fetch liquidations for | | limit | int | No | the maximum number of liquidation structures to retrieve | | params | object | No | exchange specific parameters for the okx api endpoint | ```javascript okx.watchLiquidationsForSymbols (symbol[, since, limit, params]) ``` ### watchMyLiquidationsForSymbols{docsify-ignore} watch the private liquidations of a trading pair **Kind**: instance method of [okx](#okx) **Returns**: object - an array of [liquidation structures](https://github.com/ccxt/ccxt/wiki/Manual#liquidation-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-websocket-balance-and-position-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified CCXT market symbol | | since | int | No | the earliest time in ms to fetch liquidations for | | limit | int | No | the maximum number of liquidation structures to retrieve | | params | object | No | exchange specific parameters for the okx api endpoint | ```javascript okx.watchMyLiquidationsForSymbols (symbol[, since, limit, params]) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [okx](#okx) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### unWatchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [okx](#okx) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.unWatchOHLCV (symbol, timeframe[, params]) ``` ### watchOHLCVForSymbols{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [okx](#okx) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume | Param | Type | Required | Description | | --- | --- | --- | --- | | symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchOHLCVForSymbols (symbolsAndTimeframes[, since, limit, params]) ``` ### unWatchOHLCVForSymbols{docsify-ignore} unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [okx](#okx) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume | Param | Type | Required | Description | | --- | --- | --- | --- | | symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.unWatchOHLCVForSymbols (symbolsAndTimeframes[, params]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [okx](#okx) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | | params.depth | string | No | okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt | ```javascript okx.watchOrderBook (symbol[, limit, params]) ``` ### watchOrderBookForSymbols{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [okx](#okx) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified array of symbols | | limit | int | No | 1,5, 400, 50 (l2-tbt, vip4+) or 40000 (vip5+) the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | | params.depth | string | No | okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt | ```javascript okx.watchOrderBookForSymbols (symbols[, limit, params]) ``` ### unWatchOrderBookForSymbols{docsify-ignore} unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [okx](#okx) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified array of symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | params.limit | int | No | the maximum amount of order book entries to return | | params.depth | string | No | okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt | ```javascript okx.unWatchOrderBookForSymbols (symbols[, params]) ``` ### unWatchOrderBook{docsify-ignore} unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [okx](#okx) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified array of symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | params.limit | int | No | the maximum amount of order book entries to return | | params.depth | string | No | okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt | ```javascript okx.unWatchOrderBook (symbol[, params]) ``` ### watchBalance{docsify-ignore} watch balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [okx](#okx) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.watchBalance ([params]) ``` ### watchMyTrades{docsify-ignore} watches information on multiple trades made by the user **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol of the market trades were made in | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trade structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.stop | bool | No | true if fetching trigger or conditional trades | | params.type | string | No | 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION' | | params.marginMode | string | No | 'cross' or 'isolated', for automatically setting the type to spot margin | ```javascript okx.watchMyTrades ([symbol, since, limit, params]) ``` ### watchPositions{docsify-ignore} watch all open positions **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/en/latest/manual.html#position-structure) **See**: https://www.okx.com/docs-v5/en/#trading-account-websocket-positions-channel | Param | Type | Description | | --- | --- | --- | | symbols | Array<string>, undefined | list of unified market symbols | | params | object | extra parameters specific to the exchange API endpoint | ```javascript okx.watchPositions (symbols, params[]) ``` ### watchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol of the market the orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.stop | bool | No | true if fetching trigger or conditional orders | | params.type | string | No | 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION' | | params.marginMode | string | No | 'cross' or 'isolated', for automatically setting the type to spot margin | ```javascript okx.watchOrders ([symbol, since, limit, params]) ``` ### createOrderWs{docsify-ignore} create a trade order **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of currency you want to trade in units of base currency | | price | float, undefined | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.test | boolean | Yes | test order, default false | ```javascript okx.createOrderWs (symbol, type, side, amount[, price, params]) ``` ### editOrderWs{docsify-ignore} edit a trade order **Kind**: instance method of [okx](#okx) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order - https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of the currency you want to trade in units of the base currency | | price | float, undefined | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.editOrderWs (id, symbol, type, side, amount[, price, params]) ``` ### cancelOrderWs{docsify-ignore} cancel multiple orders **Kind**: instance method of [okx](#okx) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | unified market symbol, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.clOrdId | string | No | client order id | ```javascript okx.cancelOrderWs (id, symbol[, params]) ``` ### cancelOrdersWs{docsify-ignore} cancel multiple orders **Kind**: instance method of [okx](#okx) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order | Param | Type | Required | Description | | --- | --- | --- | --- | | ids | Array<string> | Yes | order ids | | symbol | string | Yes | unified market symbol, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.cancelOrdersWs (ids, symbol[, params]) ``` ### cancelAllOrdersWs{docsify-ignore} cancel all open orders of a type. Only applicable to Option in Portfolio Margin mode, and MMP privilege is required. **Kind**: instance method of [okx](#okx) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.okx.com/websockets/#message-cancelAll | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript okx.cancelAllOrdersWs (symbol[, params]) ```