/compute/bond-ladder-flows

Base URL https://api.babylon.app/v1

POST `/compute/bond-ladder-flows`

Compute future coupon and principal flows from settled bond positions.

JSON request body

bondLadder (required) — bond-ladder identifier.
valueDate (optional) — earliest payment date in YYYY-MM-DD format; defaults to the current date.
reportCurrency (optional) — accepted by the service contract, but the current calculation does not convert the returned amounts.

Example request

POST /compute/bond-ladder-flows
Content-Type: application/json

{
  "bondLadder": "MyGBBondLadder",
  "valueDate": "2026-01-01"
}

Example response — 200

{
  "flows": {
    "name": "Bond Flows",
    "description": "",
    "columns": ["bourseSymbol", "type", "amount", "currency", "paymentDate", "coupon", "quantity", "exDividendDate"],
    "columnTypes": {
      "amount": "Decimal",
      "coupon": "Decimal",
      "quantity": "Decimal"
    },
    "rows": [
      {
        "bourseSymbol": "LSE:TN28",
        "type": "Coupon",
        "amount": "105.40",
        "currency": "GBP",
        "paymentDate": "2026-06-07",
        "coupon": "0.0425",
        "quantity": "2480",
        "exDividendDate": "2026-05-28"
      }
    ]
  },
  "monthlyReport": {
    "name": "Bond Flows",
    "description": "MyGBBondLadder flows as of 2026-01-01, aggregated by month in GBP.",
    "columns": ["monthIndex", "monthYear", "label", "amount", "currency"],
    "columnTypes": {},
    "rows": [
      {"monthIndex": 0, "monthYear": "2026-01-01", "label": "Jan 26", "amount": 0.0, "currency": "GBP"}
    ]
  }
}

Flow types are Coupon and Principal. The composite response is JSON; CSV output is not supported.

GET `/compute/bond-ladder-flows`

GET supplies the same operation parameters in the query string.

GET /compute/bond-ladder-flows?bondLadder=MyGBBondLadder&valueDate=2026-01-01

The response has the same shape as the POST response.

← Back to API