API Reference

Get Instrument Cashflows

post
https://api.harmoney.in/api/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

Request schema for cashflows endpoint.

Quantity/face value amount for cashflow calculation. Defaults to instrument's par value if not provided. Cannot be used together with 'quantity'.

Number of units traded. If provided, quantum is calculated as quantity * par_value. Cannot be used together with 'quantum'.

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

TerminationType | null

Termination type for pricing (maturity, call, put). Defaults: call for callable, maturity for standard, put for puttable.

Optional call date to use for call termination calculations.

Optional put date to use for put termination calculations.

≥ 0

Current benchmark rate for floating/reset rate bonds. Used to calculate future coupon rates as (benchmark_rate + spread).

Responses

Updated 6 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago