/holdings/ladders

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

GET /holdings/ladders

List all cash-ladder identifiers, or read one cash ladder by supplying cashLadder.

Query parameters

  • cashLadder (optional) — cash-ladder identifier to read. Omit it to list the available identifiers.

Example request — list ladders

GET /holdings/ladders

Example response — 200

{
  "name": "Ladder",
  "description": "",
  "columns": ["ladder"],
  "columnTypes": {},
  "rows": [
    {"ladder": "MyCashLadder"},
    {"ladder": "MyUSDCashLadder"}
  ]
}

Example request — read a ladder

GET /holdings/ladders?cashLadder=MyCashLadder

Example response — 200

{
  "name": "MyCashLadder",
  "description": "",
  "columns": [
    "ladder",
    "accountAlias",
    "type",
    "description",
    "principal",
    "couponRate",
    "startDate",
    "maturityDate",
    "frequency",
    "daycount",
    "pmtCalendar",
    "pmtConvention",
    "currency",
    "comments"
  ],
  "columnTypes": {
    "principal": "Decimal",
    "couponRate": "Decimal"
  },
  "rows": [
    {
      "ladder": "MyCashLadder",
      "accountAlias": "Aldermore-Sep28",
      "type": "Income",
      "description": "Aldermore fixed deposit",
      "principal": "10000",
      "couponRate": "0.042",
      "startDate": "2025-09-01",
      "maturityDate": "2028-09-01",
      "frequency": "6M",
      "daycount": "ACT/365F",
      "pmtCalendar": "LON",
      "pmtConvention": "ModFollowing",
      "currency": "GBP",
      "comments": "Ladder rung 1"
    }
  ]
}

To receive either response as CSV, send Accept: text/csv.

POST /holdings/ladders

POST performs the same read operation with parameters in a JSON request body. It does not append or replace a ladder.

POST /holdings/ladders
Content-Type: application/json
{
  "cashLadder": "MyCashLadder"
}

The response has the same shape as the corresponding GET response. This endpoint supports cash-ladder listing and reading; it does not expose append, replace or delete operations.

Further reading

← Back to API