Skip to main content
POST
Retrieve upcoming events for a tradable.

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 at most one accessible market-data environment selected by name or identifier.

Tradable and pricing-date selection used to request its next event types.

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

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

tradable_id
string | null

Tradable identifier whose next event types are requested.

pricing_date
string<date-time>

Date from which the next trade events are evaluated.

Response

Returns upcoming events or an unsuccessful payload with errors.

Response envelope for the next trade-event types of the selected tradable.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetNextTradeEventsResponse, 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.

next_trade_events
enum<string>[] | null

Event types that occur next for the tradable when the request succeeds.

Trade-lifecycle events that can drive contract or position effects.

Available options:
Buy,
CouponPayment,
DividendExDate,
DivPassThrough,
Exercise,
Expire,
EarlyExercise,
Fixing,
Maturity,
NotionalExchange,
Payment,
Reset,
Termination,
Settlement,
Fixings
pricing_date
string<date-time>

Pricing date used to evaluate the next events when the request succeeds.