## bingx{docsify-ignore}
**Kind**: global class
**Extends**: Exchange
* [fetchTime](#fetchtime)
* [fetchCurrencies](#fetchcurrencies)
* [fetchMarkets](#fetchmarkets)
* [fetchOHLCV](#fetchohlcv)
* [fetchTrades](#fetchtrades)
* [fetchOrderBook](#fetchorderbook)
* [fetchFundingRate](#fetchfundingrate)
* [fetchFundingRate](#fetchfundingrate)
* [fetchFundingRateHistory](#fetchfundingratehistory)
* [fetchOpenInterest](#fetchopeninterest)
* [fetchTicker](#fetchticker)
* [fetchTickers](#fetchtickers)
* [fetchBalance](#fetchbalance)
* [fetchPositions](#fetchpositions)
* [fetchPosition](#fetchposition)
* [createMarketOrderWithCost](#createmarketorderwithcost)
* [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost)
* [createMarketSellOrderWithCost](#createmarketsellorderwithcost)
* [createOrder](#createorder)
* [createOrders](#createorders)
* [cancelOrder](#cancelorder)
* [cancelAllOrders](#cancelallorders)
* [cancelOrders](#cancelorders)
* [cancelAllOrdersAfter](#cancelallordersafter)
* [fetchOrder](#fetchorder)
* [fetchOrders](#fetchorders)
* [fetchOpenOrders](#fetchopenorders)
* [fetchClosedOrders](#fetchclosedorders)
* [fetchCanceledOrders](#fetchcanceledorders)
* [fetchCanceledAndClosedOrders](#fetchcanceledandclosedorders)
* [transfer](#transfer)
* [fetchTransfers](#fetchtransfers)
* [fetchDepositAddressesByNetwork](#fetchdepositaddressesbynetwork)
* [fetchDepositAddress](#fetchdepositaddress)
* [fetchDeposits](#fetchdeposits)
* [fetchWithdrawals](#fetchwithdrawals)
* [setMarginMode](#setmarginmode)
* [setMargin](#setmargin)
* [fetchLeverage](#fetchleverage)
* [setLeverage](#setleverage)
* [fetchMyTrades](#fetchmytrades)
* [fetchDepositWithdrawFees](#fetchdepositwithdrawfees)
* [withdraw](#withdraw)
* [fetchMyLiquidations](#fetchmyliquidations)
* [closePosition](#closeposition)
* [fetchPositionMode](#fetchpositionmode)
* [setPositionMode](#setpositionmode)
* [editOrder](#editorder)
* [fetchMarginMode](#fetchmarginmode)
* [fetchTradingFee](#fetchtradingfee)
* [watchTicker](#watchticker)
* [watchTickers](#watchtickers)
* [watchOrderBookForSymbols](#watchorderbookforsymbols)
* [watchOHLCVForSymbols](#watchohlcvforsymbols)
* [watchTrades](#watchtrades)
* [watchOrderBook](#watchorderbook)
* [watchOHLCV](#watchohlcv)
* [watchOrders](#watchorders)
* [watchMyTrades](#watchmytrades)
* [watchBalance](#watchbalance)
### fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the bingx server
**Kind**: instance method of [bingx
](#bingx)
**Returns**: int
- the current integer timestamp in milliseconds from the bingx server
**See**: https://bingx-api.github.io/docs/#/swapV2/base-info.html#Get%20Server%20Time
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchTime ([params])
```
### fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an associative dictionary of currencies
**See**: https://bingx-api.github.io/docs/#/common/account-api.html#All%20Coins
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchCurrencies ([params])
```
### fetchMarkets{docsify-ignore}
retrieves data on all markets for bingx
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- an array of objects representing market data
**See**
- https://bingx-api.github.io/docs/#/spot/market-api.html#Query%20Symbols
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#Contract%20Information
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Contract%20Information
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchMarkets ([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 [bingx
](#bingx)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#K-Line%20Data
- https://bingx-api.github.io/docs/#/spot/market-api.html#Candlestick%20chart%20data
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#%20K-Line%20Data
- https://bingx-api.github.io/docs/#/en-us/swapV2/market-api.html#K-Line%20Data%20-%20Mark%20Price
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Get%20K-line%20Data
| 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 candle to fetch |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [available parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
```javascript
bingx.fetchOHLCV (symbol, timeframe[, since, limit, params])
```
### fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
**See**
- https://bingx-api.github.io/docs/#/spot/market-api.html#Query%20transaction%20records
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#The%20latest%20Trade%20of%20a%20Trading%20Pair
| 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
bingx.fetchTrades (symbol[, since, 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 [bingx
](#bingx)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
**See**
- https://bingx-api.github.io/docs/#/spot/market-api.html#Query%20depth%20information
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#Get%20Market%20Depth
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Query%20Depth%20Data
| 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
bingx.fetchOrderBook (symbol[, limit, params])
```
### fetchFundingRate{docsify-ignore}
fetch the current funding rate
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure)
**See**
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#Current%20Funding%20Rate
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Price%20&%20Current%20Funding%20Rate
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchFundingRate (symbol[, params])
```
### fetchFundingRate{docsify-ignore}
fetch the current funding rate
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure)
**See**: https://bingx-api.github.io/docs/#/swapV2/market-api.html#Current%20Funding%20Rate
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
| No | list of unified market symbols |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchFundingRate ([symbols, params])
```
### fetchFundingRateHistory{docsify-ignore}
fetches historical funding rate prices
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure)
**See**: https://bingx-api.github.io/docs/#/swapV2/market-api.html#Funding%20Rate%20History
| 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 to fetch |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
```javascript
bingx.fetchFundingRateHistory (symbol[, since, limit, params])
```
### fetchOpenInterest{docsify-ignore}
retrieves the open interest of a trading pair
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an open interest structure[https://docs.ccxt.com/#/?id=open-interest-structure](https://docs.ccxt.com/#/?id=open-interest-structure)
**See**
- https://bingx-api.github.io/docs/#/swapV2/market-api.html#Get%20Swap%20Open%20Positions
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Get%20Swap%20Open%20Positions
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified CCXT market symbol |
| params | object
| No | exchange specific parameters |
```javascript
bingx.fetchOpenInterest (symbol[, 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 [bingx
](#bingx)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/market-api.html#Get%20Ticker
- https://bingx-api.github.io/docs/#/en-us/spot/market-api.html#24-hour%20price%20changes
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Query%2024-Hour%20Price%20Change
| 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
bingx.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 [bingx
](#bingx)
**Returns**: object
- a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/market-api.html#Get%20Ticker
- https://bingx-api.github.io/docs/#/en-us/spot/market-api.html#24-hour%20price%20changes
- https://bingx-api.github.io/docs/#/en-us/cswap/market-api.html#Query%2024-Hour%20Price%20Change
| 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
bingx.fetchTickers (symbols[, 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 [bingx
](#bingx)
**Returns**: object
- a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
**See**
- https://bingx-api.github.io/docs/#/spot/trade-api.html#Query%20Assets
- https://bingx-api.github.io/docs/#/swapV2/account-api.html#Get%20Perpetual%20Swap%20Account%20Asset%20Information
- https://bingx-api.github.io/docs/#/standard/contract-interface.html#Query%20standard%20contract%20balance
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Account%20Assets
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.standard | boolean
| No | whether to fetch standard contract balances |
```javascript
bingx.fetchBalance ([params])
```
### fetchPositions{docsify-ignore}
fetch all open positions
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [position structures](https://docs.ccxt.com/#/?id=position-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/account-api.html#Query%20position%20data
- https://bingx-api.github.io/docs/#/en-us/standard/contract-interface.html#position
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20warehouse
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
, undefined
| Yes | list of unified market symbols |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.standard | boolean
| No | whether to fetch standard contract positions |
```javascript
bingx.fetchPositions (symbols[, params])
```
### fetchPosition{docsify-ignore}
fetch data on a single open contract trade position
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [position structure](https://docs.ccxt.com/#/?id=position-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/account-api.html#Query%20position%20data
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20warehouse
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market the position is held in |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchPosition (symbol[, params])
```
### createMarketOrderWithCost{docsify-ignore}
create a market order by providing the symbol, side and cost
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| side | string
| Yes | 'buy' or 'sell' |
| cost | float
| Yes | how much you want to trade in units of the quote currency |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.createMarketOrderWithCost (symbol, side, cost[, params])
```
### createMarketBuyOrderWithCost{docsify-ignore}
create a market buy order by providing the symbol and cost
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| cost | float
| Yes | how much you want to trade in units of the quote currency |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.createMarketBuyOrderWithCost (symbol, cost[, params])
```
### createMarketSellOrderWithCost{docsify-ignore}
create a market sell order by providing the symbol and cost
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| cost | float
| Yes | how much you want to trade in units of the quote currency |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.createMarketSellOrderWithCost (symbol, cost[, params])
```
### createOrder{docsify-ignore}
create a trade order
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Trade%20order
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Create%20an%20Order
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Trade%20order
| 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 you want to trade in units of the base currency |
| price | float
| No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string
| No | a unique id for the order |
| params.postOnly | bool
| No | true to place a post only order |
| params.timeInForce | string
| No | spot supports 'PO', 'GTC' and 'IOC', swap supports 'PO', 'GTC', 'IOC' and 'FOK' |
| params.reduceOnly | bool
| No | *swap only* true or false whether the order is reduce only |
| params.triggerPrice | float
| No | triggerPrice at which the attached take profit / stop loss order will be triggered |
| params.stopLossPrice | float
| No | stop loss trigger price |
| params.takeProfitPrice | float
| No | take profit trigger price |
| params.cost | float
| No | the quote quantity that can be used as an alternative for the amount |
| params.trailingAmount | float
| No | *swap only* the quote amount to trail away from the current market price |
| params.trailingPercent | float
| No | *swap only* the percent to trail away from the current market price |
| params.takeProfit | object
| No | *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered |
| params.takeProfit.triggerPrice | float
| No | take profit trigger price |
| params.stopLoss | object
| No | *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered |
| params.stopLoss.triggerPrice | float
| No | stop loss trigger price |
| params.test | boolean
| No | *swap only* whether to use the test endpoint or not, default is false |
| params.hedged | boolean
| No | *swap only* whether the order is in hedged mode or one way mode |
```javascript
bingx.createOrder (symbol, type, side, amount[, price, params])
```
### createOrders{docsify-ignore}
create a list of trade orders
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/spot/trade-api.html#Batch%20Placing%20Orders
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Bulk%20order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| orders | Array
| Yes | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.createOrders (orders[, params])
```
### cancelOrder{docsify-ignore}
cancels an open order
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Cancel%20Order
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Cancel%20Order
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Cancel%20an%20Order
| 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.clientOrderId | string
| No | a unique id for the order |
```javascript
bingx.cancelOrder (id, symbol[, params])
```
### cancelAllOrders{docsify-ignore}
cancel all open orders
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Cancel%20orders%20by%20symbol
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Cancel%20All%20Orders
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Cancel%20all%20orders
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.cancelAllOrders ([symbol, params])
```
### cancelOrders{docsify-ignore}
cancel multiple orders
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Cancel%20a%20Batch%20of%20Orders
- https://bingx-api.github.io/docs/#/spot/trade-api.html#Cancel%20a%20Batch%20of%20Orders
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| ids | Array<string>
| Yes | order ids |
| symbol | string
| Yes | unified market symbol, default is undefined |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.clientOrderIds | Array<string>
| No | client order ids |
```javascript
bingx.cancelOrders (ids, symbol[, params])
```
### cancelAllOrdersAfter{docsify-ignore}
dead man's switch, cancel all orders after the given timeout
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- the api result
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Cancel%20all%20orders%20in%20countdown
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Cancel%20all%20orders%20in%20countdown
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| timeout | number
| Yes | time in milliseconds, 0 represents cancel the timer |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.type | string
| No | spot or swap market |
```javascript
bingx.cancelAllOrdersAfter (timeout[, params])
```
### fetchOrder{docsify-ignore}
fetches information on an order made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20Order%20details
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20Order%20details
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | the 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 |
```javascript
bingx.fetchOrder (id, symbol[, params])
```
### fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#User's%20All%20Orders
| 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.until | int
| No | the latest time in ms to fetch entries for |
| params.orderId | int
| No | Only return subsequent orders, and return the latest order by default |
```javascript
bingx.fetchOrders (symbol[, since, limit, params])
```
### fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Current%20Open%20Orders
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Current%20All%20Open%20Orders
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20all%20current%20pending%20orders
| 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 order structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchOpenOrders (symbol[, since, limit, params])
```
### fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#User's%20History%20Orders
- https://bingx-api.github.io/docs/#/standard/contract-interface.html#Historical%20order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the closed orders |
| since | int
| No | timestamp in ms of the earliest order |
| limit | int
| No | the max number of closed orders to return |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch orders for |
| params.standard | boolean
| No | whether to fetch standard contract orders |
```javascript
bingx.fetchClosedOrders (symbol[, since, limit, params])
```
### fetchCanceledOrders{docsify-ignore}
fetches information on multiple canceled orders made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#User's%20History%20Orders
- https://bingx-api.github.io/docs/#/standard/contract-interface.html#Historical%20order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the canceled orders |
| since | int
| No | timestamp in ms of the earliest order |
| limit | int
| No | the max number of canceled orders to return |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch orders for |
| params.standard | boolean
| No | whether to fetch standard contract orders |
```javascript
bingx.fetchCanceledOrders (symbol[, since, limit, params])
```
### fetchCanceledAndClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20Order%20history
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#User's%20History%20Orders
- https://bingx-api.github.io/docs/#/standard/contract-interface.html#Historical%20order
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | 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.until | int
| No | the latest time in ms to fetch orders for |
| params.standard | boolean
| No | whether to fetch standard contract orders |
```javascript
bingx.fetchCanceledAndClosedOrders ([symbol, since, limit, params])
```
### transfer{docsify-ignore}
transfer currency internally between wallets on the same account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure)
**See**: https://bingx-api.github.io/docs/#/spot/account-api.html#User%20Universal%20Transfer
| 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
bingx.transfer (code, amount, fromAccount, toAccount[, params])
```
### fetchTransfers{docsify-ignore}
fetch a history of internal transfers made on an account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [transfer structures](https://docs.ccxt.com/#/?id=transfer-structure)
**See**: https://bingx-api.github.io/docs/#/spot/account-api.html#Query%20User%20Universal%20Transfer%20History%20(USER_DATA)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| No | unified currency code of the currency transferred |
| since | int
| No | the earliest time in ms to fetch transfers for |
| limit | int
| No | the maximum number of transfers structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchTransfers ([code, since, limit, params])
```
### fetchDepositAddressesByNetwork{docsify-ignore}
fetch the deposit addresses for a currency associated with this account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a dictionary [address structures](https://docs.ccxt.com/#/?id=address-structure), indexed by the network
**See**: https://bingx-api.github.io/docs/#/en-us/common/wallet-api.html#Query%20Main%20Account%20Deposit%20Address
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchDepositAddressesByNetwork (code[, params])
```
### fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [address structure](https://docs.ccxt.com/#/?id=address-structure)
**See**: https://bingx-api.github.io/docs/#/en-us/common/wallet-api.html#Query%20Main%20Account%20Deposit%20Address
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.network | string
| No | The chain of currency. This only apply for multi-chain currency, and there is no need for single chain currency |
```javascript
bingx.fetchDepositAddress (code[, params])
```
### fetchDeposits{docsify-ignore}
fetch all deposits made to an account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://bingx-api.github.io/docs/#/spot/account-api.html#Deposit%20History(supporting%20network)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| No | 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
bingx.fetchDeposits ([code, since, limit, params])
```
### fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://bingx-api.github.io/docs/#/spot/account-api.html#Withdraw%20History%20(supporting%20network)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| No | 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
bingx.fetchWithdrawals ([code, since, limit, params])
```
### setMarginMode{docsify-ignore}
set margin mode to 'cross' or 'isolated'
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- response from the exchange
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Change%20Margin%20Type
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Set%20Margin%20Type
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| marginMode | string
| Yes | 'cross' or 'isolated' |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.setMarginMode (marginMode, symbol[, params])
```
### setMargin{docsify-ignore}
Either adds or reduces margin in an isolated position in order to set the margin to a specific value
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- A [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure)
**See**: https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Adjust%20isolated%20margin
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market to set margin in |
| amount | float
| Yes | the amount to set the margin to |
| params | object
| No | parameters specific to the bingx api endpoint |
```javascript
bingx.setMargin (symbol, amount[, params])
```
### fetchLeverage{docsify-ignore}
fetch the set leverage for a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure)
**See**
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Query%20Leverage
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Leverage
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchLeverage (symbol[, params])
```
### setLeverage{docsify-ignore}
set the level of leverage for a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- response from the exchange
**See**
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#Switch%20Leverage
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Modify%20Leverage
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| leverage | float
| Yes | the rate of leverage |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.side | string
| No | hedged: ['long' or 'short']. one way: ['both'] |
```javascript
bingx.setLeverage (leverage, symbol[, params])
```
### fetchMyTrades{docsify-ignore}
fetch all trades made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20transaction%20details
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20historical%20transaction%20orders
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Order%20Trade%20Detail
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | unified market symbol |
| since | int
| No | the earliest time in ms to fetch trades for |
| limit | int
| No | the maximum number of trades structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | timestamp in ms for the ending date filter, default is undefined |
| params.trandingUnit | string
| Yes | COIN (directly represent assets such as BTC and ETH) or CONT (represents the number of contract sheets) |
| params.orderId | string
| Yes | the order id required for inverse swap |
```javascript
bingx.fetchMyTrades ([symbol, since, limit, params])
```
### fetchDepositWithdrawFees{docsify-ignore}
fetch deposit and withdraw fees
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure)
**See**: https://bingx-api.github.io/docs/#/common/account-api.html#All%20Coins'%20Information
| 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
bingx.fetchDepositWithdrawFees (codes[, params])
```
### withdraw{docsify-ignore}
make a withdrawal
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://bingx-api.github.io/docs/#/common/account-api.html#Withdraw
| 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
| No | |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.walletType | int
| No | 1 fund account, 2 standard account, 3 perpetual account |
```javascript
bingx.withdraw (code, amount, address[, tag, params])
```
### fetchMyLiquidations{docsify-ignore}
retrieves the users liquidated positions
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an array of [liquidation structures](https://docs.ccxt.com/#/?id=liquidation-structure)
**See**
- https://bingx-api.github.io/docs/#/swapV2/trade-api.html#User's%20Force%20Orders
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20force%20orders
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | unified CCXT market symbol |
| since | int
| No | the earliest time in ms to fetch liquidations for |
| limit | int
| No | the maximum number of liquidation structures to retrieve |
| params | object
| No | exchange specific parameters for the bingx api endpoint |
| params.until | int
| No | timestamp in ms of the latest liquidation |
```javascript
bingx.fetchMyLiquidations ([symbol, since, limit, params])
```
### closePosition{docsify-ignore}
closes open positions for a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#One-Click%20Close%20All%20Positions
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Close%20all%20positions%20in%20bulk
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | Unified CCXT market symbol |
| side | string
| No | not used by bingx |
| params | object
| No | extra parameters specific to the bingx api endpoint |
| params.positionId | string
, undefined
| No | the id of the position you would like to close |
```javascript
bingx.closePosition (symbol[, side, params])
```
### fetchPositionMode{docsify-ignore}
fetchs the position mode, hedged or one way, hedged for binance is set identically for all linear markets or all inverse markets
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an object detailing whether the market is in hedged or one-way mode
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Get%20Position%20Mode
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the order book for |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchPositionMode (symbol[, params])
```
### setPositionMode{docsify-ignore}
set hedged to true or false for a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- response from the exchange
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Set%20Position%20Mode
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| hedged | bool
| Yes | set to true to use dualSidePosition |
| symbol | string
| Yes | not used by bingx setPositionMode () |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.setPositionMode (hedged, symbol[, params])
```
### editOrder{docsify-ignore}
cancels an order and places a new order
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Cancel%20order%20and%20place%20a%20new%20order // spot
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Cancel%20an%20order%20and%20then%20Place%20a%20new%20order // swap
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | order id |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' |
| side | string
| Yes | 'buy' or 'sell' |
| amount | float
| Yes | how much of the currency you want to trade in units of the base currency |
| price | float
| No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.stopPrice | string
| No | Trigger price used for TAKE_STOP_LIMIT, TAKE_STOP_MARKET, TRIGGER_LIMIT, TRIGGER_MARKET order types. |
| params.takeProfit | object
| No | *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered |
| params.takeProfit.triggerPrice | float
| No | take profit trigger price |
| params.stopLoss | object
| No | *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered |
| params.stopLoss.triggerPrice | float
| No | stop loss trigger price EXCHANGE SPECIFIC PARAMETERS |
| params.cancelClientOrderID | string
| No | the user-defined id of the order to be canceled, 1-40 characters, different orders cannot use the same clientOrderID, only supports a query range of 2 hours |
| params.cancelRestrictions | string
| No | cancel orders with specified status, NEW: New order, PENDING: Pending order, PARTIALLY_FILLED: Partially filled |
| params.cancelReplaceMode | string
| No | STOP_ON_FAILURE - if the cancel order fails, it will not continue to place a new order, ALLOW_FAILURE - regardless of whether the cancel order succeeds or fails, it will continue to place a new order |
| params.quoteOrderQty | float
| No | order amount |
| params.newClientOrderId | string
| No | custom order id consisting of letters, numbers, and _, 1-40 characters, different orders cannot use the same newClientOrderId. |
| params.positionSide | string
| No | *contract only* position direction, required for single position as BOTH, for both long and short positions only LONG or SHORT can be chosen, defaults to LONG if empty |
| params.reduceOnly | string
| No | *contract only* true or false, default=false for single position mode. this parameter is not accepted for both long and short positions mode |
| params.priceRate | float
| No | *contract only* for type TRAILING_STOP_Market or TRAILING_TP_SL, Max = 1 |
| params.workingType | string
| No | *contract only* StopPrice trigger price types, MARK_PRICE (default), CONTRACT_PRICE, or INDEX_PRICE |
```javascript
bingx.editOrder (id, symbol, type, side, amount[, price, params])
```
### fetchMarginMode{docsify-ignore}
fetches the margin mode of the trading pair
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [margin mode structure](https://docs.ccxt.com/#/?id=margin-mode-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/swapV2/trade-api.html#Query%20Margin%20Type
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Margin%20Type
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the margin mode for |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchMarginMode (symbol[, params])
```
### fetchTradingFee{docsify-ignore}
fetch the trading fees for a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [fee structure](https://docs.ccxt.com/#/?id=fee-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/trade-api.html#Query%20Trading%20Commission%20Rate
- https://bingx-api.github.io/docs/#/en-us/swapV2/account-api.html#Query%20Trading%20Commission%20Rate
- https://bingx-api.github.io/docs/#/en-us/cswap/trade-api.html#Query%20Trade%20Commission%20Rate
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.fetchTradingFee (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 [bingx
](#bingx)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/market.html#Subscribe%20to%2024-hour%20Price%20Change
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20to%2024-hour%20price%20changes
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/market.html#Subscribe%20to%2024-Hour%20Price%20Change
| 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
bingx.watchTicker (symbol[, params])
```
### watchTickers{docsify-ignore}
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20to%2024-hour%20price%20changes%20of%20all%20trading%20pairs
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
| Yes | unified symbol of the market to watch the tickers for |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchTickers (symbols[, params])
```
### watchOrderBookForSymbols{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20Market%20Depth%20Data%20of%20all%20trading%20pairs
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
| Yes | unified array of symbols |
| limit | int
| No | the maximum amount of order book entries to return |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchOrderBookForSymbols (symbols[, limit, params])
```
### watchOHLCVForSymbols{docsify-ignore}
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**: https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20K-Line%20Data%20of%20all%20trading%20pairs
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbolsAndTimeframes | Array<Array<string>>
| Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] |
| since | int
| No | timestamp in ms of the earliest candle to fetch |
| limit | int
| No | the maximum amount of candles to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchOHLCVForSymbols (symbolsAndTimeframes[, since, limit, params])
```
### watchTrades{docsify-ignore}
watches information on multiple trades made in a market
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/spot/socket/market.html#Subscribe%20to%20tick-by-tick
- https://bingx-api.github.io/docs/#/swapV2/socket/market.html#Subscribe%20the%20Latest%20Trade%20Detail
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/market.html#Subscription%20transaction%20by%20transaction
| 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 |
```javascript
bingx.watchTrades (symbol[, since, limit, params])
```
### watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/market.html#Subscribe%20Market%20Depth%20Data
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20Market%20Depth%20Data
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/market.html#Subscribe%20to%20Limited%20Depth
| 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
bingx.watchOrderBook (symbol[, 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 [bingx
](#bingx)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/market.html#K-line%20Streams
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/market.html#Subscribe%20K-Line%20Data
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/market.html#Subscribe%20to%20Latest%20Trading%20Pair%20K-Line
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string
| Yes | the length of time each candle represents |
| since | int
| No | timestamp in ms of the earliest candle to fetch |
| limit | int
| No | the maximum amount of candles to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchOHLCV (symbol, timeframe[, since, limit, params])
```
### watchOrders{docsify-ignore}
watches information on multiple orders made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/account.html#Subscription%20order%20update%20data
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/account.html#Order%20update%20push
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/account.html#Order%20update%20push
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | unified market symbol of the market orders are made in |
| since | int
| No | the earliest time in ms to watch orders for |
| limit | int
| No | the maximum number of order structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchOrders ([symbol, since, limit, params])
```
### watchMyTrades{docsify-ignore}
watches information on multiple trades made by the user
**Kind**: instance method of [bingx
](#bingx)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/account.html#Subscription%20order%20update%20data
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/account.html#Order%20update%20push
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/account.html#Order%20update%20push
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| No | unified market symbol of the market the trades are made in |
| since | int
| No | the earliest time in ms to watch trades for |
| limit | int
| No | the maximum number of trade structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchMyTrades ([symbol, since, limit, params])
```
### watchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
**Kind**: instance method of [bingx
](#bingx)
**Returns**: object
- a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
**See**
- https://bingx-api.github.io/docs/#/en-us/spot/socket/account.html#Subscription%20account%20balance%20push
- https://bingx-api.github.io/docs/#/en-us/swapV2/socket/account.html#Account%20balance%20and%20position%20update%20push
- https://bingx-api.github.io/docs/#/en-us/cswap/socket/account.html#Account%20balance%20and%20position%20update%20push
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bingx.watchBalance ([params])
```