/compute/ladder-flows

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

POST /compute/ladder-flows

Compute projected cash flows from a cash ladder, a bond ladder or both. The result contains individual flows and a monthly report.

JSON request body

• cashLadder (conditionally required) — identifier of a cash ladder.
• bondLadder (conditionally required) — identifier of a bond ladder.
• valueDate (optional) — earliest calculation date in YYYY-MM-DD format; defaults to the current date.

At least one of cashLadder or bondLadder is required. If both are supplied, their flows are combined.

Example request

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

{
  "cashLadder": "MyCashLadder",
  "valueDate": "2026-01-01"
}

Example response — 200

{
  "flows": {
    "name": "Ladder Flows",
    "description": "MyCashLadder flows as of 2026-01-01.",
    "columns": ["instrumentId", "type", "paymentDate", "amount", "currency"],
    "columnTypes": {
      "amount": "Decimal"
    },
    "rows": [
      {
        "instrumentId": "Aldermore-Sep28",
        "type": "Interest",
        "paymentDate": "2026-03-01",
        "amount": "210",
        "currency": "GBP"
      }
    ]
  },
  "monthlyReport": {
    "name": "Ladder Flows",
    "description": "MyCashLadder 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"
      }
    ]
  }
}

Cash-ladder flow types are Interest, CompoundInterest and Principal. Bond-ladder flows use Coupon and Principal. instrumentId contains the ladder account alias for cash deposits and the bourse symbol for bonds.

The composite response is JSON. CSV output is not supported for this endpoint.

GET /compute/ladder-flows

GET uses the same operation parameters in the query string.

Query parameters

• cashLadder (conditionally required)
• bondLadder (conditionally required)
• valueDate (optional)

Example request

GET /compute/ladder-flows?cashLadder=MyCashLadder&valueDate=2026-01-01

The response has the same shape as the POST response.

← Back to API