hitbtc
hitbtc cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
hitbtc
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- createDepositAddress
- fetchDepositAddress
- fetchBalance
- fetchTicker
- fetchTickers
- fetchTrades
- fetchMyTrades
- fetchDepositsWithdrawals
- fetchDeposits
- fetchWithdrawals
- fetchOrderBooks
- fetchOrderBook
- fetchTradingFee
- fetchTradingFees
- fetchOHLCV
- fetchClosedOrders
- fetchOrder
- fetchOrderTrades
- fetchOpenOrders
- fetchOpenOrder
- cancelAllOrders
- cancelOrder
- createOrder
- fetchMarginModes
- transfer
- withdraw
- fetchFundingRates
- fetchFundingRateHistory
- fetchPositions
- fetchPosition
- fetchOpenInterests
- fetchOpenInterest
- fetchFundingRate
- reduceMargin
- addMargin
- fetchLeverage
- setLeverage
- fetchDepositWithdrawFees
- closePosition
fetchMarkets
retrieves data on all markets for hitbtc
Kind: instance method of 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 |
hitbtc.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of 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 |
hitbtc.fetchCurrencies (params?)createDepositAddress
create a currency deposit address
Kind: instance method of hitbtc
Returns: object - an 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 |
hitbtc.createDepositAddress (code, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of hitbtc
Returns: object - an 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 |
hitbtc.fetchDepositAddress (code, params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.fetchBalance (params?)fetchTicker
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
Returns: object - a 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 |
hitbtc.fetchTicker (symbol, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of hitbtc
Returns: object - a dictionary of ticker structures
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 |
hitbtc.fetchTickers (symbols, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of hitbtc
Returns: Array<Trade> - a list of trade structures
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 |
hitbtc.fetchTrades (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of hitbtc
Returns: Array<Trade> - a list of trade structures
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 |
hitbtc.fetchMyTrades (symbol, since?, limit?, params?)fetchDepositsWithdrawals
fetch history of deposits and withdrawals
Kind: instance method of hitbtc
Returns: object - a list of 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 |
hitbtc.fetchDepositsWithdrawals (code?, since?, limit?, params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of hitbtc
Returns: Array<object> - a list of transaction structures
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 |
hitbtc.fetchDeposits (code, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of hitbtc
Returns: Array<object> - a list of transaction structures
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 |
hitbtc.fetchWithdrawals (code, since?, limit?, params?)fetchOrderBooks
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets
Kind: instance method of hitbtc
Returns: object - a dictionary of order book structures indexed by market symbol
See: https://api.hitbtc.com/#order-books
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | 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 |
hitbtc.fetchOrderBooks (symbols?, limit?, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of hitbtc
Returns: object - A dictionary of order book structures 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 |
hitbtc.fetchOrderBook (symbol, limit?, params?)fetchTradingFee
fetch the trading fees for a market
Kind: instance method of hitbtc
Returns: object - a fee structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
hitbtc.fetchTradingFee (symbol, params?)fetchTradingFees
fetch the trading fees for multiple markets
Kind: instance method of hitbtc
Returns: object - a dictionary of fee structures 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 |
hitbtc.fetchTradingFees (params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
hitbtc.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchClosedOrders
fetches information on multiple closed orders made by the user
Kind: instance method of hitbtc
Returns: Array<Order> - a list of order structures
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 |
hitbtc.fetchClosedOrders (symbol, since?, limit?, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of hitbtc
Returns: object - An 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 |
|---|---|---|---|
| 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 fetching a margin order |
hitbtc.fetchOrder (id, symbol, params?)fetchOrderTrades
fetch all the trades made from a single order
Kind: instance method of hitbtc
Returns: Array<object> - a list of trade structures
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 |
hitbtc.fetchOrderTrades (id, symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of hitbtc
Returns: Array<Order> - a list of order structures
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 |
hitbtc.fetchOpenOrders (symbol, since?, limit?, params?)fetchOpenOrder
fetch an open order by it's id
Kind: instance method of hitbtc
Returns: object - an 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 |
hitbtc.fetchOpenOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of hitbtc
Returns: Array<object> - a list of order structures
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 |
hitbtc.cancelAllOrders (symbol, params?)cancelOrder
cancels an open order
Kind: instance method of hitbtc
Returns: object - An 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 |
hitbtc.cancelOrder (id, symbol, params?)createOrder
create a trade order
Kind: instance method of hitbtc
Returns: object - an 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" |
hitbtc.createOrder (symbol, type, side, amount, price?, params?)fetchMarginModes
fetches margin mode of the user
Kind: instance method of hitbtc
Returns: object - a list of margin mode structures
See
- https://api.hitbtc.com/#get-margin-position-parameters
- https://api.hitbtc.com/#get-futures-position-parameters
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
hitbtc.fetchMarginModes (symbols, params?)transfer
transfer currency internally between wallets on the same account
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.transfer (code, amount, fromAccount, toAccount, params?)withdraw
make a withdrawal
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.withdraw (code, amount, address, tag, params?)fetchFundingRates
fetches funding rates for multiple markets
Kind: instance method of hitbtc
Returns: Array<object> - a list of funding rate structures
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 |
hitbtc.fetchFundingRates (symbols, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of hitbtc
Returns: Array<object> - a list of funding rate structures
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 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 |
hitbtc.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchPositions
fetch all open positions
Kind: instance method of hitbtc
Returns: Array<object> - a list of position structure
See
| 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 |
hitbtc.fetchPositions (symbols, params?)fetchPosition
fetch data on a single open contract trade position
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.fetchPosition (symbol, params?)fetchOpenInterests
Retrieves the open interest for a list of symbols
Kind: instance method of hitbtc
Returns: Array<object> - a list of open interest structures
See: https://api.hitbtc.com/#futures-info
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | a list of unified CCXT market symbols |
| params | object | No | exchange specific parameters |
hitbtc.fetchOpenInterests (symbols?, params?)fetchOpenInterest
Retrieves the open interest of a derivative trading pair
Kind: instance method of hitbtc
Returns: object - an open interest structure/docs/manual#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 |
hitbtc.fetchOpenInterest (symbol, params?)fetchFundingRate
fetch the current funding rate
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.fetchFundingRate (symbol, params?)reduceMargin
remove margin from a position
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.reduceMargin (symbol, amount, params?)addMargin
add margin
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.addMargin (symbol, amount, params?)fetchLeverage
fetch the set leverage for a market
Kind: instance method of hitbtc
Returns: object - a 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 |
hitbtc.fetchLeverage (symbol, params?)setLeverage
set the level of leverage for a market
Kind: instance method of 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 |
hitbtc.setLeverage (leverage, symbol, params?)fetchDepositWithdrawFees
fetch deposit and withdraw fees
Kind: instance method of hitbtc
Returns: Array<object> - a list of fees structures
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 |
hitbtc.fetchDepositWithdrawFees (codes, params?)closePosition
closes open positions for a market
Kind: instance method of hitbtc
Returns: object - An order structure
See: https://api.hitbtc.com/#close-all-futures-margin-positions
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified ccxt market symbol |
| side | string | Yes | 'buy' or 'sell' |
| 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' |
hitbtc.closePosition (symbol, side, params?)