/papi/v1/balance (GET) |
Account Balance(USER_DATA) |
None |
asset, recvWindow |
Yes |
/papi/v1/account (GET) |
Account Information(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/bnb-transfer (POST) |
BNB transfer (TRADE) |
amount, transferSide |
recvWindow |
Yes |
/papi/v1/cm/leverageBracket (GET) |
CM Notional and Leverage Brackets(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/repay-futures-switch (POST) |
Change Auto-repay-futures Status(TRADE) |
autoRepay |
recvWindow |
Yes |
/papi/v1/repay-futures-switch (GET) |
Get Auto-repay-futures Status(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/cm/leverage (POST) |
Change CM Initial Leverage (TRADE) |
symbol, leverage |
recvWindow |
Yes |
/papi/v1/cm/positionSide/dual (POST) |
Change CM Position Mode(TRADE) |
dualSidePosition |
recvWindow |
Yes |
/papi/v1/cm/positionSide/dual (GET) |
Get CM Current Position Mode(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/leverage (POST) |
Change UM Initial Leverage(TRADE) |
symbol, leverage |
recvWindow |
Yes |
/papi/v1/um/positionSide/dual (POST) |
Change UM Position Mode(TRADE) |
dualSidePosition |
recvWindow |
Yes |
/papi/v1/um/positionSide/dual (GET) |
Get UM Current Position Mode(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/auto-collection (POST) |
Fund Auto-collection(TRADE) |
None |
recvWindow |
Yes |
/papi/v1/asset-collection (POST) |
Fund Collection by Asset(TRADE) |
asset |
recvWindow |
Yes |
/papi/v1/cm/account (GET) |
Get CM Account Detail(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/cm/income (GET) |
Get CM Income History(USER_DATA) |
None |
symbol, incomeType, startTime, endTime, page, limit, recvWindow |
Yes |
/papi/v1/um/order/asyn (GET) |
Get Download Id For UM Futures Order History (USER_DATA) |
startTime, endTime |
recvWindow |
Yes |
/papi/v1/um/trade/asyn (GET) |
Get Download Id For UM Futures Trade History (USER_DATA) |
startTime, endTime |
recvWindow |
Yes |
/papi/v1/um/income/asyn (GET) |
Get Download Id For UM Futures Transaction History (USER_DATA) |
startTime, endTime |
recvWindow |
Yes |
/papi/v1/margin/marginInterestHistory (GET) |
Get Margin Borrow/Loan Interest History(USER_DATA) |
None |
asset, startTime, endTime, current, size, archived, recvWindow |
Yes |
/papi/v2/um/account (GET) |
Get UM Account Detail V2(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/account (GET) |
Get UM Account Detail(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/accountConfig (GET) |
UM Futures Account Configuration(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/order/asyn/id (GET) |
Get UM Futures Order Download Link by Id(USER_DATA) |
downloadId |
recvWindow |
Yes |
/papi/v1/um/symbolConfig (GET) |
UM Futures Symbol Configuration(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/um/trade/asyn/id (GET) |
Get UM Futures Trade Download Link by Id(USER_DATA) |
downloadId |
recvWindow |
Yes |
/papi/v1/um/income/asyn/id (GET) |
Get UM Futures Transaction Download Link by Id(USER_DATA) |
downloadId |
recvWindow |
Yes |
/papi/v1/um/income (GET) |
Get UM Income History(USER_DATA) |
None |
symbol, incomeType, startTime, endTime, page, limit, recvWindow |
Yes |
/papi/v1/cm/commissionRate (GET) |
Get User Commission Rate for CM(USER_DATA) |
symbol |
recvWindow |
Yes |
/papi/v1/um/commissionRate (GET) |
Get User Commission Rate for UM(USER_DATA) |
symbol |
recvWindow |
Yes |
/papi/v1/margin/maxBorrowable (GET) |
Margin Max Borrow(USER_DATA) |
asset |
recvWindow |
Yes |
/papi/v1/um/apiTradingStatus (GET) |
Portfolio Margin UM Trading Quantitative Rules Indicators(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/cm/positionRisk (GET) |
Query CM Position Information(USER_DATA) |
None |
marginAsset, pair, recvWindow |
Yes |
/papi/v1/margin/marginLoan (GET) |
Query Margin Loan Record(USER_DATA) |
asset |
txId, startTime, endTime, current, size, archived, recvWindow |
Yes |
/papi/v1/margin/maxWithdraw (GET) |
Query Margin Max Withdraw(USER_DATA) |
asset |
recvWindow |
Yes |
/papi/v1/margin/repayLoan (GET) |
Query Margin repay Record(USER_DATA) |
asset |
txId, startTime, endTime, current, size, archived, recvWindow |
Yes |
/papi/v1/portfolio/interest-history (GET) |
Query Portfolio Margin Negative Balance Interest History(USER_DATA) |
None |
asset, startTime, endTime, size, recvWindow |
Yes |
/papi/v1/um/positionRisk (GET) |
Query UM Position Information(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/portfolio/negative-balance-exchange-record (GET) |
Query User Negative Balance Auto Exchange Record (USER_DATA) |
startTime, endTime |
recvWindow |
Yes |
/papi/v1/rateLimit/order (GET) |
Query User Rate Limit (USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/repay-futures-negative-balance (POST) |
Repay futures Negative Balance(USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/leverageBracket (GET) |
UM Notional and Leverage Brackets (USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/ping (GET) |
Test Connectivity |
None |
None |
No |
/papi/v1/cm/userTrades (GET) |
CM Account Trade List(USER_DATA) |
None |
symbol, pair, startTime, endTime, fromId, limit, recvWindow |
Yes |
/papi/v1/cm/adlQuantile (GET) |
CM Position ADL Quantile Estimation(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/cm/conditional/allOpenOrders (DELETE) |
Cancel All CM Open Conditional Orders(TRADE) |
symbol |
recvWindow |
Yes |
/papi/v1/cm/allOpenOrders (DELETE) |
Cancel All CM Open Orders(TRADE) |
symbol |
recvWindow |
Yes |
/papi/v1/um/conditional/allOpenOrders (DELETE) |
Cancel All UM Open Conditional Orders (TRADE) |
symbol |
recvWindow |
Yes |
/papi/v1/um/allOpenOrders (DELETE) |
Cancel All UM Open Orders(TRADE) |
symbol |
recvWindow |
Yes |
/papi/v1/cm/conditional/order (DELETE) |
Cancel CM Conditional Order(TRADE) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/cm/conditional/order (POST) |
New CM Conditional Order(TRADE) |
symbol, side, strategyType |
positionSide, timeInForce, quantity, reduceOnly, price, workingType, priceProtect, newClientStrategyId, stopPrice, activationPrice, callbackRate, recvWindow |
Yes |
/papi/v1/cm/order (DELETE) |
Cancel CM Order(TRADE) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/cm/order (PUT) |
Modify CM Order(TRADE) |
symbol, side, quantity, price |
orderId, origClientOrderId, priceMatch, recvWindow |
Yes |
/papi/v1/cm/order (POST) |
New CM Order(TRADE) |
symbol, side, type |
positionSide, timeInForce, quantity, reduceOnly, price, priceMatch, newClientOrderId, newOrderRespType, recvWindow |
Yes |
/papi/v1/cm/order (GET) |
Query CM Order(USER_DATA) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/margin/allOpenOrders (DELETE) |
Cancel Margin Account All Open Orders on a Symbol(TRADE) |
symbol |
recvWindow |
Yes |
/papi/v1/margin/orderList (DELETE) |
Cancel Margin Account OCO Orders(TRADE) |
symbol |
orderListId, listClientOrderId, newClientOrderId, recvWindow |
Yes |
/papi/v1/margin/orderList (GET) |
Query Margin Account's OCO (USER_DATA) |
None |
orderListId, origClientOrderId, recvWindow |
Yes |
/papi/v1/margin/order (DELETE) |
Cancel Margin Account Order(TRADE) |
symbol |
orderId, origClientOrderId, newClientOrderId, recvWindow |
Yes |
/papi/v1/margin/order (POST) |
New Margin Order(TRADE) |
symbol, side, type |
quantity, quoteOrderQty, price, stopPrice, newClientOrderId, newOrderRespType, icebergQty, sideEffectType, timeInForce, selfTradePreventionMode, autoRepayAtCancel, recvWindow |
Yes |
/papi/v1/margin/order (GET) |
Query Margin Account Order (USER_DATA) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/um/conditional/order (DELETE) |
Cancel UM Conditional Order(TRADE) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/um/conditional/order (POST) |
New UM Conditional Order (TRADE) |
symbol, side, strategyType |
positionSide, timeInForce, quantity, reduceOnly, price, workingType, priceProtect, newClientStrategyId, stopPrice, activationPrice, callbackRate, priceMatch, selfTradePreventionMode, goodTillDate, recvWindow |
Yes |
/papi/v1/um/order (DELETE) |
Cancel UM Order(TRADE) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/um/order (PUT) |
Modify UM Order(TRADE) |
symbol, side, quantity, price |
orderId, origClientOrderId, priceMatch, recvWindow |
Yes |
/papi/v1/um/order (POST) |
New UM Order (TRADE) |
symbol, side, type |
positionSide, timeInForce, quantity, reduceOnly, price, newClientOrderId, newOrderRespType, priceMatch, selfTradePreventionMode, goodTillDate, recvWindow |
Yes |
/papi/v1/um/order (GET) |
Query UM Order (USER_DATA) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/um/feeBurn (GET) |
Get UM Futures BNB Burn Status (USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/um/feeBurn (POST) |
Toggle BNB Burn On UM Futures Trade (TRADE) |
feeBurn |
recvWindow |
Yes |
/papi/v1/marginLoan (POST) |
Margin Account Borrow(MARGIN) |
asset, amount |
recvWindow |
Yes |
/papi/v1/margin/order/oco (POST) |
Margin Account New OCO(TRADE) |
symbol, side, quantity, price, stopPrice |
listClientOrderId, limitClientOrderId, limitIcebergQty, stopClientOrderId, stopLimitPrice, stopIcebergQty, stopLimitTimeInForce, newOrderRespType, sideEffectType, recvWindow |
Yes |
/papi/v1/margin/repay-debt (POST) |
Margin Account Repay Debt(TRADE) |
asset |
amount, specifyRepayAssets, recvWindow |
Yes |
/papi/v1/repayLoan (POST) |
Margin Account Repay(MARGIN) |
asset, amount |
recvWindow |
Yes |
/papi/v1/margin/myTrades (GET) |
Margin Account Trade List (USER_DATA) |
symbol |
orderId, startTime, endTime, fromId, limit, recvWindow |
Yes |
/papi/v1/cm/conditional/allOrders (GET) |
Query All CM Conditional Orders(USER_DATA) |
None |
symbol, strategyId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/cm/allOrders (GET) |
Query All CM Orders (USER_DATA) |
symbol |
pair, orderId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/cm/conditional/openOrders (GET) |
Query All Current CM Open Conditional Orders (USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/cm/openOrders (GET) |
Query All Current CM Open Orders(USER_DATA) |
None |
symbol, pair, recvWindow |
Yes |
/papi/v1/um/conditional/openOrders (GET) |
Query All Current UM Open Conditional Orders(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/um/openOrders (GET) |
Query All Current UM Open Orders(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/margin/allOrders (GET) |
Query All Margin Account Orders (USER_DATA) |
symbol |
orderId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/um/conditional/allOrders (GET) |
Query All UM Conditional Orders(USER_DATA) |
None |
symbol, strategyId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/um/allOrders (GET) |
Query All UM Orders(USER_DATA) |
symbol |
orderId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/cm/conditional/orderHistory (GET) |
Query CM Conditional Order History(USER_DATA) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/cm/orderAmendment (GET) |
Query CM Modify Order History(TRADE) |
symbol |
orderId, origClientOrderId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/cm/conditional/openOrder (GET) |
Query Current CM Open Conditional Order(USER_DATA) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/cm/openOrder (GET) |
Query Current CM Open Order (USER_DATA) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/margin/openOrders (GET) |
Query Current Margin Open Order (USER_DATA) |
symbol |
recvWindow |
Yes |
/papi/v1/um/conditional/openOrder (GET) |
Query Current UM Open Conditional Order(USER_DATA) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/um/openOrder (GET) |
Query Current UM Open Order(USER_DATA) |
symbol |
orderId, origClientOrderId, recvWindow |
Yes |
/papi/v1/margin/openOrderList (GET) |
Query Margin Account's Open OCO (USER_DATA) |
None |
recvWindow |
Yes |
/papi/v1/margin/allOrderList (GET) |
Query Margin Account's all OCO (USER_DATA) |
None |
fromId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/um/conditional/orderHistory (GET) |
Query UM Conditional Order History(USER_DATA) |
symbol |
strategyId, newClientStrategyId, recvWindow |
Yes |
/papi/v1/um/orderAmendment (GET) |
Query UM Modify Order History(TRADE) |
symbol |
orderId, origClientOrderId, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/cm/forceOrders (GET) |
Query User's CM Force Orders(USER_DATA) |
None |
symbol, autoCloseType, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/margin/forceOrders (GET) |
Query User's Margin Force Orders(USER_DATA) |
None |
startTime, endTime, current, size, recvWindow |
Yes |
/papi/v1/um/forceOrders (GET) |
Query User's UM Force Orders (USER_DATA) |
None |
symbol, autoCloseType, startTime, endTime, limit, recvWindow |
Yes |
/papi/v1/um/userTrades (GET) |
UM Account Trade List(USER_DATA) |
symbol |
startTime, endTime, fromId, limit, recvWindow |
Yes |
/papi/v1/um/adlQuantile (GET) |
UM Position ADL Quantile Estimation(USER_DATA) |
None |
symbol, recvWindow |
Yes |
/papi/v1/listenKey (DELETE) |
Close User Data Stream(USER_STREAM) |
None |
None |
No |
/papi/v1/listenKey (PUT) |
Keepalive User Data Stream (USER_STREAM) |
None |
None |
No |
/papi/v1/listenKey (POST) |
Start User Data Stream(USER_STREAM) |
None |
None |
No |