NautilusTrader
ConceptsEvents

Nightly docs

These docs track unreleased changes and may change without notice. Their code examples can use APIs that the latest release lacks, so run them with a development wheel or switch to the latest release docs.

OrderPendingCancel

OrderPendingCancel records that the system has sent a CancelOrder request to the trading venue and awaits acknowledgement. The ExecutionEngine applies it to the order, updates the Cache, and publishes it on the MessageBus.

Typical transition: ACCEPTED -> PENDING_CANCEL. Handler: on_order_pending_cancel.

Fields

Beyond the common Python order event fields, OrderPendingCancel carries:

FieldPython typeRequired/defaultDescription
venue_order_idVenueOrderId or NoneNoneThe venue-assigned order identifier, if known.
account_idAccountId or NoneRequiredThe account associated with the order, if known.
reconciliationboolRequiredIf generated during reconciliation.

Example

Reading the event in a strategy handler:

def on_order_pending_cancel(self, event: OrderPendingCancel) -> None:
    self.log.info(f"Cancel pending for {event.client_order_id}")
  • Events - Event categories, dispatch, and the common order event fields.
  • Orders - Order types and the state machine.

On this page