Interface TradeApiInterface

Get trades for a specific account and symbol.

Weight(IP): 5

Security Type: USER_DATA

Notes:

• If startTime and endTime are both not sent, then the last 7 days' data will be returned.
• The time between startTime and endTime cannot be longer than 7 days.
• The parameter fromId cannot be sent with startTime or endTime.
• Only support querying trade in the past 6 months

Get all account orders; active, canceled, or filled.

• 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): 5

Security Type: USER_DATA

Notes:

• If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.
• The query time period must be less then 7 days( default as the recent 7 days).

Cancel all open orders of the specified symbol at the end of the specified countdown.

The endpoint should be called repeatedly as heartbeats so that the existing countdown time can be canceled and replaced by a new one.

Example usage:

Call this endpoint at 30s intervals with an countdownTime of 120000 (120s). If this endpoint is not called within 120 seconds, all your orders of the specified symbol will be automatically canceled. If this endpoint is called with an countdownTime of 0, the countdown timer will be stopped.

The system will check all countdowns approximately every 10 milliseconds, so please note that sufficient redundancy should be considered when using this function. We do not recommend setting the countdown time to be too precise or too small.

Weight(IP): 10

Security Type: TRADE

Cancel an active algo (conditional) order, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

Weight(IP): 1

Security Type: TRADE

Notes:

• Either algoId or clientAlgoId must be sent.

Cancel all open algo (conditional) orders on a symbol, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

Weight(IP): 1

Security Type: TRADE

Cancel All Open Orders

Weight(IP): 1

Security Type: TRADE

Cancel Multiple Orders

Weight(IP): 1

Security Type: TRADE

Notes:

• Either orderIdList or origClientOrderIdList must be sent.

Cancel an active order.

Weight(IP): 1

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent.

Change user's initial leverage of specific symbol market.

Weight(IP): 1

Security Type: TRADE

Change symbol level margin type

Weight(IP): 1

Security Type: TRADE

Change user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol

Weight(IP): 1

Security Type: TRADE

Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol.

After CM migration*, UM and CM share the same dualSidePosition setting. Calling this endpoint flips both UM and CM at once. If either side has any open order or open position, the change is rejected:

• -4067 (open orders exist)
• -4068 (open position exists)

Weight(IP): 1

Security Type: TRADE

Get all open algo (conditional) orders on a symbol, including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

Weight: 1 for a single symbol; 40 when the symbol parameter is omitted

Careful* when accessing this with no symbol.

Security Type: USER_DATA

Notes:

• If the symbol is not sent, orders for all symbols will be returned in an array.

Get all open orders on a symbol.

Weight: 1 for a single symbol; 40 when the symbol parameter is omitted

Careful* when accessing this with no symbol.

Security Type: USER_DATA

Notes:

• If the symbol is not sent, orders for all symbols will be returned in an array.

Sign TradFi-Perps agreement contract

Weight(IP): 50

Security Type: USER_DATA

Get order modification history

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either orderId or origClientOrderId must be sent, and the orderId will prevail if both are sent.

• Order modify history longer than 3 month is not avaliable

Get Position Margin Change History

Weight(IP): 1

Security Type: TRADE

Notes:

• Support querying future histories that are not older than 30 days
• The time between startTime and endTimecan't be more than 30 days

Modify Isolated Position Margin

Weight(IP): 1

Security Type: TRADE

Notes:

• Only for isolated symbol

Modify Multiple Orders (TRADE)

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

Security Type: TRADE

Notes:

• Parameter rules are same with Modify Order
• Batch modify orders are processed concurrently, and the order of matching is not guaranteed.
• The order of returned contents for batch modify orders is the same as the order of the order list.
• One order can only be modfied for less than 10000 times

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); 0 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, which is different from dapi modify order endpoint.
• 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 modfied for less than 10000 times

Send in a new algo (conditional) order. Use this endpoint to place TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures. Supported order types under algoType=CONDITIONAL are STOP_MARKET, TAKE_PROFIT_MARKET, STOP, TAKE_PROFIT, and TRAILING_STOP_MARKET.

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

Security Type: TRADE

Notes:

• Algo order with type STOP, parameter timeInForce can be sent (default GTC).
• Algo order with type TAKE_PROFIT, parameter timeInForce can be sent ( default GTC).
• Condition orders will be triggered when:
• If parameterpriceProtectis sent as true:
• when price reaches the triggerPrice ，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 /fapi/v1/exchangeInfo
• STOP, STOP_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= triggerPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
• TAKE_PROFIT, TAKE_PROFIT_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= triggerPrice
• TRAILING_STOP_MARKET:
• BUY: the lowest price after order placed = the lowest price * (1 + callbackRate)
• SELL: the highest price after order placed >= activatePrice, and the latest price
• For TRAILING_STOP_MARKET, if you got such error code. > {"code": -2021, "msg": "Order would immediately trigger."} > means that the parameters you send do not meet the following requirements:
• BUY: activatePrice should be smaller than latest price.
• SELL: activatePrice should be larger than latest price.
• 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 paremeter
• 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
• selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.

Send in a new order.

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

Security Type: TRADE

Notes: Additional mandatory parameters based on type:

• If newOrderRespType is sent as RESULT:
• MARKET order: the final FILLED result of the order will be returned directly.
• LIMIT order with special timeInForce: the final status result of the order (FILLED or EXPIRED) will be returned directly.
• selfTradePreventionMode is only effective when timeInForce is set to IOC, GTC, or GTD.
• In extreme market conditions, timeInForce GTD order auto-cancel time might be delayed compared to goodTillDate.

Place Multiple Orders

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

Security Type: TRADE

Notes:

• Paremeter rules are same with New Order
• Batch orders are processed concurrently, and the order of matching is not guaranteed.
• The order of returned contents for batch orders is the same as the order of the order list.

Position ADL Quantile Estimation

Values update every 30s. Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high. For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides. If the positions of the symbol are crossed margined in Hedge Mode: "HEDGE" as a sign will be returned instead of "BOTH"; A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides.

Weight(IP): 5

Security Type: USER_DATA

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.

Get current position information(only symbol that has position or open orders will be returned).

Weight(IP): 5

Security Type: USER_DATA

Notes:

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

Check the status of an algo (conditional) order, such as TP/SL (Take Profit / Stop Loss) or trailing stop orders on USD-M Futures.

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 algoId or clientAlgoId must be sent.
• algoId is self-increment for each specific symbol

Get all algo (conditional) orders — active, CANCELED, TRIGGERED, or FINISHED — including TP/SL (Take Profit / Stop Loss) and trailing stop orders on USD-M Futures.

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): 5

Security Type: USER_DATA

Notes:

• If algoId is set, it will get orders >= that algoId. Otherwise most recent orders are returned.
• The query time period must be less then 7 days( default as the recent 7 days).

Query open order

Weight(IP): 1

Security Type: USER_DATA

Notes:

• EitherorderId or origClientOrderId must be sent
• If the queried order has been filled or cancelled, the error message "Order does not exist" will be returned.

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.
• orderId is self-increment for each specific symbol

Testing order request, this order will not be submitted to matching engine

Security Type: TRADE

Notes: Additional mandatory parameters based on type:

• 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 parameterpriceProtectis 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 /fapi/v1/exchangeInfo
• STOP, STOP_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
• TAKE_PROFIT, TAKE_PROFIT_MARKET:
• BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE")
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >= stopPrice
• TRAILING_STOP_MARKET:
• BUY: the lowest price after order placed ``= the lowest price * (1 + callbackRate)
• SELL: the highest price after order placed >= activationPrice, and the latest price
• For TRAILING_STOP_MARKET, if you got such error code. > {"code": -2021, "msg": "Order would immediately trigger."} > means that the parameters you send do not meet the following requirements:
• 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 paremeter
• 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
• selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.
• In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

Query user's Force Orders

Weight: 20 with symbol, 50 without symbol

Security Type: USER_DATA

Notes:

• If "autoCloseType" is not sent, orders with both of the types will be returned
• If "startTime" is not sent, data within 7 days before "endTime" can be queried