Class WebsocketAPIConnection

Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.

Weight(IP): 5

Security Type: USER_DATA

Cancel an active order.

Weight(IP): 1

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent.

Close out a user data stream.

Weight(IP): 1

Security Type: USER_STREAM

Disconnects from the WebSocket server. If there is no active connection, a warning is logged. Otherwise, all connections in the connection pool are closed gracefully, and a message is logged indicating that the connection has been disconnected.

Futures Account Balance

Weight(IP): 5

Security Type: USER_DATA

Checks if the WebSocket connection is currently open.

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.

Weight(IP): 1

Security Type: USER_STREAM

Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue

Weight: 1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 1 on IP rate limit(x-mbx-used-weight-1m)

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent, and the orderId will prevail if both are sent.
• Both quantity and price must be sent.
• When the new quantity or price doesn't satisfy PRICE_FILTER / PERCENT_FILTER / LOT_SIZE, amendment will be rejected and the order will stay as it is.
• However the order will be cancelled by the amendment in the following situations:
• when the order is in partially filled status and the new quantity <= executedQty
• When the order is GTX and the new price will cause it to be executed immediately
• One order can only be modified for less than 10000 times.

Send in a new order.

Weight(IP): 0

Security Type: TRADE

Notes:

• Additional mandatory parameters based on type: | Type | Additional mandatory parameters | | :---: | --- | | LIMIT | timeInForce, quantity, price | | MARKET | quantity | | STOP/TAKE_PROFIT | quantity, price, stopPrice | | STOP_MARKET/TAKE_PROFIT_MARKET | stopPrice | | TRAILING_STOP_MARKET | callbackRate |
• Order with type STOP, parameter timeInForce can be sent ( default GTC). * Order with type TAKE_PROFIT, parameter timeInForce can be sent ( default GTC). * Condition orders will be triggered when:
• If parameter priceProtect is sent as true:
• when price reaches the stopPrice，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol
• "triggerProtect" of a symbol can be got from GET /dapi/v1/exchangeInfo
• STOP, STOP_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice
• TAKE_PROFIT, TAKE_PROFIT_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <= stopPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
• TRAILING_STOP_MARKET:
• BUY: the lowest price after order placed <= activationPrice, and the latest price >= the lowest price * (1 + callbackRate)
• SELL: the highest price after order placed >= activationPrice, and the latest price <= the highest price * (1 - callbackRate)
• For TRAILING_STOP_MARKET, if you got such error code.
• BUY: activationPrice should be smaller than latest price.
• SELL: activationPrice should be larger than latest price.
• If newOrderRespType is sent as RESULT:
• MARKET order: the final FILLED result of the order will be return directly.
• LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.
• STOP_MARKET, TAKE_PROFIT_MARKET with closePosition=true:
• Follow the same rules for condition orders.
• If triggered，close all current long position(if SELL) or current short position(if BUY).
• Cannot be used with quantity parameter
• Cannot be used with reduceOnly parameter
• In Hedge Mode, cannot be used with BUY orders in LONG position side. and cannot be used with SELL orders in SHORT position side

Sends a ping message to all connected Websocket servers in the pool. If no connections are ready, a warning is logged. For each active connection, the ping message is sent, and debug logs provide details.

Get current position information.

Weight(IP): 5

Security Type: USER_DATA

Notes:

• Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs.

Check an order's status.

These orders will not be found: order status is CANCELED or EXPIRED AND order has NO filled trade AND created time + 3 days < current time order create time + 90 days < current time

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either orderId or origClientOrderId must be sent.

Sends an unsigned message to the WebSocket server

Sends a signed message to the WebSocket server with authentication

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

Weight(IP): 1

Security Type: USER_STREAM