Htx

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

htx{docsify-ignore}

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

• fetchStatus
• fetchTime
• fetchTradingFee
• fetchMarkets
• fetchTicker
• fetchTickers
• fetchLastPrices
• fetchOrderBook
• fetchOrderTrades
• fetchMyTrades
• fetchTrades
• fetchOHLCV
• fetchAccounts
• fetchAccountIdByType
• fetchCurrencies
• fetchBalance
• fetchOrder
• fetchOrders
• fetchClosedOrders
• fetchOpenOrders
• createMarketBuyOrderWithCost
• createTrailingPercentOrder
• createOrder
• createOrders
• cancelOrder
• cancelOrders
• cancelAllOrders
• cancelAllOrdersAfter
• fetchDepositAddressesByNetwork
• fetchDepositAddress
• fetchDeposits
• fetchWithdrawals
• withdraw
• transfer
• fetchIsolatedBorrowRates
• fetchFundingRateHistory
• fetchFundingRate
• fetchFundingRates
• fetchBorrowInterest
• fetchFundingHistory
• setLeverage
• fetchPositions
• fetchPosition
• fetchLedger
• fetchLeverageTiers
• fetchOpenInterestHistory
• fetchOpenInterests
• fetchOpenInterest
• borrowIsolatedMargin
• borrowCrossMargin
• repayIsolatedMargin
• repayCrossMargin
• fetchSettlementHistory
• fetchDepositWithdrawFees
• fetchLiquidations
• closePositions
• setPositionMode
• fetchPositionsADLRank
• watchTicker
• unWatchTicker
• watchTrades
• unWatchTrades
• watchOHLCV
• unWatchOHLCV
• watchOrderBook
• unWatchOrderBook
• watchMyTrades
• watchOrders
• watchPositions
• watchBalance

<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>htx</code>
Returns: <code>object</code> - a status structure

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-system-status
• https://huobiapi.github.io/docs/dm/v1/en/#get-system-status
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-system-status
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#get-system-status
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#query-whether-the-system-is-available // contractPublicGetHeartbeat

htx.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>htx</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-current-timestamp
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-current-system-timestamp

htx.fetchTime ([params])

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

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

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

See: https://huobiapi.github.io/docs/spot/v1/en/#get-current-fee-rate-applied-to-the-user

htx.fetchTradingFee (symbol[, params])

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

fetchMarkets{docsify-ignore}

retrieves data on all markets for huobi

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-all-supported-trading-symbol-v1-deprecated
• https://huobiapi.github.io/docs/dm/v1/en/#get-contract-info
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-swap-info
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-swap-info

htx.fetchMarkets ([params])

<a name="fetchTicker" id="fetchticker"></a>

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-latest-aggregated-ticker
• https://huobiapi.github.io/docs/dm/v1/en/#get-market-data-overview
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-market-data-overview
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-market-data-overview

htx.fetchTicker (symbol[, params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-latest-tickers-for-all-pairs
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-a-batch-of-market-data-overview
• https://huobiapi.github.io/docs/dm/v1/en/#get-a-batch-of-market-data-overview
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-a-batch-of-market-data-overview-v2

htx.fetchTickers ([symbols, params])

<a name="fetchLastPrices" id="fetchlastprices"></a>

fetchLastPrices{docsify-ignore}

fetches the last price for multiple markets

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a dictionary of lastprices structures

See

• https://www.htx.com/en-us/opend/newApiPages/?id=8cb81024-77b5-11ed-9966-0242ac110003 linear swap & linear future
• https://www.htx.com/en-us/opend/newApiPages/?id=28c2e8fc-77ae-11ed-9966-0242ac110003 inverse future
• https://www.htx.com/en-us/opend/newApiPages/?id=5d517ef5-77b6-11ed-9966-0242ac110003 inverse swap

htx.fetchLastPrices ([symbols, 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>htx</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-market-depth
• https://huobiapi.github.io/docs/dm/v1/en/#get-market-depth
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-market-depth
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-market-depth

htx.fetchOrderBook (symbol[, 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>htx</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://huobiapi.github.io/docs/spot/v1/en/#get-the-match-result-of-an-order

htx.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>htx</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-get-history-match-results-via-multiple-fields-new
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-get-history-match-results-via-multiple-fields-new
• https://huobiapi.github.io/docs/spot/v1/en/#search-match-results

htx.fetchMyTrades (symbol[, since, limit, 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>htx</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-the-most-recent-trades
• https://huobiapi.github.io/docs/dm/v1/en/#query-a-batch-of-trade-records-of-a-contract
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-a-batch-of-trade-records-of-a-contract
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-a-batch-of-trade-records-of-a-contract

htx.fetchTrades (symbol[, since, 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>htx</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-klines-candles
• https://huobiapi.github.io/docs/dm/v1/en/#get-kline-data
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-kline-data
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-kline-data

htx.fetchOHLCV (symbol, timeframe[, 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>htx</code>
Returns: <code>object</code> - a dictionary of account structures indexed by the account type

See: https://huobiapi.github.io/docs/spot/v1/en/#get-all-accounts-of-the-current-user

htx.fetchAccounts ([params])

<a name="fetchAccountIdByType" id="fetchaccountidbytype"></a>

fetchAccountIdByType{docsify-ignore}

fetch all the accounts by a type and marginModeassociated with a profile

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

See: https://huobiapi.github.io/docs/spot/v1/en/#get-all-accounts-of-the-current-user

htx.fetchAccountIdByType (type[, marginMode, symbol, params])

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

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://huobiapi.github.io/docs/spot/v1/en/#apiv2-currency-amp-chains

htx.fetchCurrencies ([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>htx</code>
Returns: <code>object</code> - a balance structure

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-account-balance-of-a-specific-account
• https://www.htx.com/en-us/opend/newApiPages/?id=7ec4b429-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=10000074-77b7-11ed-9966-0242ac110003
• https://huobiapi.github.io/docs/dm/v1/en/#query-asset-valuation
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-user-s-account-information
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-query-user-s-account-information
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-query-user-39-s-account-information
• https://www.htx.com/en-us/opend/newApiPages/?id=8cb89359-77b5-11ed-9966-19588469969

htx.fetchBalance ([params])

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

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-the-order-detail-of-an-order-based-on-client-order-id
• https://huobiapi.github.io/docs/spot/v1/en/#get-the-order-detail-of-an-order
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-get-information-of-an-order
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-get-information-of-order
• https://huobiapi.github.io/docs/dm/v1/en/#get-information-of-an-order
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-information-of-an-order

htx.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>htx</code>
Returns: <code>Array<Order></code> - a list of order structures

See

• https://huobiapi.github.io/docs/spot/v1/en/#search-past-orders
• https://huobiapi.github.io/docs/spot/v1/en/#search-historical-orders-within-48-hours
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-get-history-orders-new
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-get-history-orders-new
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-history-orders-new
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-history-orders-via-multiple-fields-new

htx.fetchOrders (symbol[, since, limit, params])

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#search-past-orders
• https://huobiapi.github.io/docs/spot/v1/en/#search-historical-orders-within-48-hours
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-get-history-orders-new
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-get-history-orders-new
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-history-orders-new
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-history-orders-via-multiple-fields-new

htx.fetchClosedOrders (symbol[, since, limit, params])

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#get-all-open-orders
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-current-unfilled-order-acquisition
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-current-unfilled-order-acquisition

htx.fetchOpenOrders (symbol[, since, limit, 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>htx</code>
Returns: <code>object</code> - an order structure

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec4ee16-7773-11ed-9966-0242ac110003

htx.createMarketBuyOrderWithCost (symbol, cost[, 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>htx</code>
Returns: <code>object</code> - an order structure

htx.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>htx</code>
Returns: <code>object</code> - an order structure

See

• https://huobiapi.github.io/docs/spot/v1/en/#place-a-new-order // spot, margin
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#place-an-order // coin-m swap
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#place-trigger-order // coin-m swap trigger
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-place-an-order // usdt-m swap cross
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-place-trigger-order // usdt-m swap cross trigger
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-place-an-order // usdt-m swap isolated
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-place-trigger-order // usdt-m swap isolated trigger
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-set-a-take-profit-and-stop-loss-order-for-an-existing-position
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-set-a-take-profit-and-stop-loss-order-for-an-existing-position
• https://huobiapi.github.io/docs/dm/v1/en/#place-an-order // coin-m futures
• https://huobiapi.github.io/docs/dm/v1/en/#place-trigger-order // coin-m futures contract trigger

htx.createOrder (symbol, type, side, amount[, price, params])

<a name="createOrders" id="createorders"></a>

createOrders{docsify-ignore}

create a list of trade orders

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#place-a-batch-of-orders
• https://huobiapi.github.io/docs/dm/v1/en/#place-a-batch-of-orders
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#place-a-batch-of-orders
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-place-a-batch-of-orders
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-place-a-batch-of-orders

htx.createOrders (orders[, params])

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

cancelOrder{docsify-ignore}

cancels an open order

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

htx.cancelOrder (id, symbol[, params])

<a name="cancelOrders" id="cancelorders"></a>

cancelOrders{docsify-ignore}

cancel multiple orders

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

htx.cancelOrders (ids, symbol[, params])

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

cancelAllOrders{docsify-ignore}

cancel all open orders

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

htx.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>htx</code>
Returns: <code>object</code> - the api result

See: https://huobiapi.github.io/docs/spot/v1/en/#dead-man-s-switch

htx.cancelAllOrdersAfter (timeout[, params])

<a name="fetchDepositAddressesByNetwork" id="fetchdepositaddressesbynetwork"></a>

fetchDepositAddressesByNetwork{docsify-ignore}

fetch a dictionary of addresses for a currency, indexed by network

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a dictionary of address structures indexed by the network

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec50029-7773-11ed-9966-0242ac110003

htx.fetchDepositAddressesByNetwork (code[, 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>htx</code>
Returns: <code>object</code> - an address structure

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec50029-7773-11ed-9966-0242ac110003

htx.fetchDepositAddress (code[, params])

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec4f050-7773-11ed-9966-0242ac110003

htx.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>htx</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://huobiapi.github.io/docs/spot/v1/en/#search-for-existed-withdraws-and-deposits

htx.fetchWithdrawals (code[, since, limit, params])

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

withdraw{docsify-ignore}

make a withdrawal

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

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec4cc41-7773-11ed-9966-0242ac110003

htx.withdraw (code, amount, address, tag[, params])

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

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

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

See

• https://huobiapi.github.io/docs/dm/v1/en/#transfer-margin-between-spot-account-and-future-account
• https://huobiapi.github.io/docs/spot/v1/en/#transfer-fund-between-spot-account-and-future-contract-account
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-transfer-margin-between-spot-account-and-usdt-margined-contracts-account
• https://huobiapi.github.io/docs/spot/v1/en/#transfer-asset-from-spot-trading-account-to-cross-margin-account-cross
• https://huobiapi.github.io/docs/spot/v1/en/#transfer-asset-from-spot-trading-account-to-isolated-margin-account-isolated
• https://huobiapi.github.io/docs/spot/v1/en/#transfer-asset-from-cross-margin-account-to-spot-trading-account-cross
• https://huobiapi.github.io/docs/spot/v1/en/#transfer-asset-from-isolated-margin-account-to-spot-trading-account-isolated

htx.transfer (code, amount, fromAccount, toAccount[, params])

<a name="fetchIsolatedBorrowRates" id="fetchisolatedborrowrates"></a>

fetchIsolatedBorrowRates{docsify-ignore}

fetch the borrow interest rates of all currencies

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a list of isolated borrow rate structures

See: https://huobiapi.github.io/docs/spot/v1/en/#get-loan-interest-rate-and-quota-isolated

htx.fetchIsolatedBorrowRates ([params])

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

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-historical-funding-rate
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-historical-funding-rate

htx.fetchFundingRateHistory (symbol[, since, limit, params])

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

fetchFundingRate{docsify-ignore}

fetch the current funding rate

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

See

• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-funding-rate
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-funding-rate

htx.fetchFundingRate (symbol[, params])

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

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-a-batch-of-funding-rate
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-a-batch-of-funding-rate

htx.fetchFundingRates (symbols[, params])

<a name="fetchBorrowInterest" id="fetchborrowinterest"></a>

fetchBorrowInterest{docsify-ignore}

fetch the interest owed by the user for borrowing currency for margin trading

Kind: instance method of <code>htx</code>
Returns: <code>Array<object></code> - a list of borrow interest structures

See

• https://huobiapi.github.io/docs/spot/v1/en/#search-past-margin-orders-cross
• https://huobiapi.github.io/docs/spot/v1/en/#search-past-margin-orders-isolated

htx.fetchBorrowInterest (code, symbol[, since, limit, 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>htx</code>
Returns: <code>object</code> - a funding history structure

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-account-financial-records-via-multiple-fields-new // linear swaps
• https://huobiapi.github.io/docs/dm/v1/en/#query-financial-records-via-multiple-fields-new // coin-m futures
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-financial-records-via-multiple-fields-new // coin-m swaps

htx.fetchFundingHistory (symbol[, since, limit, params])

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

setLeverage{docsify-ignore}

set the level of leverage for a market

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-switch-leverage
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-switch-leverage
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#switch-leverage
• https://huobiapi.github.io/docs/dm/v1/en/#switch-leverage // Coin-m futures

htx.setLeverage (leverage, symbol[, params])

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

fetchPositions{docsify-ignore}

fetch all open positions

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-query-user-39-s-position-information
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-query-user-s-position-information
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-user-s-position-information
• https://huobiapi.github.io/docs/dm/v1/en/#query-user-s-position-information

htx.fetchPositions ([symbols, params])

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

fetchPosition{docsify-ignore}

fetch data on a single open contract trade position

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-query-assets-and-positions
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-query-assets-and-positions
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-assets-and-positions
• https://huobiapi.github.io/docs/dm/v1/en/#query-assets-and-positions

htx.fetchPosition (symbol[, params])

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

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a ledger structure

See: https://huobiapi.github.io/docs/spot/v1/en/#get-account-history

htx.fetchLedger ([code, since, limit, params])

<a name="fetchLeverageTiers" id="fetchleveragetiers"></a>

fetchLeverageTiers{docsify-ignore}

retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - a dictionary of leverage tiers structures, indexed by market symbols

htx.fetchLeverageTiers (symbols[, params])

<a name="fetchOpenInterestHistory" id="fetchopeninteresthistory"></a>

fetchOpenInterestHistory{docsify-ignore}

Retrieves the open interest history of a currency

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - an array of open interest structures

See

• https://huobiapi.github.io/docs/dm/v1/en/#query-information-on-open-interest
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-information-on-open-interest
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-information-on-open-interest

htx.fetchOpenInterestHistory (symbol, timeframe[, since, limit, params])

<a name="fetchOpenInterests" id="fetchopeninterests"></a>

fetchOpenInterests{docsify-ignore}

Retrieves the open interest for a list of symbols

Kind: instance method of <code>htx</code>
Returns: <code>Array<object></code> - a list of open interest structures

See

• https://huobiapi.github.io/docs/dm/v1/en/#get-contract-open-interest-information
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-swap-open-interest-information
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-swap-open-interest-information

htx.fetchOpenInterests ([symbols, params])

<a name="fetchOpenInterest" id="fetchopeninterest"></a>

fetchOpenInterest{docsify-ignore}

Retrieves the open interest of a currency

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - an open interest structurehttps://docs.ccxt.com/?id=open-interest-structure

See

• https://huobiapi.github.io/docs/dm/v1/en/#get-contract-open-interest-information
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#get-swap-open-interest-information
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-get-swap-open-interest-information

htx.fetchOpenInterest (symbol[, params])

<a name="borrowIsolatedMargin" id="borrowisolatedmargin"></a>

borrowIsolatedMargin{docsify-ignore}

create a loan to borrow margin

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-isolated
• https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-cross

htx.borrowIsolatedMargin (symbol, code, amount[, params])

<a name="borrowCrossMargin" id="borrowcrossmargin"></a>

borrowCrossMargin{docsify-ignore}

create a loan to borrow margin

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

See

• https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-isolated
• https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-cross

htx.borrowCrossMargin (code, amount[, params])

<a name="repayIsolatedMargin" id="repayisolatedmargin"></a>

repayIsolatedMargin{docsify-ignore}

repay borrowed margin and interest

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

See: https://huobiapi.github.io/docs/spot/v1/en/#repay-margin-loan-cross-isolated

htx.repayIsolatedMargin (symbol, code, amount[, params])

<a name="repayCrossMargin" id="repaycrossmargin"></a>

repayCrossMargin{docsify-ignore}

repay borrowed margin and interest

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

See: https://huobiapi.github.io/docs/spot/v1/en/#repay-margin-loan-cross-isolated

htx.repayCrossMargin (code, amount[, params])

<a name="fetchSettlementHistory" id="fetchsettlementhistory"></a>

fetchSettlementHistory{docsify-ignore}

Fetches historical settlement records

Kind: instance method of <code>htx</code>
Returns: <code>Array<object></code> - a list of settlement history objects

See

• https://huobiapi.github.io/docs/dm/v1/en/#query-historical-settlement-records-of-the-platform-interface
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-historical-settlement-records-of-the-platform-interface
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-historical-settlement-records-of-the-platform-interface

htx.fetchSettlementHistory (symbol[, since, limit, params])

<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

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

See: https://huobiapi.github.io/docs/spot/v1/en/#get-all-supported-currencies-v2

htx.fetchDepositWithdrawFees (codes[, params])

<a name="fetchLiquidations" id="fetchliquidations"></a>

fetchLiquidations{docsify-ignore}

retrieves the public liquidations of a trading pair

Kind: instance method of <code>htx</code>
Returns: <code>object</code> - an array of liquidation structures

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-query-liquidation-orders-new
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#query-liquidation-orders-new
• https://huobiapi.github.io/docs/dm/v1/en/#query-liquidation-order-information-new

htx.fetchLiquidations (symbol[, since, limit, params])

<a name="closePositions" id="closepositions"></a>

closePositions{docsify-ignore}

closes open positions for a contract market, requires 'amount' in params, unlike other exchanges

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-place-lightning-close-order // USDT-M (isolated)
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-place-lightning-close-position // USDT-M (cross)
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#place-lightning-close-order // Coin-M swap
• https://huobiapi.github.io/docs/dm/v1/en/#place-flash-close-order // Coin-M futures

htx.closePositions (symbol, side[, params])

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

setPositionMode{docsify-ignore}

set hedged to true or false

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

See

• https://huobiapi.github.io/docs/usdt_swap/v1/en/#isolated-switch-position-mode
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#cross-switch-position-mode

htx.setPositionMode (hedged[, symbol, 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>htx</code>
Returns: <code>Array<object></code> - an array of auto de leverage structures

See

• https://www.htx.com/en-us/opend/newApiPages/?id=8cb81b5a-77b5-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=8cb81c49-77b5-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c2f164-77ae-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=5d518648-77b6-11ed-9966-0242ac110003

htx.fetchPositionsADLRank ([symbols, 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>htx</code>
Returns: <code>object</code> - a ticker structure

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53561-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33ab2-77ae-11ed-9966-0242ac110003

htx.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 all markets of a specific list

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

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53561-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33ab2-77ae-11ed-9966-0242ac110003

htx.unWatchTicker (symbol[, params])

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

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53b69-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33c21-77ae-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33cfe-77ae-11ed-9966-0242ac110003

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

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53b69-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33c21-77ae-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33cfe-77ae-11ed-9966-0242ac110003

htx.unWatchTrades (symbol[, 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>htx</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53241-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c3346a-77ae-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33563-77ae-11ed-9966-0242ac110003

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

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec53241-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c3346a-77ae-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c33563-77ae-11ed-9966-0242ac110003

htx.unWatchOHLCV (symbol, timeframe[, 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>htx</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

• https://huobiapi.github.io/docs/dm/v1/en/#subscribe-market-depth-data
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#subscribe-incremental-market-depth-data
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-subscribe-incremental-market-depth-data

htx.watchOrderBook (symbol[, limit, params])

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

unWatchOrderBook{docsify-ignore}

unsubscribe from the orderbook channel

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

See

• https://huobiapi.github.io/docs/dm/v1/en/#subscribe-market-depth-data
• https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#subscribe-incremental-market-depth-data
• https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-subscribe-incremental-market-depth-data

htx.unWatchOrderBook (symbol[, params])

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

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

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

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec53dd5-7773-11ed-9966-0242ac110003

htx.watchMyTrades (symbol[, since, limit, params])

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

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See: https://www.htx.com/en-us/opend/newApiPages/?id=7ec53c8f-7773-11ed-9966-0242ac110003

htx.watchOrders (symbol[, since, limit, params])

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

watchPositions{docsify-ignore}

watch all open positions. Note: huobi has one channel for each marginMode and type

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

See

• https://www.huobi.com/en-in/opend/newApiPages/?id=8cb7de1c-77b5-11ed-9966-0242ac110003
• https://www.huobi.com/en-in/opend/newApiPages/?id=8cb7df0f-77b5-11ed-9966-0242ac110003
• https://www.huobi.com/en-in/opend/newApiPages/?id=28c34a7d-77ae-11ed-9966-0242ac110003
• https://www.huobi.com/en-in/opend/newApiPages/?id=5d5156b5-77b6-11ed-9966-0242ac110003

htx.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>htx</code>
Returns: <code>object</code> - a balance structure

See

• https://www.htx.com/en-us/opend/newApiPages/?id=7ec52e28-7773-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=10000084-77b7-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=8cb7dcca-77b5-11ed-9966-0242ac110003
• https://www.htx.com/en-us/opend/newApiPages/?id=28c34995-77ae-11ed-9966-0242ac110003

htx.watchBalance ([params])