Skip to main content
GET
Returns the loans behind one customer across every lending family: each loan’s principal, interest and debt, totals per asset class, and a roll-up per client. The customer record itself carries no debt figures, so this is where they are read. A loan counts when it was borrowed from the customer’s primary or linked wallets, or when it is attributed to the customer through clientReference on Open Loan. Only the external securities families carry attribution. A loan from one of the customer’s wallets that is attributed to a different customer is left out.
The debt is only as fresh as basis says. A loan whose market could not be read, or one beyond the first 60 read in a call, carries the figure the platform last recorded, without interest accrued since. totals adds amounts across markets as plain numbers, with no currency conversion.

Path Parameters

string
required
Customer ID. Wallets, reference keys and external IDs are not resolved here. Archived records are found too.

Query Parameters

string
default:"false"
Set to true to also return loans that are no longer active. totals and clients count active loans either way.
string
default:"true"
Set to false to skip the chain and return the figures last recorded. Otherwise each active loan with an on-chain loan ID is read from its market, up to 60 per call. The figures read are saved to the platform’s record. A market that cannot be read falls back to its recorded figures without failing the call.

Response Fields

object

Error Codes