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.

OrderReleased

OrderReleased records that the OrderEmulator has released an order after its trigger condition was met. The emulator applies the event to the order, updates the Cache, and publishes it on the MessageBus before routing the order onward.

Typical transition: EMULATED -> RELEASED. Handler: on_order_released.

Fields

Beyond the common Python order event fields, OrderReleased carries:

FieldPython typeRequired/defaultDescription
released_pricePriceRequiredThe price which released the order from the emulator.

Example

Reading the event in a strategy handler:

def on_order_released(self, event: OrderReleased) -> None:
    self.log.info(
        f"Order {event.client_order_id} released at {event.released_price}",
    )
  • Events - Event categories, dispatch, and the common order event fields.
  • Emulated orders - The local emulation lifecycle.

On this page