Skip to main content
POST
Preview a trade event's position effects.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request with non-empty TradableId, PricingDate as a caller-time-zone calendar date, and non-null NextTradeEvent.

Selected tradable, pricing date, and next event used to request resulting position effects.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetTradeEventPositionEffectsRequest, Derivitec.Web.Core
tradable_id
string | null

Tradable identifier to which the event applies.

pricing_date
string<date-time>

Date at which the trade event is evaluated.

next_trade_event
object

Base representation of a trade-lifecycle event supplied to event-driven position-effect requests.

Response

Returns the projected position effects or errors.

Response envelope for the position effects of the selected tradable event.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetTradeEventPositionEffectsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

position_effects
object[] | null

Contract-and-quantity effects produced by the event when the request succeeds.

pricing_date
string<date-time>

Pricing date at which the position effects were evaluated when the request succeeds.