Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
FPSL Program

Read FPSL Loans Analytics for an Account

Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for "earned so far this month" customer UIs and for supervisory spot-checks against your internal accrual model.

The {account_id} path parameter accepts a account UUID (aggregation for that account).

get/v1/fpsl/analytics/{account_id}/loans

Path parameters

account_idstring uuid required

The account identifier (account UUID).

Query parameters

startstring date

Filter loans after or on this start date (inclusive). Defaults to the first day of the current month, New York timezone.

endstring date

Filter loans before this end date (exclusive). Defaults to the day after the current date, New York timezone.

Response

Returns the aggregated FPSL loan analytics for the account.

account_numberstring required

Account's number at Alpaca

in_progress_lending_activitiesinteger required

The number of FPSL lending activities currently in progress for the account.

total_lending_activitiesinteger required

The total number of FPSL lending activities for the account within the specified date range.

Example response

{
  "account_number": "286873545",
  "in_progress_lending_activities": 2,
  "interest": {
    "customer": 1.23,
    "partner": 1.65
  },
  "total_lending_activities": 7
}