/api/v1/portfolio
The organization's portfolio summary and trailing six-month repayment series.
- Scope
portfolio:read- Rate limit
- 200 requests / min
- Idempotency
- read-only
Authentication
Send your key as Authorization: Bearer …. It must carry the scope portfolio:read; a key without it receives 403 forbidden.
Request body
This operation takes no request body.
Response
200application/jsonSerializedPortfoliototal_originatednumberrequiredWhole dollars: the original principal of every loan, summed.
total_outstandingnumberrequiredWhole dollars.
total_collectednumberrequiredWhole dollars.
active_loansnumberrequiredavg_interest_ratenumberrequiredA percentage: 11.8 means 11.8 %.
avg_term_monthsnumberrequireddefault_ratenumberrequiredA percentage.
delinquency_ratenumberrequiredA percentage.
portfolio_yieldnullrequirednullableALWAYS NULL: no value is ever published here. Never estimated, never zero-filled. The platform does not compute a portfolio yield and never publishes an estimate.
30_day_delinquencynullrequirednullableALWAYS NULL: no value is ever published here. Never estimated, never zero-filled. The platform does not compute a 30-day delinquency figure and never publishes an estimate.
60_day_delinquencynullrequirednullableALWAYS NULL: no value is ever published here. Never estimated, never zero-filled. The platform does not compute a 60-day delinquency figure and never publishes an estimate.
monthlySerializedPortfolioMonth[]requiredTrailing six calendar months, oldest first. Whole dollars.
Errors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
401unauthorized403forbidden429rate_limit_exceeded500internal_error