Skip to main content
Use this endpoint before lending against a pledge of vault shares. It scans the specified accounts for MPT escrows holding this vault’s share token, then values each pledge at both the naive NAV (what AssetsTotal alone reports) and the correct NAV (net of declared loss). Pass your own haircut to receive the maximum lendable amount directly — the haircut always applies to the honest value, never to the reported one.

​
Parameters

​
string
required
64-character hex object ID of the Vault ledger entry. Case insensitive.
​
string
Comma-separated XRPL addresses to scan for escrows. These are added to the default set (the service’s watched accounts plus the vault owner), not a replacement for it.
​
number
The lender’s own discount in percent, applied to navCorrect. Defaults to 0. Echoed per pledge as haircutPct.

​
Request

​
Response

​
Response Fields

​
string
48-character hex MPT issuance ID of the vault’s share token. All escrows in pledges hold this token.
​
string
Per-unit value computed as assetsTotal / sharesOutstanding. What a tool reading only AssetsTotal would report.
​
string
Per-unit value computed as (assetsTotal - lossUnrealized) / sharesOutstanding. The recoverable value.
​
number
Number of distinct escrow objects found across all scanned accounts.
​
string
Total share units held across all pledges, in drops.
​
string
Total value of all pledges at navNaive, in drops.
​
string
Total value of all pledges at navCorrect, in drops.
​
string
Aggregate overstatement: totalValueNaive - totalValueCorrect, in drops.
​
string
Overstatement as a percentage of totalValueNaive, to two decimal places.
​
array
One entry per escrow found. Empty when no pledges are standing.
The haircut applies to the correct NAV, never to the reported one:Vlendable=u⋅NAVheld⋅(1−h)V_{\text{lendable}} = u \cdot \text{NAV}_{\text{held}} \cdot (1 - h)Marking a pledge at valueNaive and then applying a 20% haircut leaves you believing you are 20% over-collateralised when you may in fact be short. A haircut absorbs volatility; it does not absorb a misstatement. Use maxLendable directly — it applies your haircut to valueCorrect for you.
Vault shares are MPTs, and XLS-85 TokenEscrow accepts MPT amounts, so a pledge can sit on the ledger where anyone can read it. What does not exist is a reverse index from an MPT issuance ID to the escrows holding it. A lender must supply the accounts to scan. An Escrow appears in the owner directory of both the pledgor and the beneficiary under the same object index, so you can enumerate pledges in your favour from your own account — and the API deduplicates by escrow index so one pledge is never counted twice.