NautilusTrader
ConceptsEvents
These docs track the unreleased nightly build and may change without notice. Switch to the latest stable docs.

OrderReleased

OrderReleased represents an order having been released from the OrderEmulator. The ExecutionEngine applies it to the order, updates the Cache, and publishes it on the MessageBus. It fires when the emulator's trigger price condition is met and the order is released to the venue.

Transition: EMULATED -> RELEASED. Handler: on_order_released.

Fields

Beyond the common order event fields, OrderReleased carries:

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

On this event, venue_order_id and account_id are both None, reconciliation is always False, and ts_event equals ts_init.

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