## hitbtc{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchMarkets](#fetchmarkets) * [fetchCurrencies](#fetchcurrencies) * [createDepositAddress](#createdepositaddress) * [fetchDepositAddress](#fetchdepositaddress) * [fetchBalance](#fetchbalance) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [fetchTrades](#fetchtrades) * [fetchMyTrades](#fetchmytrades) * [fetchDepositsWithdrawals](#fetchdepositswithdrawals) * [fetchDeposits](#fetchdeposits) * [fetchWithdrawals](#fetchwithdrawals) * [fetchOrderBooks](#fetchorderbooks) * [fetchOrderBook](#fetchorderbook) * [fetchTradingFee](#fetchtradingfee) * [fetchTradingFees](#fetchtradingfees) * [fetchOHLCV](#fetchohlcv) * [fetchClosedOrders](#fetchclosedorders) * [fetchOrder](#fetchorder) * [fetchOrderTrades](#fetchordertrades) * [fetchOpenOrders](#fetchopenorders) * [fetchOpenOrder](#fetchopenorder) * [cancelAllOrders](#cancelallorders) * [cancelOrder](#cancelorder) * [createOrder](#createorder) * [fetchMarginModes](#fetchmarginmodes) * [transfer](#transfer) * [withdraw](#withdraw) * [fetchFundingRates](#fetchfundingrates) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchPositions](#fetchpositions) * [fetchPosition](#fetchposition) * [fetchOpenInterest](#fetchopeninterest) * [fetchFundingRate](#fetchfundingrate) * [reduceMargin](#reducemargin) * [addMargin](#addmargin) * [fetchLeverage](#fetchleverage) * [setLeverage](#setleverage) * [fetchDepositWithdrawFees](#fetchdepositwithdrawfees) * [closePosition](#closeposition) * [watchOrderBook](#watchorderbook) * [watchTicker](#watchticker) * [watchTicker](#watchticker) * [watchTrades](#watchtrades) * [watchOHLCV](#watchohlcv) * [watchOrders](#watchorders) * [watchBalance](#watchbalance) * [createOrder](#createorder) * [cancelOrderWs](#cancelorderws) * [cancelAllOrdersWs](#cancelallordersws) * [fetchOpenOrdersWs](#fetchopenordersws) ### fetchMarkets{docsify-ignore} retrieves data on all markets for hitbtc **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - an array of objects representing market data **See**: https://api.hitbtc.com/#symbols | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchMarkets ([params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an associative dictionary of currencies **See**: https://api.hitbtc.com/#currencies | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchCurrencies ([params]) ``` ### createDepositAddress{docsify-ignore} create a currency deposit address **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://api.hitbtc.com/#generate-deposit-crypto-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 hitbtc.createDepositAddress (code[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://api.hitbtc.com/#get-deposit-crypto-address | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchDepositAddress (code[, 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 [hitbtc](#hitbtc) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://api.hitbtc.com/#wallet-balance - https://api.hitbtc.com/#get-spot-trading-balance - https://api.hitbtc.com/#get-trading-balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchBalance ([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 [hitbtc](#hitbtc) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.hitbtc.com/#tickers | 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 hitbtc.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 [hitbtc](#hitbtc) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.hitbtc.com/#tickers | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | 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 hitbtc.fetchTickers (symbols[, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://api.hitbtc.com/#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 hitbtc.fetchTrades (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See** - https://api.hitbtc.com/#spot-trades-history - https://api.hitbtc.com/#futures-trades-history - https://api.hitbtc.com/#margin-trades-history | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching margin trades | ```javascript hitbtc.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchDepositsWithdrawals{docsify-ignore} fetch history of deposits and withdrawals **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a list of [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.hitbtc.com/#get-transactions-history | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | unified currency code for the currency of the deposit/withdrawals, default is undefined | | since | int | No | timestamp in ms of the earliest deposit/withdrawal, default is undefined | | limit | int | No | max number of deposit/withdrawals to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchDepositsWithdrawals ([code, since, limit, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.hitbtc.com/#get-transactions-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 | ```javascript hitbtc.fetchDeposits (code[, since, limit, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.hitbtc.com/#get-transactions-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 | ```javascript hitbtc.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchOrderBooks{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbol **See**: https://api.hitbtc.com/#order-books | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols, all symbols fetched if undefined, default is undefined | | limit | int | No | max number of entries per orderbook to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchOrderBooks (symbols[, limit, params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://api.hitbtc.com/#order-books | 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 | ```javascript hitbtc.fetchOrderBook (symbol[, limit, params]) ``` ### fetchTradingFee{docsify-ignore} fetch the trading fees for a market **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [fee structure](https://docs.ccxt.com/#/?id=fee-structure) **See** - https://api.hitbtc.com/#get-trading-commission - https://api.hitbtc.com/#get-trading-commission-2 | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchTradingFee (symbol[, params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See** - https://api.hitbtc.com/#get-all-trading-commissions - https://api.hitbtc.com/#get-all-trading-commissions-2 | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchTradingFees ([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 [hitbtc](#hitbtc) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://api.hitbtc.com/#candles - https://api.hitbtc.com/#futures-index-price-candles - https://api.hitbtc.com/#futures-mark-price-candles - https://api.hitbtc.com/#futures-premium-index-candles | 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.until | int | No | timestamp in ms of the latest funding rate | | 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 hitbtc.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#spot-orders-history - https://api.hitbtc.com/#futures-orders-history - https://api.hitbtc.com/#margin-orders-history | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching margin orders | ```javascript hitbtc.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#spot-orders-history - https://api.hitbtc.com/#futures-orders-history - https://api.hitbtc.com/#margin-orders-history | Param | Type | Required | Description | | --- | --- | --- | --- | | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching a margin order | ```javascript hitbtc.fetchOrder (symbol[, params]) ``` ### fetchOrderTrades{docsify-ignore} fetch all the trades made from a single order **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See** - https://api.hitbtc.com/#spot-trades-history - https://api.hitbtc.com/#futures-trades-history - https://api.hitbtc.com/#margin-trades-history | 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 | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching margin trades | ```javascript hitbtc.fetchOrderTrades (id, symbol[, since, limit, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#get-all-active-spot-orders - https://api.hitbtc.com/#get-active-futures-orders - https://api.hitbtc.com/#get-active-margin-orders | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching open margin orders | ```javascript hitbtc.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchOpenOrder{docsify-ignore} fetch an open order by it's id **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#get-active-spot-order - https://api.hitbtc.com/#get-active-futures-order - https://api.hitbtc.com/#get-active-margin-order | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching an open margin order | ```javascript hitbtc.fetchOpenOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#cancel-all-spot-orders - https://api.hitbtc.com/#cancel-futures-orders - https://api.hitbtc.com/#cancel-all-margin-orders | 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 | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for canceling margin orders | ```javascript hitbtc.cancelAllOrders (symbol[, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#cancel-spot-order - https://api.hitbtc.com/#cancel-futures-order - https://api.hitbtc.com/#cancel-margin-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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for canceling a margin order | ```javascript hitbtc.cancelOrder (id, symbol[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#create-new-spot-order - https://api.hitbtc.com/#create-margin-order - https://api.hitbtc.com/#create-futures-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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported for spot-margin, swap supports both, default is 'cross' | | params.margin | bool | No | true for creating a margin order | | params.triggerPrice | float | No | The price at which a trigger order is triggered at | | params.postOnly | bool | No | if true, the order will only be posted to the order book and not executed immediately | | params.timeInForce | string | No | "GTC", "IOC", "FOK", "Day", "GTD" | ```javascript hitbtc.createOrder (symbol, type, side, amount[, price, params]) ``` ### fetchMarginModes{docsify-ignore} fetches margin mode of the user **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a list of [margin mode structures](https://docs.ccxt.com/#/?id=margin-mode-structure) **See** - https://api.hitbtc.com/#get-margin-position-parameters - https://api.hitbtc.com/#get-futures-position-parameters | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchMarginModes (symbol[, params]) ``` ### transfer{docsify-ignore} transfer currency internally between wallets on the same account **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://api.hitbtc.com/#transfer-between-wallet-and-exchange | 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 hitbtc.transfer (code, amount, fromAccount, toAccount[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://api.hitbtc.com/#withdraw-crypto | 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 hitbtc.withdraw (code, amount, address, tag[, params]) ``` ### fetchFundingRates{docsify-ignore} fetches funding rates for multiple markets **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an array of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://api.hitbtc.com/#futures-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbols of the markets to fetch the funding rates for, all market funding rates are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchFundingRates (symbols[, params]) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) **See**: https://api.hitbtc.com/#funding-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.until | int | No | timestamp in ms of the latest funding rate | | 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 hitbtc.fetchFundingRateHistory (symbol[, since, limit, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See** - https://api.hitbtc.com/#get-futures-margin-accounts - https://api.hitbtc.com/#get-all-margin-accounts | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | not used by hitbtc fetchPositions () | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported, defaults to spot-margin endpoint if this is set | | params.margin | bool | No | true for fetching spot-margin positions | ```javascript hitbtc.fetchPositions (symbols[, params]) ``` ### fetchPosition{docsify-ignore} fetch data on a single open contract trade position **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [position structure](https://docs.ccxt.com/#/?id=position-structure) **See** - https://api.hitbtc.com/#get-futures-margin-account - https://api.hitbtc.com/#get-isolated-margin-account | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported, defaults to spot-margin endpoint if this is set | | params.margin | bool | No | true for fetching a spot-margin position | ```javascript hitbtc.fetchPosition (symbol[, params]) ``` ### fetchOpenInterest{docsify-ignore} Retrieves the open interest of a derivative trading pair **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an open interest structure[https://docs.ccxt.com/#/?id=interest-history-structure](https://docs.ccxt.com/#/?id=interest-history-structure) **See**: https://api.hitbtc.com/#futures-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | Unified CCXT market symbol | | params | object | No | exchange specific parameters | ```javascript hitbtc.fetchOpenInterest (symbol[, params]) ``` ### fetchFundingRate{docsify-ignore} fetch the current funding rate **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://api.hitbtc.com/#futures-info | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.fetchFundingRate (symbol[, params]) ``` ### reduceMargin{docsify-ignore} remove margin from a position **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=reduce-margin-structure) **See** - https://api.hitbtc.com/#create-update-margin-account-2 - https://api.hitbtc.com/#create-update-margin-account | 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 | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported, defaults to the spot-margin endpoint if this is set | | params.margin | bool | No | true for reducing spot-margin | ```javascript hitbtc.reduceMargin (symbol, amount[, params]) ``` ### addMargin{docsify-ignore} add margin **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure) **See** - https://api.hitbtc.com/#create-update-margin-account-2 - https://api.hitbtc.com/#create-update-margin-account | 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 | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported, defaults to the spot-margin endpoint if this is set | | params.margin | bool | No | true for adding spot-margin | ```javascript hitbtc.addMargin (symbol, amount[, params]) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure) **See** - https://api.hitbtc.com/#get-futures-margin-account - https://api.hitbtc.com/#get-isolated-margin-account | 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' only 'isolated' is supported, defaults to the spot-margin endpoint if this is set | | params.margin | bool | No | true for fetching spot-margin leverage | ```javascript hitbtc.fetchLeverage (symbol[, params]) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - response from the exchange **See**: https://api.hitbtc.com/#create-update-margin-account-2 | 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 | ```javascript hitbtc.setLeverage (leverage, symbol[, params]) ``` ### fetchDepositWithdrawFees{docsify-ignore} fetch deposit and withdraw fees **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [fees structures](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://api.hitbtc.com/#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 hitbtc.fetchDepositWithdrawFees (codes[, params]) ``` ### closePosition{docsify-ignore} closes open positions for a market **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.hitbtc.com/#close-all-futures-margin-positions | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the okx api endpoint | | params.symbol | string | No | *required* unified market symbol | | params.marginMode | string | No | 'cross' or 'isolated', default is 'cross' | ```javascript hitbtc.closePosition ([params]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See** - https://api.hitbtc.com/#subscribe-to-full-order-book - https://api.hitbtc.com/#subscribe-to-partial-order-book - https://api.hitbtc.com/#subscribe-to-partial-order-book-in-batches - https://api.hitbtc.com/#subscribe-to-top-of-book - https://api.hitbtc.com/#subscribe-to-top-of-book-in-batches | 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 | 'orderbook/full', 'orderbook/{depth}/{speed}', 'orderbook/{depth}/{speed}/batch', 'orderbook/top/{speed}', or 'orderbook/top/{speed}/batch' | | params.depth | int | No | 5 , 10, or 20 (default) | | params.speed | int | No | 100 (default), 500, or 1000 | ```javascript hitbtc.watchOrderBook (symbol[, limit, 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 [hitbtc](#hitbtc) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See** - https://api.hitbtc.com/#subscribe-to-ticker - https://api.hitbtc.com/#subscribe-to-ticker-in-batches - https://api.hitbtc.com/#subscribe-to-mini-ticker - https://api.hitbtc.com/#subscribe-to-mini-ticker-in-batches | 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.method | string | No | 'ticker/{speed}' (default), or 'ticker/price/{speed}' | | params.speed | string | No | '1s' (default), or '3s' | ```javascript hitbtc.watchTicker (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 [hitbtc](#hitbtc) **Returns**: object - a [ticker structure](https://docs.ccxt.com/en/latest/manual.html#ticker-structure) | Param | Type | Description | | --- | --- | --- | | symbol | string | unified symbol of the market to fetch the ticker for | | params | object | extra parameters specific to the exchange API endpoint | | params.method | string | 'ticker/{speed}' (default),'ticker/price/{speed}', 'ticker/{speed}/batch', or 'ticker/{speed}/price/batch'' | | params.speed | string | '1s' (default), or '3s' | ```javascript hitbtc.watchTicker (symbol, params[]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://api.hitbtc.com/#subscribe-to-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 hitbtc.watchTrades (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 [hitbtc](#hitbtc) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://api.hitbtc.com/#subscribe-to-candles | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | No | the length of time each candle represents | | since | int | No | not used by hitbtc watchOHLCV | | limit | int | No | 0 – 1000, default value = 0 (no history returned) | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.watchOHLCV (symbol[, timeframe, since, limit, params]) ``` ### watchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/en/latest/manual.html#order-structure) **See** - https://api.hitbtc.com/#subscribe-to-reports - https://api.hitbtc.com/#subscribe-to-reports-2 - https://api.hitbtc.com/#subscribe-to-reports-3 | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified CCXT market symbol | | since | int | No | timestamp in ms of the earliest order to fetch | | limit | int | No | the maximum amount of orders to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript hitbtc.watchOrders ([symbol, since, limit, params]) ``` ### watchBalance{docsify-ignore} watches balance updates, cannot subscribe to margin account balances **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [balance structures](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://api.hitbtc.com/#subscribe-to-spot-balances - https://api.hitbtc.com/#subscribe-to-futures-balances | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | | params.type | string | No | 'spot', 'swap', or 'future' EXCHANGE SPECIFIC PARAMETERS | | params.mode | string | No | 'updates' or 'batches' (default), 'updates' = messages arrive after balance updates, 'batches' = messages arrive at equal intervals if there were any updates | ```javascript hitbtc.watchBalance ([params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - an [order structure](https://github.com/ccxt/ccxt/wiki/Manual#order-structure) **See** - https://api.hitbtc.com/#create-new-spot-order - https://api.hitbtc.com/#create-margin-order - https://api.hitbtc.com/#create-futures-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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported for spot-margin, swap supports both, default is 'cross' | | params.margin | bool | No | true for creating a margin order | | params.triggerPrice | float | No | The price at which a trigger order is triggered at | | params.postOnly | bool | No | if true, the order will only be posted to the order book and not executed immediately | | params.timeInForce | string | No | "GTC", "IOC", "FOK", "Day", "GTD" | ```javascript hitbtc.createOrder (symbol, type, side, amount[, price, params]) ``` ### cancelOrderWs{docsify-ignore} cancels an open order **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#cancel-spot-order-2 - https://api.hitbtc.com/#cancel-futures-order-2 - https://api.hitbtc.com/#cancel-margin-order-2 | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for canceling a margin order | ```javascript hitbtc.cancelOrderWs (id, symbol[, params]) ``` ### cancelAllOrdersWs{docsify-ignore} cancel all open orders **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#cancel-spot-orders - https://api.hitbtc.com/#cancel-futures-order-3 | 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 | | params.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for canceling margin orders | ```javascript hitbtc.cancelAllOrdersWs (symbol[, params]) ``` ### fetchOpenOrdersWs{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [hitbtc](#hitbtc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://api.hitbtc.com/#get-active-futures-orders-2 - https://api.hitbtc.com/#get-margin-orders - https://api.hitbtc.com/#get-active-spot-orders | 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.marginMode | string | No | 'cross' or 'isolated' only 'isolated' is supported | | params.margin | bool | No | true for fetching open margin orders | ```javascript hitbtc.fetchOpenOrdersWs (symbol[, since, limit, params]) ```