Skip to main content
POST
Retrieve dated coupons for a bond definition.

Authorizations

Authorization
string
header
required

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

Body

The polymorphic public Bond contract, supplied MktData container, calendar-date StartDate/EndDate, and at most one provider selector; concrete Bond JSON shapes are not enumerated here.

Bond, market data, and date interval used to request dated coupon values.

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

bond
object

Polymorphic contract role for bonds that can produce cash flows.

mkt_data
object

Serializable collection of the market data required by a valuation request.

start_date
string<date-time>

Lower date bound of the requested coupon map; inclusivity is not defined here.

end_date
string<date-time>

Upper date bound of the requested coupon map; inclusivity is not defined here.

Response

Returns date/coupon pairs with any contract or market-data validation errors.

Dated coupon values returned for the requested bond and interval.

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

date_coupon_map
object[] | null

Date-and-coupon entries returned for the bond.