Skip to main content
POST
Get cash flows

Authorizations

Authorization
string
header
required

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

Body

If both provider selectors are omitted or empty, the request uses the organization's market-data provider. Access to the selected provider is required.

$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. Supply this name or provider_id, not both.

provider_id
string | null

Opaque market-data provider identifier. Supply this identifier or market_data_environment_name, not both.

contracts
object[] | null
start_date
string<date-time>
end_date
string<date-time>
mkt_data_date
string<date-time>
pricing_date
string<date-time>
include_projected
boolean

Response

Success

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetCashFlowsResponse, Derivitec.Web.Core
is_success
boolean
error_messages
string[] | null
cash_flows
object[] | null