API Reference

Get Refinance Eligible Loans

Retrieve a paginated list of loans that are currently marked refinance-eligible (i.e. the stored isRefinanceEligible flag is true). The response shape, authentication, filtering, sorting, and pagination are identical to GET /api/loans — this endpoint simply pre-applies the refinance-eligibility filter on the server. Refer to GET /api/loans for the full list of supported query parameters, filter operators, and sort syntax. When no loans are currently eligible, returns 200 OK with an empty data array. Eligibility is re-evaluated by a nightly job; for real-time per-loan availability use GET /api/loans/{loanUuid}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number for pagination.

sort
array of strings

Sort fields. Prefix with + for ascending (default) or - for descending. Same sortable fields as GET /api/loans.

sort
Headers
string
enum
required
Defaults to application/vnd.totality.v1+json
Allowed:
string
required
Responses

401

Unauthenticated

500

Internal server error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json