Skip to main content
POST
/
api
/
v1
/
agency_cashflows
US agency cashflow data
curl --request POST \
  --url https://terrapinfinance.com/api/v1/agency_cashflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isins": [
    "US3134H1HN66"
  ]
}
'
{
  "data": [
    {
      "cashflows": [
        {
          "amount": 2.75,
          "date": "2024-04-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2024-10-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2025-04-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2025-10-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2026-04-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2026-10-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2027-04-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2027-10-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2028-04-20",
          "type": "interest"
        },
        {
          "amount": 2.75,
          "date": "2028-10-20",
          "type": "interest"
        },
        {
          "amount": 100,
          "date": "2028-10-20",
          "type": "principal"
        }
      ],
      "isin": "US3134H1HN66"
    }
  ],
  "total": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.terrapinfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
isins
string[]
required

International Securities Identification Number (ISIN), unique 12-character code for the security.

Required string length: 12

Response

Cashflow data

​
data
object[]
required

List of response data objects, often capped to 1000.

​
total
integer
required

Total number of results in the database that match the query filters.