ContextQMD
Back to Ccxt

Woo

wiki/exchanges/woo.md

4.5.5264.1 KB
Original Source

<a name="woo" id="woo"></a>

woo{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchStatus" id="fetchstatus"></a>

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a status structure

See: https://developer.woox.io/api-reference/endpoint/public_data/systemInfo

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchStatus ([params])

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>woo</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See: https://developer.woox.io/api-reference/endpoint/public_data/systemInfo

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchTime ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for woo

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - an array of objects representing market data

See: https://developer.woox.io/api-reference/endpoint/public_data/instruments

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchMarkets ([params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>woo</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://developer.woox.io/api-reference/endpoint/public_data/marketTrades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchTrades (symbol[, since, limit, params])

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a fee structure

See: https://developer.woox.io/api-reference/endpoint/trading/get_tradingFee

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.portfolioMargin<code>boolean</code>Noset to true if you would like to fetch trading fees in a portfolio margin account
params.subType<code>string</code>No"linear" or "inverse"
javascript
woo.fetchTradingFee (symbol[, params])

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols

See: https://developer.woox.io/api-reference/endpoint/account/get_account_info

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchTradingFees ([params])

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://docs.woox.io/#available-token-public

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchCurrencies ([params])

<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See: https://docs.woox.io/#send-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
cost<code>float</code>Yeshow much you want to trade in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.createMarketBuyOrderWithCost (symbol, cost[, params])

<a name="createMarketSellOrderWithCost" id="createmarketsellorderwithcost"></a>

createMarketSellOrderWithCost{docsify-ignore}

create a market sell order by providing the symbol and cost

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See: https://docs.woox.io/#send-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
cost<code>float</code>Yeshow much you want to trade in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.createMarketSellOrderWithCost (symbol, cost[, params])

<a name="createTrailingAmountOrder" id="createtrailingamountorder"></a>

createTrailingAmountOrder{docsify-ignore}

create a trailing order by providing the symbol, type, side, amount, price and trailingAmount

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See: https://docs.woox.io/#send-algo-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much you want to trade in units of the base currency, or number of contracts
price<code>float</code>Nothe price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingAmount<code>float</code>Yesthe quote amount to trail away from the current market price
trailingTriggerPrice<code>float</code>Yesthe price to activate a trailing order, default uses the price argument
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.createTrailingAmountOrder (symbol, type, side, amount[, price, trailingAmount, trailingTriggerPrice, params])

<a name="createTrailingPercentOrder" id="createtrailingpercentorder"></a>

createTrailingPercentOrder{docsify-ignore}

create a trailing order by providing the symbol, type, side, amount, price and trailingPercent

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See: https://docs.woox.io/#send-algo-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much you want to trade in units of the base currency, or number of contracts
price<code>float</code>Nothe price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingPercent<code>float</code>Yesthe percent to trail away from the current market price
trailingTriggerPrice<code>float</code>Yesthe price to activate a trailing order, default uses the price argument
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.createTrailingPercentOrder (symbol, type, side, amount[, price, trailingPercent, trailingTriggerPrice, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>Nofor swap markets only 'cross' or 'isolated', default 'cross'
params.triggerPrice<code>float</code>NoThe price a trigger order is triggered at
params.takeProfit<code>object</code>NotakeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
params.takeProfit.triggerPrice<code>float</code>Notake profit trigger price
params.stopLoss<code>object</code>NostopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
params.stopLoss.triggerPrice<code>float</code>Nostop loss trigger price
params.algoType<code>float</code>No'STOP' or 'TRAILING_STOP' or 'OCO' or 'CLOSE_POSITION'
params.cost<code>float</code>Nospot market buy only the quote quantity that can be used as an alternative for the amount
params.trailingAmount<code>string</code>Nothe quote amount to trail away from the current market price
params.trailingPercent<code>string</code>Nothe percent to trail away from the current market price
params.trailingTriggerPrice<code>string</code>Nothe price to trigger a trailing order, default uses the price argument
params.position_side<code>string</code>No'SHORT' or 'LONG' - if position mode is HEDGE_MODE and the trading involves futures, then is required, otherwise this parameter is not required
javascript
woo.createOrder (symbol, type, side, amount[, price, params])

<a name="editOrder" id="editorder"></a>

editOrder{docsify-ignore}

edit a trade order

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.triggerPrice<code>float</code>NoThe price a trigger order is triggered at
params.stopLossPrice<code>float</code>Noprice to trigger stop-loss orders
params.takeProfitPrice<code>float</code>Noprice to trigger take-profit orders
params.trailingAmount<code>string</code>Nothe quote amount to trail away from the current market price
params.trailingPercent<code>string</code>Nothe percent to trail away from the current market price
params.trailingTriggerPrice<code>string</code>Nothe price to trigger a trailing order, default uses the price argument
javascript
woo.editOrder (id, symbol, type, side, amount[, price, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
javascript
woo.cancelOrder (id, symbol[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
javascript
woo.cancelAllOrders (symbol[, params])

<a name="cancelAllOrdersAfter" id="cancelallordersafter"></a>

cancelAllOrdersAfter{docsify-ignore}

dead man's switch, cancel all orders after the given timeout

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - the api result

See: https://developer.woox.io/api-reference/endpoint/trading/cancel_all_after

ParamTypeRequiredDescription
timeout<code>number</code>Yestime in milliseconds, 0 represents cancel the timer
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.cancelAllOrdersAfter (timeout[, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
javascript
woo.fetchOrder (id, symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
params.isTriggered<code>boolean</code>Nowhether the order has been triggered (false by default)
params.side<code>string</code>No'buy' or 'sell'
params.paginate<code>boolean</code>Noset to true if you want to fetch orders with pagination
javascript
woo.fetchOrders (symbol[, since, limit, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
params.isTriggered<code>boolean</code>Nowhether the order has been triggered (false by default)
params.side<code>string</code>No'buy' or 'sell'
params.trailing<code>boolean</code>Noset to true if you want to fetch trailing orders
params.paginate<code>boolean</code>Noset to true if you want to fetch orders with pagination
javascript
woo.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>boolean</code>Nowhether the order is a trigger/algo order
params.isTriggered<code>boolean</code>Nowhether the order has been triggered (false by default)
params.side<code>string</code>No'buy' or 'sell'
params.trailing<code>boolean</code>Noset to true if you want to fetch trailing orders
params.paginate<code>boolean</code>Noset to true if you want to fetch orders with pagination
javascript
woo.fetchClosedOrders (symbol[, since, limit, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://developer.woox.io/api-reference/endpoint/public_data/orderbook

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchOrderBook (symbol[, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

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 <code>woo</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://developer.woox.io/api-reference/endpoint/public_data/klineHistory

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nomax=1000, max=100 when since is defined and is less than (now - (999 * (timeframe in ms)))
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch entries for
javascript
woo.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchOrderTrades" id="fetchordertrades"></a>

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://docs.woox.io/#get-trades

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchOrderTrades (id, symbol[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://developer.woox.io/api-reference/endpoint/trading/get_transactions

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.paginate<code>boolean</code>Noset to true if you want to fetch trades with pagination
javascript
woo.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchAccounts" id="fetchaccounts"></a>

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a dictionary of account structures indexed by the account type

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchAccounts ([params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a balance structure

See: https://docs.woox.io/#get-current-holding-get-balance-new

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchBalance ([params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an address structure

See: https://developer.woox.io/api-reference/endpoint/assets/get_wallet_deposit

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchDepositAddress (code[, params])

<a name="fetchLedger" id="fetchledger"></a>

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 <code>woo</code>
Returns: <code>object</code> - a ledger structure

See: https://developer.woox.io/api-reference/endpoint/assets/get_wallet_history

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code, default is undefined
since<code>int</code>Notimestamp in ms of the earliest ledger entry, default is undefined
limit<code>int</code>Nomax number of ledger entries to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchLedger ([code, since, limit, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://developer.woox.io/api-reference/endpoint/assets/get_wallet_history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://developer.woox.io/api-reference/endpoint/assets/get_wallet_history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchWithdrawals (code[, since, limit, params])

<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a list of transaction structure

See: https://developer.woox.io/api-reference/endpoint/assets/get_wallet_history

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code for the currency of the deposit/withdrawals, default is undefined
since<code>int</code>Notimestamp in ms of the earliest deposit/withdrawal, default is undefined
limit<code>int</code>Nomax number of deposit/withdrawals to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchDepositsWithdrawals ([code, since, limit, params])

<a name="transfer" id="transfer"></a>

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a transfer structure

See: https://docs.woox.io/#get-transfer-history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesamount to transfer
fromAccount<code>string</code>Yesaccount to transfer from
toAccount<code>string</code>Yesaccount to transfer to
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.transfer (code, amount, fromAccount, toAccount[, params])

<a name="fetchTransfers" id="fetchtransfers"></a>

fetchTransfers{docsify-ignore}

fetch a history of internal transfers made on an account

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of transfer structures

See: https://developer.woox.io/api-reference/endpoint/assets/get_transfer_history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency transferred
since<code>int</code>Nothe earliest time in ms to fetch transfers for
limit<code>int</code>Nothe maximum number of transfers structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch entries for
javascript
woo.fetchTransfers (code[, since, limit, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a transaction structure

See: https://docs.woox.io/#token-withdraw-v3

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.withdraw (code, amount, address, tag[, params])

<a name="repayMargin" id="repaymargin"></a>

repayMargin{docsify-ignore}

repay borrowed margin and interest

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a margin loan structure

See: https://docs.woox.io/#repay-interest

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency to repay
amount<code>float</code>Yesthe amount to repay
symbol<code>string</code>Yesnot used by woo.repayMargin ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.repayMargin (code, amount, symbol[, params])

<a name="fetchFundingHistory" id="fetchfundinghistory"></a>

fetchFundingHistory{docsify-ignore}

fetch the history of funding payments paid and received on this account

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a funding history structure

See: https://developer.woox.io/api-reference/endpoint/futures/get_fundingFee_history

ParamTypeRequiredDescription
symbol<code>string</code>Nounified market symbol
since<code>int</code>Nothe earliest time in ms to fetch funding history for
limit<code>int</code>Nothe maximum number of funding history structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
woo.fetchFundingHistory ([symbol, since, limit, params])

<a name="fetchFundingInterval" id="fetchfundinginterval"></a>

fetchFundingInterval{docsify-ignore}

fetch the current funding rate interval

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a funding rate structure

See: https://developer.woox.io/api-reference/endpoint/public_data/fundingRate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchFundingInterval (symbol[, params])

<a name="fetchFundingRate" id="fetchfundingrate"></a>

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a funding rate structure

See: https://developer.woox.io/api-reference/endpoint/public_data/fundingRate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchFundingRate (symbol[, params])

<a name="fetchFundingRates" id="fetchfundingrates"></a>

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of funding rate structures, indexed by market symbols

See: https://developer.woox.io/api-reference/endpoint/public_data/fundingRate

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchFundingRates (symbols[, params])

<a name="fetchFundingRateHistory" id="fetchfundingratehistory"></a>

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of funding rate structures

See: https://developer.woox.io/api-reference/endpoint/public_data/fundingRateHistory

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
since<code>int</code>Notimestamp in ms of the earliest funding rate to fetch
limit<code>int</code>Nothe maximum amount of funding rate structures to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest funding rate
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
woo.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="setPositionMode" id="setpositionmode"></a>

setPositionMode{docsify-ignore}

set hedged to true or false for a market

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - response from the exchange

See: https://developer.woox.io/api-reference/endpoint/futures/position_mode

ParamTypeRequiredDescription
hedged<code>bool</code>Yesset to true to use HEDGE_MODE, false for ONE_WAY
symbol<code>string</code>Yesnot used by woo setPositionMode
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.setPositionMode (hedged, symbol[, params])

<a name="fetchLeverage" id="fetchleverage"></a>

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a leverage structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>Nofor swap markets only 'cross' or 'isolated'
params.positionMode<code>string</code>Nofor swap markets only 'ONE_WAY' or 'HEDGE_MODE'
javascript
woo.fetchLeverage (symbol[, params])

<a name="setLeverage" id="setleverage"></a>

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - response from the exchange

See

ParamTypeRequiredDescription
leverage<code>float</code>Yesthe rate of leverage (1, 2, 3, 4 or 5 for spot markets, 1, 2, 3, 4, 5, 10, 15, 20 for swap markets)
symbol<code>string</code>Nounified market symbol (is mandatory for swap markets)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>Nofor swap markets only 'cross' or 'isolated'
params.positionMode<code>string</code>Nofor swap markets only 'ONE_WAY' or 'HEDGE_MODE'
javascript
woo.setLeverage (leverage[, symbol, params])

<a name="addMargin" id="addmargin"></a>

addMargin{docsify-ignore}

add margin

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a margin structure

See: https://docs.woox.io/#update-isolated-margin-setting

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesamount of margin to add
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.position_side<code>string</code>No'LONG' or 'SHORT' in hedge mode, 'BOTH' in one way mode
javascript
woo.addMargin (symbol, amount[, params])

<a name="reduceMargin" id="reducemargin"></a>

reduceMargin{docsify-ignore}

remove margin from a position

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a margin structure

See: https://docs.woox.io/#update-isolated-margin-setting

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesamount of margin to remove
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.position_side<code>string</code>No'LONG' or 'SHORT' in hedge mode, 'BOTH' in one way mode
javascript
woo.reduceMargin (symbol, amount[, params])

<a name="fetchPosition" id="fetchposition"></a>

fetchPosition{docsify-ignore}

fetch data on an open position

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a position structure

See: https://developer.woox.io/api-reference/endpoint/futures/get_positions

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the position is held in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchPosition (symbol[, params])

<a name="fetchPositions" id="fetchpositions"></a>

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://developer.woox.io/api-reference/endpoint/futures/get_positions

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchPositions ([symbols, params])

<a name="fetchConvertQuote" id="fetchconvertquote"></a>

fetchConvertQuote{docsify-ignore}

fetch a quote for converting from one currency to another

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a conversion structure

See: https://docs.woox.io/#get-quote-rfq

ParamTypeRequiredDescription
fromCode<code>string</code>Yesthe currency that you want to sell and convert from
toCode<code>string</code>Yesthe currency that you want to buy and convert into
amount<code>float</code>Nohow much you want to trade in units of the from currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchConvertQuote (fromCode, toCode[, amount, params])

<a name="createConvertTrade" id="createconverttrade"></a>

createConvertTrade{docsify-ignore}

convert from one currency to another

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a conversion structure

See: https://docs.woox.io/#send-quote-rft

ParamTypeRequiredDescription
id<code>string</code>Yesthe id of the trade that you want to make
fromCode<code>string</code>Yesthe currency that you want to sell and convert from
toCode<code>string</code>Yesthe currency that you want to buy and convert into
amount<code>float</code>Nohow much you want to trade in units of the from currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.createConvertTrade (id, fromCode, toCode[, amount, params])

<a name="fetchConvertTrade" id="fetchconverttrade"></a>

fetchConvertTrade{docsify-ignore}

fetch the data for a conversion trade

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a conversion structure

See: https://docs.woox.io/#get-quote-trade

ParamTypeRequiredDescription
id<code>string</code>Yesthe id of the trade that you want to fetch
code<code>string</code>Nothe unified currency code of the conversion trade
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchConvertTrade (id[, code, params])

<a name="fetchConvertTradeHistory" id="fetchconverttradehistory"></a>

fetchConvertTradeHistory{docsify-ignore}

fetch the users history of conversion trades

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of conversion structures

See: https://docs.woox.io/#get-quote-trades

ParamTypeRequiredDescription
code<code>string</code>Nothe unified currency code
since<code>int</code>Nothe earliest time in ms to fetch conversions for
limit<code>int</code>Nothe maximum number of conversion structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest conversion to fetch
javascript
woo.fetchConvertTradeHistory ([code, since, limit, params])

<a name="fetchConvertCurrencies" id="fetchconvertcurrencies"></a>

fetchConvertCurrencies{docsify-ignore}

fetches all available currencies that can be converted

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://docs.woox.io/#get-quote-asset-info

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchConvertCurrencies ([params])

<a name="fetchPositionsADLRank" id="fetchpositionsadlrank"></a>

fetchPositionsADLRank{docsify-ignore}

fetches the auto deleveraging rank and risk percentage for a list of symbols

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - an array of auto de leverage structures

See: https://docs.woox.io/#get-all-position-info-new

ParamTypeRequiredDescription
symbols<code>Array<string></code>Noa list of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.fetchPositionsADLRank ([symbols, params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return.
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.method<code>string</code>Noeither (default) 'orderbook' or 'orderbookupdate', default is 'orderbook'
javascript
woo.watchOrderBook (symbol[, limit, params])

<a name="unWatchOrderBook" id="unwatchorderbook"></a>

unWatchOrderBook{docsify-ignore}

unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.unWatchOrderBook (symbol[, params])

<a name="watchTicker" id="watchticker"></a>

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 <code>woo</code>
Returns: <code>object</code> - a ticker structure

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchTicker (symbol[, params])

<a name="unWatchTicker" id="unwatchticker"></a>

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 <code>woo</code>
Returns: <code>object</code> - a ticker structure

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.unWatchTicker (symbol[, params])

<a name="watchTickers" id="watchtickers"></a>

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 <code>woo</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.woox.io/#24h-tickers

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchTickers (symbols[, params])

<a name="unWatchTickers" id="unwatchtickers"></a>

unWatchTickers{docsify-ignore}

stops watching 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 <code>woo</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.woox.io/#24h-tickers

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to stop fetching the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.unWatchTickers (symbols[, params])

<a name="watchBidsAsks" id="watchbidsasks"></a>

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.woox.io/#bbos

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nounified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchBidsAsks ([symbols, params])

<a name="unWatchBidsAsks" id="unwatchbidsasks"></a>

unWatchBidsAsks{docsify-ignore}

unWatches best bid & ask for symbols

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.woox.io/#bbos

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nounified symbol of the market to fetch the ticker for (not used by woo)
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.unWatchBidsAsks ([symbols, params])

<a name="watchOHLCV" id="watchohlcv"></a>

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 <code>woo</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.woox.io/#k-line

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchOHLCV (symbol, timeframe[, since, limit, params])

<a name="unWatchOHLCV" id="unwatchohlcv"></a>

unWatchOHLCV{docsify-ignore}

unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of <code>woo</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.woox.io/#k-line

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market
timeframe<code>string</code>Yesthe length of time each candle represents
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.timezone<code>object</code>Noif provided, kline intervals are interpreted in that timezone instead of UTC, example '+08:00'
javascript
woo.unWatchOHLCV (symbol, timeframe[, params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

watches information on multiple trades made in a market

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://docs.woox.io/#trade

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market trades were made in
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trade structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchTrades (symbol[, since, limit, params])

<a name="unWatchTrades" id="unwatchtrades"></a>

unWatchTrades{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 <code>woo</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.woox.io/#trade

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.unWatchTrades (symbol[, params])

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>bool</code>Notrue if trigger order
javascript
woo.watchOrders (symbol[, since, limit, params])

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>bool</code>Notrue if trigger order
javascript
woo.watchMyTrades (symbol[, since, limit, params])

<a name="watchPositions" id="watchpositions"></a>

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of <code>woo</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://docs.woox.io/#position-push

ParamTypeDescription
symbols<code>Array<string></code>, <code>undefined</code>list of unified market symbols
since
limit
params<code>object</code>extra parameters specific to the exchange API endpoint
javascript
woo.watchPositions (symbols, since, limit, params[])

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a balance structure

See: https://docs.woox.io/#balance

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchBalance ([params])

<a name="watchFundingRate" id="watchfundingrate"></a>

watchFundingRate{docsify-ignore}

watch the current funding rate

Kind: instance method of <code>woo</code>
Returns: <code>object</code> - a funding rate structure

See: https://docs.woox.io/#estfundingrate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
woo.watchFundingRate (symbol[, params])