Mode analysis (with body)
POST/v1/data/lending/mode/analysis
Evaluate all mode-switching options for a user sub-account.
Input: POST a UserDataForSubAccount object (the same shape returned by /user-positions per sub-account).
Output: For each available mode on the specified lender/chain, returns:
- healthFactor — the hypothetical health factor if the user switches to that mode (
nullif no debt) - supportedAssets — which marketUids are eligible as collateral or for borrowing in that mode
- canSwitch — whether the switch is safe (health factor > 1 and no incompatible debt)
Mode categories are cached server-side (1 hour TTL). Market configs are cached (3 minute TTL).
The "mode" terminology is the protocol-agnostic generalization of Aave V3's "e-mode" (efficiency mode); other lenders expose analogous category mechanisms.
Plain-text reference — POST /v1/data/lending/mode/analysis
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
lender | query | string | yes | Protocol identifier See the LenderId schema for the full set of accepted values. |
chain | query | string | yes | Chain ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | no | |
health | number | no | |
borrowCapacityUSD | number | no | |
balanceData | object | yes | Balance data for the sub-account. collateral and adjustedDebt are required for health factor calculation. |
balanceData.collateral | number | yes | |
balanceData.adjustedDebt | number | yes | |
balanceData.deposits | number | no | |
balanceData.debt | number | no | |
balanceData.borrowDiscountedCollateral | number | no | |
balanceData.nav | number | no | |
aprData | object | no | |
positions | object[] | yes | |
positions[].marketUid | string | no | Market identifier, formatted lender:chainId:address. |
positions[].depositsUSD | number | no | |
positions[].debtUSD | number | no | |
positions[].debtStableUSD | number | no | |
positions[].collateralEnabled | boolean | no | |
userConfig | object | yes | |
userConfig.selectedMode | string | yes | Current mode/config key |
userConfig.id | string | no | |
userConfig.isWhitelisted | boolean | no |
Response 200
| Field | Type | Description |
|---|---|---|
success | True | |
data | object | Informational payload. null when the endpoint only builds calldata. |
actions | null |
Example response
{
"success": true,
"data": {}
}
Request
Responses
- 200
- 400
- 429
- 500
- 502
Mode analysis results
Validation error
Rate limited. Unauthenticated callers share a per-IP budget; send an x-api-key header to lift it. Retry with exponential backoff.
Unexpected server error. Safe to retry with backoff.
An upstream data source or protocol origin failed (error.code is ORIGIN_FAILED). error.details carries the per-origin status. This is also what a missing or malformed required parameter currently returns, rather than a 400.