Current Open Option Orders (USER_DATA)
Query all of the caller's open option orders, including the remaining quantity of partially filled orders. Stock orders are not included.
Current Open Option Orders (USER_DATA) › Authorization
Current Open Option Orders (USER_DATA) › 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
timestampTimestamp in milliseconds.
recvWindowThe value cannot be greater than 60000.
Current Open Option Orders (USER_DATA) › Responses
Current Open Option Orders
orderIdOption order ID.
clientOrderIdClient order ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
positionIntentPosition intent: BUY_TO_OPEN / SELL_TO_CLOSE / SELL_TO_OPEN / BUY_TO_CLOSE.
quoteAssetQuote asset.
sideBUY / SELL.
orderTypeOrder type: LIMIT; MARKET for orders placed by the broker's automatic liquidation on the expiration date.
limitPriceLimit price (premium per share).
qtyOrder quantity (contracts).
filledQtyCumulative filled quantity (contracts).
filledNotionalCumulative filled amount.
totalCostAmount locked from the wallet when the order was placed (a snapshot, not updated after fills or cancellation): premium plus fees for buy-to-open and for buy-to-close of a covered call; for buy-to-close of a cash-secured put, only the shortfall remaining after the released collateral (usually 0); the collateral for sell-to-open (number of shares for a covered call, cash for a cash-secured put); 0 for sell-to-close. Not returned for broker automatic liquidation orders.
filledPercentFill progress percentage (0–100).
statusOrder status: NEW / PENDING_NEW / ACCEPTED / PARTIALLY_FILLED / PENDING_CANCEL / PENDING_REPLACE.
createdAtCreation time (ms).
updatedAtLast update time (ms).
Option Order History (USER_DATA)
Paged option order history, sorted by creation time in descending order. Only option orders are returned; stock orders are not included.
Option Order History (USER_DATA) › Authorization
Option Order History (USER_DATA) › 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
startTimeStart of the order creation time (createdAt) filter (ms). If the span to endTime exceeds 180 days, it is truncated to 180 days before endTime.
endTimeEnd of the order creation time (createdAt) filter (ms).
timestampTimestamp in milliseconds.
underlyingSymbolUnderlying US-equity ticker filter, e.g. NVDA, case-insensitive. Matches orders on all contracts of that underlying, not a single OCC contract. An unlisted or delisted ticker returns -26004.
sideBUY / SELL.
orderStatusComma-separated status filter, without spaces: FILLED / PARTIALLY_FILLED / CANCELED / EXPIRED / REJECTED. If omitted, all statuses are returned except open orders with no fills (NEW / ACCEPTED, etc.).
currentPage number. Default 1.
sizePage size. Default 20, max 100.
recvWindowThe value cannot be greater than 60000.
Option Order History (USER_DATA) › Responses
Option Order History
totalTotal number of records.
pageCurrent page number.
sizeCurrent page size.
Order records.
orderIdOption order ID.
clientOrderIdClient order ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
positionIntentPosition intent: BUY_TO_OPEN / SELL_TO_CLOSE / SELL_TO_OPEN / BUY_TO_CLOSE.
autoLiquidationtrue if the order was initiated by the broker's automatic liquidation rather than by the user.
quoteQuote asset (named quoteAsset in Current Open Option Orders).
sideBUY / SELL.
orderTypeOrder type: LIMIT; MARKET for orders placed by the broker's automatic liquidation on the expiration date.
limitPriceLimit price (premium per share). Returned as reported by the broker regardless of order type; not returned for MARKET orders, which have no limit price.
avgFilledPriceAverage fill price (premium per share) as reported by the broker, returned for all order types. Not returned if the order has no fills.
qtyOrder quantity (contracts).
filledQtyCumulative filled quantity (contracts).
filledTotalCumulative filled amount.
feeCumulative fees = commission + sec + taf + cat + orf + occ (excluding platformFee). Fees are returned at the order level only; individual fills carry no fee.
statusOrder status, e.g. FILLED / PARTIALLY_FILLED / CANCELED / EXPIRED / REJECTED.
createdAtCreation time (ms).
updatedAtLast update time (ms).
Option Order Detail (USER_DATA)
Query a single option order with its fills and an itemized fee breakdown.
Provide at least one of orderId and clientOrderId; omitting both returns -1102. If both are provided, the order is looked up by orderId, and clientOrderId must belong to the same order, otherwise 486218 Order not found is returned.
Only option orders are accepted: the orderId / clientOrderId of a stock order returns -2013 Order does not exist.; an unknown order ID returns 486218 Order not found.
Example: a fully filled buy-to-open order — filledTotal = total = 1.48 × 1 × 100 = 148 (excluding fees); total fees fee = 0.65 (commission + cat + orf + occ). sec / taf are 0 for buy orders. For an order still in progress with no fills, fee and the itemized fees are not returned (platformFee is always "0"); for an order canceled or expired without any fill, each fee item is "0". canceledAt / expiredAt are returned only in the corresponding status; settlementDate is not returned for buy orders.
Option Order Detail (USER_DATA) › Authorization
Option Order Detail (USER_DATA) › 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
timestampTimestamp in milliseconds.
orderIdOption order ID. Provide at least one of orderId and clientOrderId.
clientOrderIdClient order ID. Provide at least one of orderId and clientOrderId.
recvWindowThe value cannot be greater than 60000.
Option Order Detail (USER_DATA) › Responses
Option Order Detail
orderIdOption order ID.
clientOrderIdClient order ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
positionIntentPosition intent: BUY_TO_OPEN / SELL_TO_CLOSE / SELL_TO_OPEN / BUY_TO_CLOSE.
autoLiquidationtrue if the order was initiated by the broker's automatic liquidation rather than by the user.
quoteQuote asset (named quoteAsset in Current Open Option Orders).
sideBUY / SELL.
orderTypeOrder type: LIMIT; MARKET for orders placed by the broker's automatic liquidation on the expiration date.
limitPriceLimit price (premium per share). Returned as reported by the broker regardless of order type; not returned for MARKET orders, which have no limit price.
avgFilledPriceAverage fill price (premium per share) as reported by the broker, returned for all order types. Not returned if the order has no fills.
qtyOrder quantity (contracts).
filledQtyCumulative filled quantity (contracts).
filledTotalCumulative filled amount.
feeCumulative fees = commission + sec + taf + cat + orf + occ (excluding platformFee). Fees are returned at the order level only; individual fills carry no fee.
statusOrder status, e.g. FILLED / PARTIALLY_FILLED / CANCELED / EXPIRED / REJECTED.
createdAtCreation time (ms).
updatedAtLast update time (ms).
timeInForceTime in force. Always DAY.
commissionCommission.
platformFeePlatform fee.
secSEC fee. Charged on sell orders only; 0 for buy orders.
tafFINRA TAF. Charged on sell orders only; 0 for buy orders.
catFINRA CAT fee.
orfOptions Regulatory Fee (ORF).
occOCC clearing fee.
totalCumulative filled amount, same as filledTotal (average fill price × filled quantity × multiplier), excluding fees.
filledAtFully filled time (ms).
canceledAtCancel time (ms). Returned only for canceled orders.
expiredAtExpiry time (ms). Returned only for expired orders.
settlementDateMillisecond timestamp of 14:00 ET on the settlement date. Returned only for sell orders with fills.
Fills of this order, sorted by execution time in descending order. Individual fills carry no fee; see the order-level fee and itemized fees.
executionIdExecution ID.
executionAtExecution time (ms).
priceFill price (premium per share).
qtyFill quantity (contracts).
Option Trade History (USER_DATA)
Paged per-fill option trade history. Only option fills are returned. Option fees are charged per order, so individual fills carry no fee; see fee in Option Order History / Option Order Detail.
Option Trade History (USER_DATA) › Authorization
Option Trade History (USER_DATA) › 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
startTimeStart of the execution time (executionAt) filter (ms).
endTimeEnd of the execution time (executionAt) filter (ms).
timestampTimestamp in milliseconds.
underlyingSymbolUnderlying US-equity ticker filter, e.g. NVDA, case-insensitive. Matches fills on all contracts of that underlying, not a single OCC contract. An unlisted or delisted ticker returns -26004.
sideBUY / SELL.
orderIdReturn fills of this order only.
currentPage number. Default 1.
sizePage size. Default 20, max 100.
recvWindowThe value cannot be greater than 60000.
Option Trade History (USER_DATA) › Responses
Option Trade History
totalTotal number of records.
pageCurrent page number.
sizeCurrent page size.
Fill records.
executionIdExecution ID.
orderIdOption order ID.
clientOrderIdClient order ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
positionIntentPosition intent: BUY_TO_OPEN / SELL_TO_CLOSE / SELL_TO_OPEN / BUY_TO_CLOSE.
autoLiquidationtrue if the order was initiated by the broker's automatic liquidation rather than by the user.
quoteQuote asset.
sideBUY / SELL.
orderTypeOrder type: LIMIT; MARKET for orders placed by the broker's automatic liquidation on the expiration date.
priceFill price (premium per share).
qtyFill quantity (contracts).
totalFill amount (price × qty × multiplier), excluding fees.
executionAtExecution time (ms).
updatedAtUpdate time (ms).
settlementDateMillisecond timestamp of 14:00 ET on the settlement date. Returned for sell fills only.
Option Positions (USER_DATA)
Returns all current option positions.
One record per contract; see side for the direction.
free / locked are signed: negative for short positions. For example, with 3 short contracts of which 1 is reserved by an open order, free = "-2" and locked = "-1". When closing (SELL_TO_CLOSE / BUY_TO_CLOSE), the quantity you can order is the absolute value of free.
Positions past the last trading time and awaiting settlement are not returned.
Option Positions (USER_DATA) › Authorization
Option Positions (USER_DATA) › 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
timestampTimestamp in milliseconds.
recvWindowThe value cannot be greater than 60000.
Option Positions (USER_DATA) › Responses
Option Positions
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
contractTypeCALL / PUT.
sidePosition side: LONG / SHORT.
freeContracts available to close, signed (negative for short positions).
lockedContracts reserved by open orders or submitted exercises, signed (negative for short positions).
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
Exercisable Options (USER_DATA)
Returns the contracts that can currently be exercised. Only long positions are exercisable; the short side is the assigned party and has no exercise right.
availableQty is the maximum quantity for Submit Option Exercise.
Exercisable Options (USER_DATA) › Authorization
Exercisable Options (USER_DATA) › 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
timestampTimestamp in milliseconds.
recvWindowThe value cannot be greater than 60000.
Exercisable Options (USER_DATA) › Responses
Exercisable Options
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
positionQtyTotal contracts held.
availableQtyContracts available to exercise; the upper limit for Submit Option Exercise.
What one contract delivers on exercise / assignment.
typeEQUITY (shares; symbol is the ticker and amount is the number of shares) / CASH (symbol is the currency and amount is the cash amount).
symbolTicker or currency.
amountNumber of shares or cash amount.
Option Exercise Detail (USER_DATA)
Query the result of a single exercise request. Provide at least one of tranId and clientOrderId; omitting both returns -1102. If both are provided, the lookup uses clientOrderId and tranId is ignored (the opposite of Option Order Detail).
Returns 497402 Order not found. if no record is found or the record does not belong to the caller.
errorCode is returned only when status is FAILED.
Option Exercise Detail (USER_DATA) › Authorization
Option Exercise Detail (USER_DATA) › 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
timestampTimestamp in milliseconds.
tranIdExercise transaction ID returned by Submit Option Exercise.
clientOrderIdClient ID used at submission.
recvWindowThe value cannot be greater than 60000.
Option Exercise Detail (USER_DATA) › Responses
Option Exercise Detail
tranIdExercise transaction ID.
clientOrderIdClient ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
requestedQtyRequested number of contracts.
statusPROCESSING / SUCCESS / FAILED.
requestedTimeSubmission time (ms).
updateTimeLast update time (ms).
optionEventIdSettlement event ID of the option leg; can be used with Option Settlement Event Detail.
underlyingEventIdSettlement event ID of the underlying-share leg.
multiplierPremium multiplier. Order cost = price × quantity × multiplier.
errorCodeError code on failure; one of the option business error codes in Error Code. Returned only when status is FAILED.
Option Exercise History (USER_DATA)
Paged exercise history.
Option Exercise History (USER_DATA) › Authorization
Option Exercise History (USER_DATA) › 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
timestampTimestamp in milliseconds.
statusComma-separated status filter: PROCESSING / SUCCESS / FAILED.
startTimeStart time (ms).
endTimeEnd time (ms).
currentPage number. Default 1.
sizePage size. Default 20, max 100.
recvWindowThe value cannot be greater than 60000.
Option Exercise History (USER_DATA) › Responses
Option Exercise History
totalTotal number of records.
pageCurrent page number.
sizeCurrent page size.
Exercise records.
tranIdExercise transaction ID.
clientOrderIdClient ID.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
rootSymbolOCC root symbol. Differs from underlyingSymbol for contracts adjusted by a corporate action (e.g. GOOG1).
contractTypeCALL / PUT.
strikePriceStrike price.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
requestedQtyRequested number of contracts.
statusPROCESSING / SUCCESS / FAILED.
requestedTimeSubmission time (ms).
Option Settlement Event History (USER_DATA)
Query option settlement events — the settlement outcome of a contract: exercise, assignment or expiry (expired worthless), along with the shares / cash delivered and the collateral released. Sorted by event time in descending order.
These records are on a settlement basis, separate from orders and trades.
Cursor pagination. Omit lastId on the first page, then pass the nextLastId from the previous page until hasMore is false.
Option Settlement Event History (USER_DATA) › Authorization
Option Settlement Event History (USER_DATA) › 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
timestampTimestamp in milliseconds.
underlyingSymbolUnderlying US-equity ticker filter.
symbolOCC contract symbol filter. If both symbol and underlyingSymbol are sent, symbol takes precedence.
eventTypeComma-separated event type filter: EXERCISE / ASSIGNMENT / EXPIRY, case-insensitive.
startTimeStart of the event time (eventTime) filter (ms).
endTimeEnd of the event time (eventTime) filter (ms).
lastIdCursor returned by the previous page. Omit on the first page.
sizePage size. Default 20, max 100.
recvWindowThe value cannot be greater than 60000.
Option Settlement Event History (USER_DATA) › Responses
Option Settlement Event History
Event records.
eventIdEvent ID; use it with Option Settlement Event Detail.
eventTypeEXERCISE / ASSIGNMENT / EXPIRY.
statusEvent status. Only settled events are returned, so the value is always Completed.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
contractTypeCALL / PUT.
contractsNumber of contracts, signed: positive for long, negative for short. (Option Settlement Event Detail returns the absolute value.)
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
strikePriceStrike price.
Assets actually delivered. Empty array when nothing is delivered.
typePresent on cash legs only: OPEXC (exercise cash) / OPASN (assignment cash) / OPCSH (cash settlement).
symbolTicker for the share leg, currency for the cash leg.
amountSigned amount: positive = received, negative = paid. Number of shares for the share leg.
eventTimeEvent time (ms).
hasMoreWhether there is a next page.
nextLastIdCursor for the next page.
Option Settlement Event Detail (USER_DATA)
Full detail of a single settlement event, including the settlement basis and collateral release. Returns -1102 if eventId does not exist or does not belong to the caller.
All fields of the history endpoint are included, with two differences: contracts is an absolute value, and eventTime is the time the settlement record was created.
For an EXPIRY event, settlementKind, cashDirection, amount and shareDelta are not returned. For an EXPIRY event on a short position (covered call / cash-secured put), collateralRelease lists the collateral released.
Option Settlement Event Detail (USER_DATA) › Authorization
Option Settlement Event Detail (USER_DATA) › 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
eventIdEvent ID from Option Settlement Event History.
timestampTimestamp in milliseconds.
recvWindowThe value cannot be greater than 60000.
Option Settlement Event Detail (USER_DATA) › Responses
Option Settlement Event Detail
eventIdEvent ID; use it with Option Settlement Event Detail.
eventTypeEXERCISE / ASSIGNMENT / EXPIRY.
statusEvent status. Only settled events are returned, so the value is always Completed.
symbolOCC option contract symbol.
underlyingSymbolUnderlying US-equity ticker.
contractTypeCALL / PUT.
contractsNumber of contracts, absolute value (unsigned), unlike the history endpoint.
expirationDateExpiration date as the millisecond timestamp of 12:00 ET on the expiration day. Convert in America/New_York and take the date part (see General Info).
strikePriceStrike price.
Assets actually delivered. Empty array when nothing is delivered.
typePresent on cash legs only: OPEXC (exercise cash) / OPASN (assignment cash) / OPCSH (cash settlement).
symbolTicker for the share leg, currency for the cash leg.
amountSigned amount: positive = received, negative = paid. Number of shares for the share leg.
eventTimeTime the settlement record was created (ms).
settlementKindSettlement method: PHYSICAL (physical delivery) / CASH (cash settlement) / MIXED (both). Not returned for EXPIRY events.
underlyingPriceReference price of the underlying when the event was generated, for display only; it is not used in the settlement calculation. Not returned if unavailable.
cashDirectionCash direction: DEBIT / CREDIT. Not returned for EXPIRY events.
amountNet cash amount (absolute value); see cashDirection for the direction. Not returned for EXPIRY events.
Only for EXPIRY events on short positions (covered call / cash-secured put): collateral released back to the user, e.g. the cash of a cash-secured put (strike × contracts × multiplier).
symbolAsset released.
amountAmount released.
updatedTimeLast update time (ms).