Query Special key(Low Latency Trading)
Query Special Key Information.
This only applies to Special Key for Low Latency Trading.
Query Special key(Low Latency Trading) › Authorization
Query Special key(Low Latency Trading) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
apiKeytimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolrecvWindowQuery Special key(Low Latency Trading) › Responses
Special key
apiKeyapi Key.
ip0.0.0.0 is just an initial statereference (no extra meaning).
apiNameapi Name.
typetype.
permissionModepermission Mode.
Create Special Key(Low-Latency Trading)
Eligibility
- Binance Margin offers low-latency trading through a special key, available exclusively to users with VIP level 7 or higher.
- If you are VIP level 6 or below, please contact your VIP manager for eligibility criterias.
- All new Margin Special Key users are required to read, understand, and agree to the Margin Special Key Supplemental Product Terms at the master account level before creating a Margin Special Key.
- Once signed at the master account level, the agreement applies to all sub-accounts. The master account and all sub-accounts (Cross Margin Classic and Portfolio Margin Pro) are authorized to create a Margin Special Key and are subject to the LiquidationLoan policy.
For more information, please refer to FAQ.
Supported Products:
- Cross Margin
- Isolated Margin
- Portfolio Margin Pro
Unsupported Products:
- Portfolio Margin
We support several types of API keys:
- Ed25519 (recommended)
- HMAC
- RSA
We recommend to use Ed25519 API keys as it should provide the best performance and security out of all supported key types. We accept PKCS#8 (BEGIN PUBLIC KEY). For how to generate an RSA key pair to send API requests on Binance. Please refer to the document below FAQ .
How to use the Margin Special Key
- Use the below
sapiendpoint to create your margin special API Key. - For accessing the Cross Margin account, do not send the
symbolparameter. - For accessing the Isolated Margin account(s), pass the relevant
symbolparameter in the API Key creation request. - Use the generated API Key (and Secret key, if applicable) to perform margin trading and listenKey generation via Spot REST API (
https://api.binance.com/api/v3/*) endpoints.
Read REST API or WebSocket API documentation to learn how to use different API keys
You need to enable Permits “Enable Spot & Margin Trading” option for the API Key which requests this endpoint.
Create Special Key(Low-Latency Trading) › Authorization
Create Special Key(Low-Latency Trading) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Create Special Key(Low-Latency Trading) › Request Body
apiNametimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolipCan be added in batches, separated by commas. Max 30 for an API key
publicKey-
If publicKey is inputted it will create an RSA or Ed25519 key.
-
Need to be encoded to URL-encoded format
permissionModeThis parameter is only for the Ed25519 API key, and does not effact for other encryption methods. The value can be TRADE (TRADE for all permissions) or READ (READ for USER_DATA, FIX_API_READ_ONLY). The default value is TRADE.
recvWindowCreate Special Key(Low-Latency Trading) › Responses
Create Special Key
apiKeyapi Key.
secretKeysecretKey will be null when creating an RSA key
typeHMAC_SHA256 or RSA
Delete Special Key(Low-Latency Trading)
Deleting your Margin Special Key alone does not exit you from the Margin Special Key framework or discharge your obligations under the Margin Special Key Supplemental Product Terms. To fully exit, you must:
- Delete your Margin Special Key.
- Ensure there are no outstanding liabilities on the account.
- Call the Exit Margin Special Key API endpoint.
- Confirm the exit status via the API response.
Only after step 4 is completed and the exit status is confirmed by Binance will your account revert to standard liquidation logic and no longer be subject to the Margin Special Key Supplemental Product Terms.
If apiKey is given, apiName will be ignored. If apiName is given with no apiKey, all apikeys with given apiName will be deleted.
You need to enable Permits “Enable Spot & Margin” option for the API Key which requests this endpoint.
Delete Special Key(Low-Latency Trading) › Authorization
Delete Special Key(Low-Latency Trading) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyapiNamesymbolisolated margin pair
recvWindowDelete Special Key(Low-Latency Trading) › Responses
OK
Edit ip for Special Key(Low-Latency Trading)
Edit ip restriction. This only applies to Special Key for Low Latency Trading.
You need to enable Permits “Enable Spot & Margin” option for the API Key which requests this endpoint.
Edit ip for Special Key(Low-Latency Trading) › Authorization
Edit ip for Special Key(Low-Latency Trading) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Edit ip for Special Key(Low-Latency Trading) › Request Body
apiKeyipCan be added in batches, separated by commas. Max 30 for an API key
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolisolated margin pair
recvWindowEdit ip for Special Key(Low-Latency Trading) › Responses
OK
Exit Special Key Mode (TRADE)
Exit the Margin Special Key mode for Cross Margin Classic accounts.
All outstanding liabilities under the Cross Margin Classic account must be fully repaid before calling this endpoint. Deleting the Margin Special Key alone does not constitute a valid exit.
When a user creates a Margin Special API Key, the account enters "Special Key Mode". Upon a successful request, the following actions will be performed atomically:
- All existing Margin Special API Keys under the Cross Margin Classic mode account will be deleted.
- All pre-execution margin checks (including Open-order-loss calculation) will revert to standard mode.
- A cooldown period (default: 24 hours) will be enforced, during which the account will not be permitted to create new Margin Special API Keys.
For more information, please refer to FAQ.
Preconditions:
The following conditions must be met; otherwise the request will be rejected:
- Account type must be Cross Margin Classic.
- Account must currently be in Special Key Mode. If not, the request silently succeeds.
- Account must not be in liquidation.
- Account must have no liability.
You need to enable "Permits Enable Spot & Margin Trading" option for the API Key which requests this endpoint.
Exit Special Key Mode (TRADE) › Authorization
Exit Special Key Mode (TRADE) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Exit Special Key Mode (TRADE) › Request Body
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
recvWindowThe value cannot be greater than 60000
Exit Special Key Mode (TRADE) › Responses
Exit Special Key Mode
Get Force Liquidation Record
Get Force Liquidation Record
Get Force Liquidation Record › Authorization
Get Force Liquidation Record › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
startTimeendTimeisolatedSymbolcurrentCurrently querying page.
sizerecvWindowGet Force Liquidation Record › Responses
Get Force Liquidation Record
rows list.
totaltotal.
Get Small Liability Exchange Coin List
Query the coins which can be small liability exchange
Get Small Liability Exchange Coin List › Authorization
Get Small Liability Exchange Coin List › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
recvWindowGet Small Liability Exchange Coin List › Responses
Get Small Liability Exchange Coin List
assetasset.
interestinterest.
principalprincipal.
liabilityAssetliability Asset.
liabilityQtyliability Qty.
Small Liability Exchange
Small Liability Exchange
Small Liability Exchange › Authorization
Small Liability Exchange › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Small Liability Exchange › Request Body
assetNamesThe assets list of small liability exchange
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
recvWindowSmall Liability Exchange › Responses
OK
Get Small Liability Exchange History
Get Small liability Exchange History
Get Small Liability Exchange History › Authorization
Get Small Liability Exchange History › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
currentCurrently querying page.
sizetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
startTimeDefault: 30 days from current timestamp
endTimeDefault: present timestamp
recvWindowGet Small Liability Exchange History › Responses
Get Small Liability Exchange History
totaltotal.
rows list.
Query Margin Account's Open Orders
Query Margin Account's Open Orders
Query Margin Account's Open Orders › Authorization
Query Margin Account's Open Orders › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolisolated margin pair
isIsolatedrecvWindowQuery Margin Account's Open Orders › Responses
Margin Account's Open Orders
clientOrderIdclient Order Id.
cummulativeQuoteQtycummulative Quote Qty.
executedQtyexecuted Qty.
icebergQtyiceberg Qty.
isWorkingis Working.
orderIdorder Id.
origQtyorig Qty.
priceprice.
sideside.
statusstatus.
stopPricestop Price.
symbolsymbol.
isIsolatedis Isolated.
timetime.
timeInForcetime In Force.
typetype.
selfTradePreventionModeself Trade Prevention Mode.
updateTimeupdate Time.
Margin Account Cancel all Open Orders on a Symbol
Cancels all active orders on a symbol for margin account.
This includes OCO orders.
Margin Account Cancel all Open Orders on a Symbol › Authorization
Margin Account Cancel all Open Orders on a Symbol › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedrecvWindowMargin Account Cancel all Open Orders on a Symbol › Responses
Margin Account Cancel all Open Orders on a Symbol
symbolsymbol.
isIsolatedif isolated margin
origClientOrderIdorig Client Order Id.
orderIdorder Id.
orderListIdorder List Id.
clientOrderIdclient Order Id.
priceprice.
origQtyorig Qty.
executedQtyexecuted Qty.
cummulativeQuoteQtycummulative Quote Qty.
statusstatus.
timeInForcetime In Force.
typetype.
sideside.
selfTradePreventionModeself Trade Prevention Mode.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
orders list.
order Reports list.
Query Margin Account's OCO
Retrieves a specific OCO based on provided optional parameters
Query Margin Account's OCO › Authorization
Query Margin Account's OCO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedsymbolmandatory for isolated margin, not supported for cross margin
orderListIdEither orderListId or origClientOrderId must be provided
origClientOrderIdEither orderListId or origClientOrderId must be provided
recvWindowQuery Margin Account's OCO › Responses
Margin Account's OCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedif isolated margin
orders list.
Margin Account Cancel OCO
Cancel an entire Order List for a margin account.
Margin Account Cancel OCO › Authorization
Margin Account Cancel OCO › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedorderListIdEither orderListId or listClientOrderId must be provided
listClientOrderIdEither orderListId or listClientOrderId must be provided
newClientOrderIdUsed to uniquely identify this cancel. Automatically generated by default
recvWindowMargin Account Cancel OCO › Responses
Margin Account Cancel OCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedif isolated margin
orders list.
order Reports.
Query Margin Account's Order
Query Margin Account's Order
Query Margin Account's Order › Authorization
Query Margin Account's Order › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedorderIdorigClientOrderIdrecvWindowQuery Margin Account's Order › Responses
Margin Account's Order
clientOrderIdclient Order Id.
cummulativeQuoteQtycummulative Quote Qty.
executedQtyexecuted Qty.
icebergQtyiceberg Qty.
isWorkingis Working.
orderIdorder Id.
origQtyorig Qty.
priceprice.
sideside.
statusstatus.
stopPricestop Price.
symbolsymbol.
isIsolatedis Isolated.
timetime.
timeInForcetime In Force.
typetype.
selfTradePreventionModeself Trade Prevention Mode.
updateTimeupdate Time.
Margin Account New Order
Post a new order for margin account.
Margin Account New Order › Authorization
Margin Account New Order › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
6(UID) or 1500(UID) when sideEffectType is MARGIN_BUY or AUTO_BORROW_REPAY
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Margin Account New Order › Request Body
symbolsidetypetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedquantityquoteOrderQtypricestopPriceUsed with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
newClientOrderIdA unique id among open orders. Automatically generated if not sent.
icebergQtyUsed with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
newOrderRespTypeMARKET and LIMIT order types default to FULL, all other orders default to ACK.
sideEffectTypetimeInForceselfTradePreventionModetrailingDeltaUsed with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
autoRepayAtCancelOnly when MARGIN_BUY or AUTO_BORROW_REPAY order takes effect, true means that the debt generated by the order needs to be repaid after the order is cancelled.
recvWindowMargin Account New Order › Responses
Margin Account New Order
symbolsymbol.
orderIdorder Id.
clientOrderIdclient Order Id.
isIsolatedif isolated margin
transactTimetransact Time.
priceprice.
origQtyorig Qty.
executedQtyexecuted Qty.
cummulativeQuoteQtycummulative Quote Qty.
statusstatus.
timeInForcetime In Force.
typetype.
sideside.
selfTradePreventionModeself Trade Prevention Mode.
marginBuyBorrowAmountmargin Buy Borrow Amount.
marginBuyBorrowAssetmargin Buy Borrow Asset.
fills list.
Margin Account Cancel Order
Cancel an active order for margin account.
Margin Account Cancel Order › Authorization
Margin Account Cancel Order › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedorderIdorigClientOrderIdnewClientOrderIdUsed to uniquely identify this cancel. Automatically generated by default.
recvWindowMargin Account Cancel Order › Responses
Margin Account Cancel Order
symbolsymbol.
orderIdorder Id.
origClientOrderIdorig Client Order Id.
clientOrderIdclient Order Id.
priceprice.
origQtyorig Qty.
executedQtyexecuted Qty.
cummulativeQuoteQtycummulative Quote Qty.
statusstatus.
timeInForcetime In Force.
typetype.
sideside.
isIsolatedif isolated margin
Margin Account New OCO
Send in a new OCO for a margin account
Margin Account New OCO › Authorization
Margin Account New OCO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
6(UID) or 1500(UID) when sideEffectType is MARGIN_BUY or AUTO_BORROW_REPAY
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Margin Account New OCO › Request Body
symbolsidequantitypricestopPricetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedlistClientOrderIdA unique Id for the entire orderList
limitClientOrderIdA unique Id for the limit order
limitIcebergQtystopClientOrderIdA unique Id for the stop loss/stop loss limit leg
stopLimitPriceIf provided, stopLimitTimeInForce is required.
stopIcebergQtystopLimitTimeInForcenewOrderRespTypesideEffectTypeselfTradePreventionModeautoRepayAtCancelOnly when MARGIN_BUY or AUTO_BORROW_REPAY order takes effect, true means that the debt generated by the order needs to be repay after the order is cancelled.
recvWindowMargin Account New OCO › Responses
Margin Account New OCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
marginBuyBorrowAmountwill not return if no margin trade happens
marginBuyBorrowAssetwill not return if no margin trade happens
isIsolatedif isolated margin
orders list.
Margin Account New OTO
Post a new OTO order for margin account:
-
An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders.
-
The first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book. -
The second order is called the pending order. It can be any order type except for
MARKETorders using parameterquoteOrderQty. The pending order is only placed on the order book when the working order gets fully filled. -
If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired.
-
When the order list is placed, if the working order gets immediately fully filled, the placement response will show the working order as
FILLEDbut the pending order will still appear asPENDING_NEW. You need to query the status of the pending order again to see its updated status. -
OTOs add 2 orders to the unfilled order count,
EXCHANGE_MAX_NUM_ORDERSfilter andMAX_NUM_ORDERSfilter.
Margin Account New OTO › Authorization
Margin Account New OTO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
6(UID) or 1500(UID) when sideEffectType is MARGIN_BUY or AUTO_BORROW_REPAY
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Margin Account New OTO › Request Body
symbolworkingTypeworkingSideworkingPriceworkingQuantitySets the quantity for the working order.
workingIcebergQtyThis can only be used if workingTimeInForce is GTC.
pendingTypependingSidependingQuantitySets the quantity for the pending order.
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedlistClientOrderIdArbitrary unique ID among open order lists. Automatically generated if not sent.
A new order list with the same listClientOrderId is accepted only when the previous one is filled or completely expired.listClientOrderId is distinct from the workingClientOrderId and the pendingClientOrderId.
newOrderRespTypeMARKET and LIMIT order types default to FULL, all other orders default to ACK.
sideEffectTypeselfTradePreventionModeautoRepayAtCancelOnly when MARGIN_BUY order takes effect, true means that the debt generated by the order needs to be repaid after the order is cancelled.
workingClientOrderIdArbitrary unique ID among open orders for the working order. Automatically generated if not sent.
workingTimeInForcependingClientOrderIdArbitrary unique ID among open orders for the pending order. Automatically generated if not sent.
pendingPricependingStopPricependingTrailingDeltapendingIcebergQtyThis can only be used if pendingTimeInForce is GTC.
pendingTimeInForceMargin Account New OTO › Responses
Margin Account New OTO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedis Isolated.
orders list.
order Reports list.
Margin Account New OTOCO
Post a new OTOCO order for margin account:
-
An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders.
-
The first order is called the working order and must be
LIMITorLIMIT_MAKER. Initially, only the working order goes on the order book.- The behavior of the working order is the same as the OTO.
-
OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets fully filled.
- The rules of the pending above and pending below follow the same rules as the Order List OCO.
-
OTOCOs add 3 orders against the unfilled order count,
EXCHANGE_MAX_NUM_ORDERSfilter, andMAX_NUM_ORDERSfilter.
Margin Account New OTOCO › Authorization
Margin Account New OTOCO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
6(UID) or 1500(UID) when sideEffectType is MARGIN_BUY or AUTO_BORROW_REPAY
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Margin Account New OTOCO › Request Body
symbolworkingTypeworkingSideworkingPriceworkingQuantitypendingSidependingQuantitypendingAboveTypetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedsideEffectTypeautoRepayAtCancelOnly when MARGIN_BUY order takes effect, true means that the debt generated by the order needs to be repaid after the order is cancelled.
listClientOrderIdArbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same listClientOrderId is accepted only when the previous one is filled or completely expired. listClientOrderId is distinct from the workingClientOrderId, pendingAboveClientOrderId, and the pendingBelowClientOrderId.
newOrderRespTypeselfTradePreventionModeworkingClientOrderIdArbitrary unique ID among open orders for the working order. Automatically generated if not sent.
workingIcebergQtyThis can only be used if workingTimeInForce is GTC.
workingTimeInForcependingAboveClientOrderIdArbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.
pendingAbovePricependingAboveStopPricependingAboveTrailingDeltapendingAboveIcebergQtyThis can only be used if pendingAboveTimeInForce is GTC.
pendingAboveTimeInForcependingBelowTypependingBelowClientOrderIdArbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.
pendingBelowPricependingBelowStopPricependingBelowTrailingDeltapendingBelowIcebergQtyThis can only be used if pendingBelowTimeInForce is GTC.
pendingBelowTimeInForceMargin Account New OTOCO › Responses
Margin Account New OTOCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedis Isolated.
orders list.
order Reports list.
Margin Manual Liquidation
Margin Manual Liquidation
Margin Manual Liquidation › Authorization
Margin Manual Liquidation › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Margin Manual Liquidation › Request Body
typetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolWhen type selects ISOLATED, symbol must be filled in
recvWindowMargin Manual Liquidation › Responses
Margin Manual Liquidation
assetasset.
interestinterest.
principalprincipal.
liabilityAssetliability Asset.
liabilityQtyliability Qty.
Query Current Margin Order Count Usage
Displays the user's current margin order count usage for all intervals.
Query Current Margin Order Count Usage › Authorization
Query Current Margin Order Count Usage › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedsymbolisolated symbol, mandatory for isolated margin
recvWindowQuery Current Margin Order Count Usage › Responses
Current Margin Order Count Usage
rateLimitTyperate Limit Type.
intervalinterval.
intervalNuminterval Num.
limitlimit.
countcount.
Query Margin Account's all OCO
Retrieves all OCO for a specific margin account based on provided optional parameters
Query Margin Account's all OCO › Authorization
Query Margin Account's all OCO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedsymbolmandatory for isolated margin, not supported for cross margin
fromIdIf supplied, neither startTime or endTime can be provided
startTimeendTimelimitrecvWindowQuery Margin Account's all OCO › Responses
Margin Account's all OCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedif isolated margin
orders list.
Query Margin Account's All Orders
Query Margin Account's All Orders
Query Margin Account's All Orders › Authorization
Query Margin Account's All Orders › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedorderIdstartTimeendTimelimitrecvWindowQuery Margin Account's All Orders › Responses
Margin Account's All Orders
clientOrderIdclient Order Id.
cummulativeQuoteQtycummulative Quote Qty.
executedQtyexecuted Qty.
icebergQtyiceberg Qty.
isWorkingis Working.
orderIdorder Id.
origQtyorig Qty.
priceprice.
sideside.
statusstatus.
stopPricestop Price.
symbolsymbol.
isIsolatedis Isolated.
timetime.
timeInForcetime In Force.
typetype.
selfTradePreventionModeself Trade Prevention Mode.
updateTimeupdate Time.
Query Margin Account's Open OCO
Query Margin Account's Open OCO
Query Margin Account's Open OCO › Authorization
Query Margin Account's Open OCO › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedsymbolmandatory for isolated margin, not supported for cross margin
recvWindowQuery Margin Account's Open OCO › Responses
Margin Account's Open OCO
orderListIdorder List Id.
contingencyTypecontingency Type.
listStatusTypelist Status Type.
listOrderStatuslist Order Status.
listClientOrderIdlist Client Order Id.
transactionTimetransaction Time.
symbolsymbol.
isIsolatedif isolated margin
orders list.
Query Margin Account's Trade List
Query Margin Account's Trade List
Query Margin Account's Trade List › Authorization
Query Margin Account's Trade List › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
isIsolatedorderIdstartTimeendTimefromIdTradeId to fetch from. Default gets most recent trades.
limitrecvWindowQuery Margin Account's Trade List › Responses
Margin Account's Trade List
commissioncommission.
commissionAssetcommission Asset.
idid.
isBestMatchis Best Match.
isBuyeris Buyer.
isMakeris Maker.
orderIdorder Id.
priceprice.
qtyqty.
symbolsymbol.
isIsolatedis Isolated.
timetime.
Query Prevented Matches
Displays the list of orders that were expired due to STP. (Self-Trade Prevention).
Query Prevented Matches › Authorization
Query Prevented Matches › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
preventedMatchIdorderIdfromPreventedMatchIdisIsolatedrecvWindowQuery Prevented Matches › Responses
Prevented Matches
symbolsymbol.
preventedMatchIdprevented Match Id.
takerOrderIdtaker Order Id.
makerSymbolmaker Symbol.
makerOrderIdmaker Order Id.
tradeGroupIdtrade Group Id.
selfTradePreventionModeself Trade Prevention Mode.
priceprice.
makerPreventedQuantitymaker Prevented Quantity.
transactTimetransact Time.
Query Special key List(Low Latency Trading)
This only applies to Special Key for Low Latency Trading.
Query Special key List(Low Latency Trading) › Authorization
Query Special key List(Low Latency Trading) › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
symbolrecvWindowQuery Special key List(Low Latency Trading) › Responses
Special key List
apiNameapi Name.
apiKeyapi Key.
ipip.
typetype.
permissionModepermission Mode.
Query Liquidation Loan
Query the current user's cross-margin liquidation loan information, including the original loan amount, repaid amount, and remaining amount. When a cross-margin account is liquidated and the account equity turns negative (bankruptcy), the system generates a liquidation loan record representing the deficit. This represents the shortfall amount denominated in USDC.
Query Liquidation Loan › Authorization
Query Liquidation Loan › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
recvWindowQuery Liquidation Loan › Responses
Query Liquidation Loan
assetThe asset of the liquidation loan (USDC by default)
amountTotal liquidation loan amount
repaidAmountAmount that has been repaid
remainingAmountOutstanding amount remaining to be repaid
Liquidation Loan Repay
Repays the outstanding cross-margin liquidation loan from the user's spot wallet. A liquidation loan represents the account deficit incurred when account equity turns negative during liquidation (bankruptcy). The repayment amount must be greater than 0 and cannot exceed the remaining loan balance. If the Spot Account has insufficient USDC balance, the repayment will fail.
Liquidation Loan Repay › Authorization
Liquidation Loan Repay › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Liquidation Loan Repay › Request Body
assetThe asset to repay (e.g. USDT, USDC)
amountRepayment amount, must be greater than 0
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
recvWindowLiquidation Loan Repay › Responses
Liquidation Loan Repay
repayIdUnique identifier for this repayment transaction
assetAsset used for repayment
amountActual repayment amount
statusRepayment status: SUCCESS (completed) or PENDING (processing)
createTimeUnix timestamp (milliseconds) when the repayment was created
Query Liquidation Loan Repay History
Query the repayment history of cross-margin liquidation loans (deficit caused by bankruptcy during liquidation). Supports time-range filtering and pagination.
Query Liquidation Loan Repay History › Authorization
Query Liquidation Loan Repay History › Request Weight
This endpoint consumes account (UID)-based request weight. Heavier endpoints consume more of your account rate limit capacity.
Learn more in the Rate limits section.
Headers
X-MBX-APIKEYAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
Query Parameters
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
startTimeStart time in Unix timestamp (milliseconds). Defaults to 7 days ago if not specified
endTimeEnd time in Unix timestamp (milliseconds). Defaults to now if not specified
currentCurrent page number, default 1
sizePage size, default 50
recvWindowQuery Liquidation Loan Repay History › Responses
Query Liquidation Loan Repay History
totalTotal number of repayment records