Skip to main content
POST
Retrieve cash flows for contracts.

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 Contracts, StartDate, EndDate, PricingDate, MktDataDate, optional IncludeProjected, and at most one accessible market-data environment. Date ordering is not explicitly constrained.

Contracts, valuation dates, and date interval used to retrieve contract cash flows.

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

contracts
object[] | null

Cash-flow-capable contracts whose cash flows are requested.

Polymorphic contract role for instruments capable of producing cash flows.

start_date
string<date-time>

Lower date bound of the requested cash-flow interval; inclusivity is not defined here.

end_date
string<date-time>

Upper date bound of the requested cash-flow interval; inclusivity is not defined here.

mkt_data_date
string<date-time>

Date of market data used to derive the cash flows.

pricing_date
string<date-time>

Date on which the contracts are evaluated for cash-flow generation.

include_projected
boolean

Whether projected cash flows are included; defaults to true.

Response

Returns contract cash flows and errors.

Cash-flow collections returned for the requested contracts.

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

cash_flows
object[] | null

Requested contracts paired with their returned cash-flow collections.