Added
New "reason" field on Broker trade events
about 16 hours ago
Broker API
Adds the top-level reason string field to the TradeUpdateEventV2 schema on the trade events stream.
reasonis a top-level property on the trade event (not on the nestedorder) and is present only oncanceled,order_cancel_rejected,order_replace_rejected, andtrade_bustevents.- Documents the known values:
CORPORATE_ACTION(oncanceled),TOO_LATE_TO_CANCEL(onorder_cancel_rejectedandorder_replace_rejected), andTRADE_BUST(ontrade_bust). - Because free-form values may also appear,
reasonis typed as a string rather than an enum, so client parsers should tolerate unknown values. - Expands the
canceledevent description inTradeUpdateEventTypeto note that Alpaca-initiated corporate-action cancels populatereasonwithCORPORATE_ACTION.
Affected Endpoints
GET /v2/events/trades