v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

FPSL Program

List FPSL Loans

Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by date, account_number, and symbol. Each entry represents a loan of a symbol on a given date, made on behalf of the specified account_number.

get/v1/fpsl/loans

Query parameters

account_idstring uuid

The account identifier

startstring date

Filter loans after or on this start date.

endstring date

Filter loans before this end date.

page_tokenstring

The pagination token used to continue retrieving results. This value is returned in certain responses when additional data is available, typically due to a response size limit.

limitinteger

The maximum number of data points to return in the response page.

Response

Returns a list of FPSL loans for the account, or an empty list if no loans are found.

next_page_tokenstring nullable required

The token to use to retrieve the next page of results. If null, there are no more pages.

Example response

{
  "loans": [
    {
      "account_id": "06d83e79-5bea-4ce9-a362-a25251a700ec",
      "account_number": "286873545",
      "collateral": 1161.015,
      "correspondent": "LPCA",
      "date": "2006-01-02",
      "interest": {
        "customer": 1.23,
        "partner": 1.65
      },
      "market_value": 1138.25,
      "quantity": 5,
      "symbol": "AAPL",
      "updated_at": "2025-03-21T15:54:19.857034+01:00"
    }
  ]
}