v1

latestOpenAPI 3.1.02026-07-24124141.8 KB

instruments

Get Instrument Cashflows

Get cashflows for a debt instrument.

Returns calculated cashflows with database overrides applied. If as_of_date is provided, returns only future cashflows (transaction_date >= as_of_date). If as_of_date is None, returns all cashflows since inception.

post/api/instrument/{instrument_id}/cashflows

Path parameters

instrument_idinteger required

Request body

as_of_datestring date nullable

Date to calculate cashflows from. If not provided, returns all cashflows since inception

termination_type'maturity' | 'call' | 'put'

Termination type exposed via datafeed APIs.

call_datestring date nullable

Optional call date to use for call termination calculations.

put_datestring date nullable

Optional put date to use for put termination calculations.

Response

Successful Response

transaction_datestring date required

The transaction/payment date of the cashflow

record_datestring date required

The record date of the cashflow (entitlement cutoff)

transaction_typestring required

Type of cashflow (Coupon Payment, Principal Payment, etc.)

cashflowstring required

Cashflow amount

interest_daysinteger nullable

Number of interest days for coupon payments