Class TradeApi

Cancel All CM Open Conditional Orders

Weight(IP): 1

Security Type: TRADE

Cancel all active LIMIT orders on specific symbol

Weight(IP): 1

Security Type: TRADE

Cancel All UM Algo Open Orders

Weight(IP): 1

Security Type: TRADE

Cancel All UM Open Conditional Orders

Weight(IP): 1

Security Type: TRADE

Cancel all active LIMIT orders on specific symbol

Weight(IP): 1

Security Type: TRADE

Cancel CM Conditional Order

Weight(IP): 1

Security Type: TRADE

Notes:

• Either strategyId or newClientStrategyId must be sent.

Cancel an active LIMIT order

Weight(IP): 1

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent.

Cancel Margin Account All Open Orders on a Symbol

Weight(IP): 5

Security Type: TRADE

Cancel Margin Account OCO Orders

Weight(IP): 2

Security Type: TRADE

Notes:

• Additional notes: Canceling an individual leg will cancel the entire OCO

Cancel Margin Account Order

Weight(IP): 2

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent.

Cancel an active UM algo order

Weight(IP): 1

Security Type: TRADE

Notes:

• Either algoId or clientAlgoId must be sent.

Cancel UM Conditional Order

Weight(IP): 1

Security Type: TRADE

Notes:

• Either strategyId or newClientStrategyId must be sent.

Cancel an active UM LIMIT order

Weight(IP): 1

Security Type: TRADE

Notes:

• Either orderId or origClientOrderId must be sent.

Get trades for a specific account and CM symbol.

Weight: - 20 with symbol

• 40 with pair

Security Type: USER_DATA

Notes:

• Either symbol or pair must be sent
• symbol and pair cannot be sent together
• pair and fromId cannot be sent together
• OrderId can only be sent together with symbol
• If a pair is sent, tickers for all symbols of the pair will be returned
• The parameter fromId cannot be sent with startTime or endTime
• If startTime and endTime are both not sent, then the last '24 hours' data will be returned.
• The time between startTime and endTime cannot be longer than 24 hours.

Query CM 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

Sign TradFi-Perps agreement contract

Weight(IP): 5

Security Type: USER_DATA

Get user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off )

Weight(IP): 30

Security Type: USER_DATA

Apply for a margin loan.

Weight(IP): 100

Security Type: MARGIN

Send in a new OCO for a margin account

Weight(IP): 1

Security Type: TRADE

Notes:

• Other Info:
• Price Restrictions:
• SELL: Limit Price > Last Price > Stop Price
• BUY: Limit Price * Quantity Restrictions:
• Both legs must have the same quantity
• ICEBERG quantities however do not have to be the same.
• Order Rate Limit
• OCO counts as 2 orders against the order rate limit.

Repay for a margin loan.

Weight(IP): 100

Security Type: MARGIN

Repay debt for a margin loan.

Weight(IP): 3000

Security Type: TRADE

Notes:

• The repay asset amount cannot exceed 50000 USD equivalent value for a single request.
• If amount is not sent, all the asset loan will be repaid if having enough specific repay assets.
• If amount is sent, only the certain amount of the asset loan will be repaid if having enough specific repay assets.
• The system will use the same asset to repay the loan first (if have) no matter whether put the asset in specifyRepayAssets

Margin Account Trade List

Weight(IP): 5

Security Type: USER_DATA

Notes:

• Note: * If fromId is set, returns orders with id >= fromId; otherwise returns recent order history.
• The interval between startTime and endTime must be less than 24 hours.

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

Weight(IP): 1

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 * When the order is GTX and the new price will cause it to be executed immediately

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

Weight(IP): 1

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 * When the order is GTX and the new price will cause it to be executed immediately

New CM Conditional Order

Weight(IP): 1

Security Type: TRADE

Notes:

• Additional mandatory parameters based on type:
• Order with type STOP/TAKE_PROFIT, parameter timeInForce can be sent ( default GTC).
• Condition orders will be triggered when:
• STOP, STOP_MARKET:
• BUY: "MARK_PRICE" >= stopPrice
• SELL: "MARK_PRICE" = stopPrice
• TRAILING_STOP_MARKET:
• BUY: the lowest mark price after order placed ``= the lowest mark price
• (1 + callbackRate)
• SELL: the highest mark price after order placed >= activationPrice, and the latest mark price = stopPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") = stopPrice

Place new CM order

Weight(IP): 1

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 return directly.
• LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.

New Margin Order

Weight(IP): 1

Security Type: TRADE

Place new UM conditional order

Weight(IP): 1

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 price reaches the triggerPrice.
• STOP, STOP_MARKET: BUY: latest price >= triggerPrice; SELL: latest price <= triggerPrice.
• TAKE_PROFIT, TAKE_PROFIT_MARKET: BUY: latest price <= triggerPrice; SELL: latest price >= triggerPrice.
• TRAILING_STOP_MARKET: BUY: lowest price after order placed <= activatePrice, and latest price >= lowest price * (1 + callbackRate); SELL: highest price after order placed >= activatePrice, and latest price <= highest price * (1 - callbackRate).
• selfTradePreventionMode is only effective when timeInForce set to IOC or GTC or GTD.

Place new UM conditional order

Weight(IP): 1

Security Type: TRADE

Notes:

• Additional mandatory parameters based on type:
• Order with type STOP/TAKE_PROFIT, parameter timeInForce can be sent ( default GTC).
• Condition orders will be triggered when:
• STOP, STOP_MARKET:
• BUY: "MARK_PRICE" >= stopPrice
• SELL: "MARK_PRICE" = stopPrice
• TRAILING_STOP_MARKET:
• BUY: the lowest mark price after order placed ``= the lowest mark price
• (1 + callbackRate)
• SELL: the highest mark price after order placed >= activationPrice, and the latest mark price = stopPrice
• SELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") = stopPrice
• 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

Place new UM order

Weight(IP): 1

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 return 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 set to IOC or GTC or GTD.
• In extreme market conditions, timeInForce GTD order auto cancel time might be delayed comparing to goodTillDate

Query All CM Conditional Orders

Weight: - 1 for a single symbol

• 40 when symbol is omitted

Security Type: USER_DATA

Notes:

• These orders will not be found:
• order strategyStatus is CANCELED or EXPIRED, AND
• order has NO filled trade, AND
• created time + 7 days * The query time period must be less than 7 days( default as the recent 7 days).

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

Weight: - 20 with symbol

• 40 with pair

Security Type: USER_DATA

Notes:

• Either symbol or pair must be sent.
• If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.
• 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

Get all open conditional orders on a symbol. Careful when accessing this with no symbol.

Weight: - 1 for a single symbol

• 40 when symbol is omitted

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.

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

Weight: - 1 for a single symbol

• 40 when symbol is omitted

Security Type: USER_DATA

Get all UM open algo orders on a symbol. If the symbol is not sent, orders for all symbols will be returned.

Weight(IP): 1

Security Type: USER_DATA

Notes:

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

Get all open conditional orders on a symbol.

Weight: - 1 for a single symbol

• 40 when symbol is omitted

Security Type: USER_DATA

Notes:

• If symbol is not provided, conditional open orders for all symbols are returned.

Get all open orders on a symbol.

Weight: - 1 for a single symbol

• 40 when symbol is omitted

Security Type: USER_DATA

Notes:

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

Query All Margin Account Orders

Weight(IP): 100

Security Type: USER_DATA

Notes:

• If orderId is set, returns orders with id >= orderId; otherwise returns recent order history.
• For some historical orders, cummulativeQuoteQty < 0 means the data is unavailable at this time.

Query All UM Conditional Orders

Weight: - 1 for a single symbol

• 40 when symbol is omitted

Security Type: USER_DATA

Notes:

• These orders will not be found:
• order strategyStatus is CANCELED or EXPIRED, AND
• order has NO filled trade, AND
• created time + 7 days * The query time period must be less than 7 days( default as the recent 7 days).

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

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).

Query CM Conditional Order History

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either strategyId or newClientStrategyId must be sent.
• NEW orders will not be found.
• These orders will not be found:
• order status is CANCELED or EXPIRED, AND
• order has NO filled trade, AND
• created time + 7 days < current time

Get order modification history

Weight(IP): 1

Security Type: TRADE

Notes:

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

Check an CM order's status.

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either orderId or origClientOrderId must be sent.
• 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

Query Current CM Open Conditional Order

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either strategyId or newClientStrategyId must be sent.
• If the queried order has been triggered, cancelled or expired, the error message "Order does not exist" will be returned.

Query current CM open order

Weight(IP): 1

Security Type: USER_DATA

Notes:

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

Query Current Margin Open Order

Weight(IP): 5

Security Type: USER_DATA

Notes:

• If symbol is not sent, order records for all symbols are returned.
• When returning all symbols, the request count charged to the rate limiter equals the number of symbols currently trading on the exchange.

Check an UM algo order's status. Orders will not be found if: status is CANCELED/EXPIRED with no fills and created 3+ days ago; or created 90+ days ago.

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either algoId or clientAlgoId must be sent. algoId is self-increment for each specific symbol.

Query Current UM Open Conditional Order

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either strategyId or newClientStrategyId must be sent.
• If the queried order has been CANCELED, TRIGGERED or EXPIRED, the error message "Order does not exist" will be returned.

Query current UM open order

Weight(IP): 1

Security Type: USER_DATA

Notes:

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

Query Margin Account Order

Weight(IP): 10

Security Type: USER_DATA

Notes:

• Either orderId or origClientOrderId must be sent.
• For some historical orders, cummulativeQuoteQty < 0 means the data is unavailable at this time.

Query all OCO for a specific margin account based on provided optional parameters

Weight(IP): 100

Security Type: USER_DATA

Retrieves a specific OCO based on provided optional parameters

Weight(IP): 5

Security Type: USER_DATA

Query Margin Account's Open OCO

Weight(IP): 5

Security Type: USER_DATA

Get all algo orders: ACTIVE, CANCELED, TRIGGERED or FINISHED.

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 than 7 days (default as the recent 7 days).

Query UM Conditional Order History

Weight(IP): 1

Security Type: USER_DATA

Notes:

• Either strategyId or newClientStrategyId must be sent.
• NEW orders will not be found.
• These orders will not be found:
• order status is CANCELED or EXPIRED, AND
• order has NO filled trade, AND
• created time + 7 days < current time

Get order modification history

Weight(IP): 1

Security Type: TRADE

Notes:

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

Check an UM order's status.

Weight(IP): 1

Security Type: USER_DATA

Notes:

• These orders will not be found:
• Either orderId or origClientOrderId must be sent.
• order status is CANCELED or EXPIRED, AND
• order has NO filled trade, AND
• created time + 3 days < current time

Query User's CM 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

Query user's margin force orders

Weight(IP): 1

Security Type: USER_DATA

Query User's UM 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

Change user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off ) on EVERY symbol

Weight(IP): 1

Security Type: TRADE

Notes:

• The BNB would not be collected from UM-PM account to the Portfolio Margin account.

Get trades for a specific account and UM 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.

Query UM 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