Skip to main content

Account requests

Account information (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "account.status",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query information about your account.

Weight: 20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
omitZeroBalancesBOOLEANNOWhen set to true, emits only the non-zero balances of an account. Default value: false.
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory => Database

Response:

{
"id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
"status": 200,
"result": {
"makerCommission": 15,
"takerCommission": 15,
"buyerCommission": 0,
"sellerCommission": 0,
"canTrade": true,
"canWithdraw": true,
"canDeposit": true,
"commissionRates": {
"maker": "0.00150000",
"taker": "0.00150000",
"buyer": "0.00000000",
"seller": "0.00000000"
},
"brokered": false,
"requireSelfTradePrevention": false,
"preventSor": false,
"updateTime": 1660801833000,
"accountType": "SPOT",
"balances": [
{
"asset": "BNB",
"free": "0.00000000",
"locked": "0.00000000"
},
{
"asset": "BTC",
"free": "1.3447112",
"locked": "0.08600000"
},
{
"asset": "USDT",
"free": "1021.21000000",
"locked": "0.00000000"
}
],
"permissions": [
"SPOT"
],
"uid": 354937868
},
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Query order (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "order.status",
"params": {
"symbol": "BTCUSDT",
"orderId": 12569099453,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
"timestamp": 1660801715431
}
}

Check execution status of an order.

Weight: 4

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
orderIdLONGNOLookup order by orderId
origClientOrderIdSTRINGNOLookup order by clientOrderId
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory => Database

Notes:

  • If both orderId and origClientOrderId are provided, the orderId is searched first, then the origClientOrderId from that result is checked against that order. If both conditions are not met the request will be rejected.

  • For some historical orders the cummulativeQuoteQty response field may be negative, meaning the data is not available at this time.

Response:

{
"id": "aa62318a-5a97-4f3b-bdc7-640bbe33b291",
"status": 200,
"result": {
"symbol": "BTCUSDT",
"orderId": 12569099453,
"orderListId": -1, // Present only for orders that belong to an order list.
"clientOrderId": "4d96324ff9d44481926157",
"price": "23416.10000000",
"origQty": "0.00847000",
"executedQty": "0.00847000",
"origQuoteOrderQty": "0.000000", // Always present. Zero if the order type does not use `quoteOrderQty`.
"cummulativeQuoteQty": "198.33521500",
"status": "FILLED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"stopPrice": "0.00000000", // Always present. Zero if the order type does not use `stopPrice`.
"trailingDelta": 10, // Present only if `trailingDelta` was set on the order.
"trailingTime": -1, // Present only if `trailingDelta` was set on the order.
"icebergQty": "0.00000000", // Always present. Zero for non-iceberg orders.
"time": 1660801715639, // Order placement time.
"updateTime": 1660801717945, // Time of the last update to the order.
"isWorking": true,
"workingTime": 1660801715639,
"strategyId": 37463720, // Present only if `strategyId` was set on the order.
"strategyType": 1000000, // Present only if `strategyType` was set on the order.
"selfTradePreventionMode": "NONE",
"preventedMatchId": 0, // Present only if the order expired due to STP.
"preventedQuantity": "1.200000", // Present only if the order expired due to STP.
"usedSor": true, // Field that determines whether order used SOR.
"workingFloor": "SOR", // Determines whether the order is being filled by the SOR or by the order book.
"pegPriceType": "PRIMARY_PEG", // Price peg type. Only for pegged orders.
"pegOffsetType": "PRICE_LEVEL", // Price peg offset type. Only for pegged orders, if requested.
"pegOffsetValue": 5, // Price peg offset value. Only for pegged orders, if requested.
"peggedPrice": "87523.83710000", // Current price order is pegged at. Only for pegged orders, once determined.
"expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
},
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 4
}
]
}

Note: The payload above does not show all fields that can appear. Please refer to Conditional fields in Order Responses.

Current open orders (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "openOrders.status",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query execution status of all open orders.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

Weight:

ParameterWeight
symbol6
none80

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGNOIf omitted, open orders for all symbols are returned
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory => Database

Response:

{
"id": "55f07876-4f6f-4c47-87dc-43e5fff3f2e7",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"orderId": 12569099453,
"orderListId": -1, // Present only for orders that belong to an order list.
"clientOrderId": "4d96324ff9d44481926157",
"price": "23416.10000000",
"origQty": "0.00847000",
"executedQty": "0.00720000",
"origQuoteOrderQty": "0.000000", // Always present. Zero if the order type does not use `quoteOrderQty`.
"cummulativeQuoteQty": "172.43931000",
"status": "PARTIALLY_FILLED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"time": 1660801715639, // Order placement time.
"updateTime": 1660801717945, // Time of the last update to the order.
"isWorking": true,
"workingTime": 1660801715639,
"selfTradePreventionMode": "NONE",
"icebergQty": "0.00000000", // Appears only if the parameter icebergQty was sent in the request.
"preventedMatchId": 0, // Appears only if the order expired due to STP.
"preventedQuantity": "1.200000", // Order quantity that expired due to STP.
"stopPrice": "0.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
"strategyId": 1, // Appears only if the strategyId parameter was provided upon order placement.
"strategyType": 1000000, // Appears only if the strategyType parameter was provided upon order placement.
"trailingDelta": 10, // Delta price change required before order activation.
"trailingTime": -1, // Time when the trailing order is now active and tracking price changes.
"usedSor": true, // Field that determines whether order used SOR.
"workingFloor": "SOR", // Determines whether the order is being filled by the SOR or by the order book.
"pegPriceType": "PRIMARY_PEG", // Price peg type. Only for pegged orders.
"pegOffsetType": "PRICE_LEVEL", // Price peg offset type. Only for pegged orders, if requested.
"pegOffsetValue": 5, // Price peg offset value. Only for pegged orders, if requested.
"peggedPrice": "87523.83710000", // Current price order is pegged at. Only for pegged orders, once determined.
"expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 6
}
]
}

Note: The payload above does not show all fields that can appear. Please refer to Conditional fields in Order Responses.

Account order history (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "allOrders",
"params": {
"symbol": "BNBUSDT",
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query information about all your orders – active, canceled, filled – filtered by time range.

Weight: 20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
orderIdLONGNOOrder ID to begin at
startTimeLONGNOTimestamp in ms
endTimeLONGNOTimestamp in ms
limitINTNODefault: 500; Maximum: 1000
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Notes:

  • If startTime and/or endTime are specified, orderId is ignored.

    Orders are filtered by time of the last execution status update.

  • If orderId is specified, return orders with order ID >= orderId.

  • If no condition is specified, the most recent orders are returned.

  • For some historical orders the cummulativeQuoteQty response field may be negative, meaning the data is not available at this time.

  • The time between startTime and endTime can't be longer than 24 hours.

Response:

{
"id": "734235c2-13d2-4574-be68-723e818c08f3",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"orderId": 12569099453,
"orderListId": -1, // Present only for orders that belong to an order list.
"clientOrderId": "4d96324ff9d44481926157",
"price": "23416.10000000",
"origQty": "0.00847000",
"executedQty": "0.00847000",
"cummulativeQuoteQty": "198.33521500",
"status": "FILLED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"time": 1660801715639, // Order placement time.
"updateTime": 1660801717945, // Time of the last update to the order.
"isWorking": true,
"workingTime": 1660801715639,
"origQuoteOrderQty": "0.000000", // Always present. Zero if the order type does not use `quoteOrderQty`.
"selfTradePreventionMode": "NONE",
"preventedMatchId": 0, // Present only if the order expired due to STP.
"preventedQuantity": "1.200000", // Present only if the order expired due to STP.
"icebergQty": "0.00000000", // Appears only if the parameter icebergQty was sent in the request.
"stopPrice": "0.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
"strategyId": 1, // Appears only if the strategyId parameter was provided upon order placement.
"strategyType": 1000000, // Appears only if the strategyType parameter was provided upon order placement.
"trailingDelta": 10, // Delta price change required before order activation.
"trailingTime": -1, // Time when the trailing order is now active and tracking price changes.
"usedSor": true, // Field that determines whether order used SOR.
"workingFloor": "SOR", // Determines whether the order is being filled by the SOR or by the order book.
"pegPriceType": "PRIMARY_PEG", // Price peg type. Only for pegged orders.
"pegOffsetType": "PRICE_LEVEL", // Price peg offset type. Only for pegged orders, if requested.
"pegOffsetValue": 5, // Price peg offset value. Only for pegged orders, if requested.
"peggedPrice": "87523.83710000", // Current price order is pegged at. Only for pegged orders, once determined.
"expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Query Order list (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "orderList.status",
"params": {
"origClientOrderId": "08985fedd9ea2cf6b28996",
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
"timestamp": 1660801715431
}
}

Check execution status of an Order list.

For execution status of individual orders, use order.status.

Weight: 4

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
origClientOrderIdSTRINGNOQuery order list by listClientOrderId. orderListId or origClientOrderId must be provided.
orderListIdINTNOQuery order list by orderListId. orderListId or origClientOrderId must be provided.
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Notes:

  • origClientOrderId refers to listClientOrderId of the order list itself.

  • If both origClientOrderId and orderListId parameters are specified, only origClientOrderId is used and orderListId is ignored.

Response:

{
"id": "b53fd5ff-82c7-4a04-bd64-5f9dc42c2100",
"status": 200,
"result": {
"orderListId": 1274512,
"contingencyType": "OCO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "08985fedd9ea2cf6b28996",
"transactionTime": 1660801713793,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 12569138901,
"clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
},
{
"symbol": "BTCUSDT",
"orderId": 12569138902,
"clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
}
]
},
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 4
}
]
}

Current open Order lists (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "openOrderLists.status",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query execution status of all open order lists.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

Weight: 6

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory -> Database

Response:

{
"id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6",
"status": 200,
"result": [
{
"orderListId": 0,
"contingencyType": "OCO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "08985fedd9ea2cf6b28996",
"transactionTime": 1660801713793,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 4,
"clientOrderId": "CUhLgTXnX5n2c0gWiLpV4d"
},
{
"symbol": "BTCUSDT",
"orderId": 5,
"clientOrderId": "1ZqG7bBuYwaF4SU8CwnwHm"
}
]
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 6
}
]
}

Account order list history (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "allOrderLists",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query information about all your order lists, filtered by time range.

Weight: 20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
fromIdINTNOOrder list ID to begin at
startTimeLONGNOTimestamp in ms
endTimeLONGNOTimestamp in ms
limitINTNODefault: 500; Maximum: 1000
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Notes:

  • If startTime and/or endTime are specified, fromId is ignored. Order lists are filtered by transactionTime of the last order list execution status update.
  • If fromId is specified, return order lists with order list ID >= fromId.
  • If no condition is specified, the most recent order lists are returned.
  • The time between startTime and endTime can't be longer than 24 hours.

Response:

{
"id": "8617b7b3-1b3d-4dec-94cd-eefd929b8ceb",
"status": 200,
"result": [
{
"orderListId": 1274512,
"contingencyType": "OCO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "08985fedd9ea2cf6b28996",
"transactionTime": 1660801713793,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 12569138901,
"clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
},
{
"symbol": "BTCUSDT",
"orderId": 12569138902,
"clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
}
]
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Account trade history (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "myTrades",
"params": {
"symbol": "BNBUSDT",
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query information about all your trades, filtered by time range.

Weight:

ConditionWeight
Without orderId20
With orderId5

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
orderIdLONGNOThis can only be used in combination with symbol.
startTimeLONGNOTimestamp in ms
endTimeLONGNOTimestamp in ms
fromIdINTNOFirst trade ID to query
limitINTNODefault: 500; Maximum: 1000
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory => Database

Notes:

  • If fromId is specified, return trades with trade ID >= fromId.
  • If startTime and/or endTime are specified, trades are filtered by execution time (time).
  • fromId cannot be used together with startTime and endTime.
  • If orderId is specified, only trades related to that order are returned.
  • startTime and endTime cannot be used together with orderId.
  • If no condition is specified, the most recent trades are returned.
  • The time between startTime and endTime can't be longer than 24 hours.

Response:

{
"id": "f4ce6a53-a29d-4f70-823b-4ab59391d6e8",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"id": 1650422481,
"orderId": 12569099453,
"orderListId": -1,
"price": "23416.10000000",
"qty": "0.00635000",
"quoteQty": "148.69223500",
"commission": "0.00000000",
"commissionAsset": "BNB",
"time": 1660801715793,
"isBuyer": false,
"isMaker": true,
"isBestMatch": true
},
{
"symbol": "BTCUSDT",
"id": 1650422482,
"orderId": 12569099453,
"orderListId": -1,
"price": "23416.50000000",
"qty": "0.00212000",
"quoteQty": "49.64298000",
"commission": "0.00000000",
"commissionAsset": "BNB",
"time": 1660801715793,
"isBuyer": false,
"isMaker": true,
"isBestMatch": true
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Unfilled Order Count (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "account.rateLimits.orders",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Query your current unfilled order count for all intervals.

Weight: 40

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory

Response:

{
"id": "d3783d8d-f8d1-4d2c-b8a0-b7596af5a664",
"status": 200,
"result": [
{
"rateLimitType": "ORDERS",
"interval": "SECOND",
"intervalNum": 10,
"limit": 50,
"count": 0
},
{
"rateLimitType": "ORDERS",
"interval": "DAY",
"intervalNum": 1,
"limit": 160000,
"count": 0
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 40
}
]
}

Account prevented matches (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "myPreventedMatches",
"params": {
"symbol": "BTCUSDT",
"orderId": 35,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
"timestamp": 1660801715431
}
}

Displays the list of orders that were expired due to STP.

These are the combinations supported:

  • symbol + preventedMatchId
  • symbol + orderId
  • symbol + orderId + fromPreventedMatchId (limit will default to 500)
  • symbol + orderId + fromPreventedMatchId + limit

Weight:

CaseWeight
If symbol is invalid2
Querying by preventedMatchId2
Querying by orderId20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
preventedMatchIdLONGNOPrevented match ID
orderIdLONGNOOrder ID
fromPreventedMatchIdLONGNOPrevented match ID to begin at
limitINTNODefault: 500; Maximum: 1000
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Response:

{
"id": "g4ce6a53-a39d-4f71-823b-4ab5r391d6y8",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"preventedMatchId": 1,
"takerOrderId": 5,
"makerSymbol": "BTCUSDT",
"makerOrderId": 3,
"tradeGroupId": 1,
"selfTradePreventionMode": "EXPIRE_MAKER",
"price": "1.100000",
"makerPreventedQuantity": "1.300000",
"transactTime": 1669101687094
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Account allocations (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "myAllocations",
"params": {
"symbol": "BTCUSDT",
"orderId": 500,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
"timestamp": 1660801715431
}
}

Retrieves allocations resulting from SOR order placement.

Weight: 20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
startTimeLONGNOTimestamp in ms
endTimeLONGNOTimestamp in ms
fromAllocationIdINTNOAllocation ID to begin at
limitINTNODefault: 500; Maximum: 1000
orderIdLONGNOOrder ID
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGNOUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Supported parameter combinations:

ParametersResponse
symbolallocations from oldest to newest
symbol + startTimeoldest allocations since startTime
symbol + endTimenewest allocations until endTime
symbol + startTime + endTimeallocations within the time range
symbol + fromAllocationIdallocations by allocation ID
symbol + orderIdallocations related to an order starting with oldest
symbol + orderId + fromAllocationIdallocations related to an order by allocation ID

Note: The time between startTime and endTime can't be longer than 24 hours.

Response:

{
"id": "g4ce6a53-a39d-4f71-823b-4ab5r391d6y8",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"allocationId": 0,
"allocationType": "SOR",
"orderId": 500,
"orderListId": -1,
"price": "1.00000000",
"qty": "0.10000000",
"quoteQty": "0.10000000",
"commission": "0.00000000",
"commissionAsset": "BTC",
"time": 1687319487614,
"isBuyer": false,
"isMaker": false,
"isAllocator": false
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Account Commission Rates (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "account.commission",
"params": {
"symbol": "BNBUSDT",
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Get current account commission rates.

Weight: 20

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Response:

{
"id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
"status": 200,
"result": {
"symbol": "BTCUSDT",
// Standard commission rates on trades from the order.
"standardCommission": {
"maker": "0.00000010",
"taker": "0.00000020",
"buyer": "0.00000030",
"seller": "0.00000040"
},
// Special commission rates from the order.
"specialCommission": {
"maker": "0.01000000",
"taker": "0.02000000",
"buyer": "0.03000000",
"seller": "0.04000000"
},
// Tax commission rates on trades from the order.
"taxCommission": {
"maker": "0.00000112",
"taker": "0.00000114",
"buyer": "0.00000118",
"seller": "0.00000116"
},
// Discount on standard commissions when paying in BNB.
"discount": {
"enabledForAccount": true,
"enabledForSymbol": true,
"discountAsset": "BNB",
"discount": "0.75000000" // Multiplier applied to the standard commission when paying commission in BNB (e.g. 0.75 = 75% of the standard commission is charged).
}
},
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 20
}
]
}

Query Order Amendments (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "order.amendments",
"params": {
"symbol": "BNBUSDT",
"orderId": 1,
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Queries all amendments of a single order.

Weight: 4

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
orderIdLONGYESOrder ID
fromExecutionIdLONGNOExecution ID to begin at
limitLONGNODefault: 500; Maximum: 1000
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Database

Response:

{
"id": "6f5ebe91-01d9-43ac-be99-57cf062e0e30",
"status": 200,
"result": [
{
"symbol": "BTCUSDT",
"orderId": 23,
"executionId": 60,
"origClientOrderId": "my_pending_order",
"newClientOrderId": "xbxXh5SSwaHS7oUEOCI88B",
"origQty": "7.00000000",
"newQty": "5.00000000",
"time": 1741924229819
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 4
}
]
}

Query Relevant Filters (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "myFilters",
"params": {
"symbol": "BNBUSDT",
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

Retrieves the list of filters relevant to an account on a given symbol. This is the only method that shows if an account has MAX_ASSET filters applied to it.

Weight: 40

Parameters:

NameTypeMandatoryDescription
apiKeySTRINGYES
symbolSTRINGYES
recvWindowDECIMALNOMaximum: 60000.
Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
timestampLONGYESUnix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client
time and is validated by the server for signed endpoints.
signatureSTRINGYES

Data Source: Memory

Response:

{
"id": "1758009606869",
"status": 200,
"result": {
"exchangeFilters": [
{
"filterType": "EXCHANGE_MAX_NUM_ORDERS",
"maxNumOrders": 1000
}
],
"symbolFilters": [
{
"filterType": "PRICE_FILTER",
"minPrice": "0.00000100",
"maxPrice": "100000.00000000",
"tickSize": "0.00000100"
}
],
"assetFilters": [
{
"filterType": "MAX_ASSET",
"limit": "1000000.00000000",
"asset": "JPY"
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalNum": 1,
"limit": 6000,
"count": 40
}
]
}
}