@compass-labs/api-sdk 2.2.95 → 2.2.97-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/chain.d.ts +1 -0
- package/dist/commonjs/models/components/chain.d.ts.map +1 -1
- package/dist/commonjs/models/components/chain.js +1 -0
- package/dist/commonjs/models/components/chain.js.map +1 -1
- package/dist/commonjs/models/components/chainmarketinfo.d.ts +5 -1
- package/dist/commonjs/models/components/chainmarketinfo.d.ts.map +1 -1
- package/dist/commonjs/models/components/chainmarketinfo.js +2 -0
- package/dist/commonjs/models/components/chainmarketinfo.js.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +5 -0
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +5 -0
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/commonjs/models/components/loopedpositioncurrentstate.d.ts +25 -3
- package/dist/commonjs/models/components/loopedpositioncurrentstate.d.ts.map +1 -1
- package/dist/commonjs/models/components/loopedpositioncurrentstate.js +8 -0
- package/dist/commonjs/models/components/loopedpositioncurrentstate.js.map +1 -1
- package/dist/commonjs/models/components/marketdetail.d.ts +5 -0
- package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
- package/dist/commonjs/models/components/marketdetail.js.map +1 -1
- package/dist/commonjs/models/components/morpholendingmarket.d.ts +8 -0
- package/dist/commonjs/models/components/morpholendingmarket.d.ts.map +1 -1
- package/dist/commonjs/models/components/morpholendingmarket.js +4 -0
- package/dist/commonjs/models/components/morpholendingmarket.js.map +1 -1
- package/dist/commonjs/models/components/reserveinfo.d.ts +5 -1
- package/dist/commonjs/models/components/reserveinfo.d.ts.map +1 -1
- package/dist/commonjs/models/components/reserveinfo.js +2 -0
- package/dist/commonjs/models/components/reserveinfo.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetclass.d.ts +11 -0
- package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetclass.js +6 -0
- package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
- package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
- package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
- package/dist/commonjs/models/operations/v2earnswapquote.d.ts +1 -0
- package/dist/commonjs/models/operations/v2earnswapquote.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2earnswapquote.js +1 -0
- package/dist/commonjs/models/operations/v2earnswapquote.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetspositions.d.ts +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetspositions.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetspositions.js +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetspositions.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/chain.d.ts +1 -0
- package/dist/esm/models/components/chain.d.ts.map +1 -1
- package/dist/esm/models/components/chain.js +1 -0
- package/dist/esm/models/components/chain.js.map +1 -1
- package/dist/esm/models/components/chainmarketinfo.d.ts +5 -1
- package/dist/esm/models/components/chainmarketinfo.d.ts.map +1 -1
- package/dist/esm/models/components/chainmarketinfo.js +2 -0
- package/dist/esm/models/components/chainmarketinfo.js.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +5 -0
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +5 -0
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/esm/models/components/loopedpositioncurrentstate.d.ts +25 -3
- package/dist/esm/models/components/loopedpositioncurrentstate.d.ts.map +1 -1
- package/dist/esm/models/components/loopedpositioncurrentstate.js +8 -0
- package/dist/esm/models/components/loopedpositioncurrentstate.js.map +1 -1
- package/dist/esm/models/components/marketdetail.d.ts +5 -0
- package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
- package/dist/esm/models/components/marketdetail.js.map +1 -1
- package/dist/esm/models/components/morpholendingmarket.d.ts +8 -0
- package/dist/esm/models/components/morpholendingmarket.d.ts.map +1 -1
- package/dist/esm/models/components/morpholendingmarket.js +4 -0
- package/dist/esm/models/components/morpholendingmarket.js.map +1 -1
- package/dist/esm/models/components/reserveinfo.d.ts +5 -1
- package/dist/esm/models/components/reserveinfo.d.ts.map +1 -1
- package/dist/esm/models/components/reserveinfo.js +2 -0
- package/dist/esm/models/components/reserveinfo.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetclass.d.ts +11 -0
- package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetclass.js +6 -0
- package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
- package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
- package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
- package/dist/esm/models/operations/v2earnswapquote.d.ts +1 -0
- package/dist/esm/models/operations/v2earnswapquote.d.ts.map +1 -1
- package/dist/esm/models/operations/v2earnswapquote.js +1 -0
- package/dist/esm/models/operations/v2earnswapquote.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsbalances.js +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsbalances.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetspositions.d.ts +1 -0
- package/dist/esm/models/operations/v2tokenizedassetspositions.d.ts.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetspositions.js +1 -0
- package/dist/esm/models/operations/v2tokenizedassetspositions.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.js +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.js.map +1 -1
- package/docs/models/components/chain.md +2 -2
- package/docs/models/components/chainmarketinfo.md +15 -14
- package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +23 -23
- package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
- package/docs/models/components/loopedpositioncurrentstate.md +17 -13
- package/docs/models/components/marketdetail.md +34 -34
- package/docs/models/components/morpholendingmarket.md +23 -21
- package/docs/models/components/reserveinfo.md +14 -13
- package/docs/models/components/tokenizedassetclass.md +6 -1
- package/docs/models/components/tokenizedassetprovider.md +2 -2
- package/docs/models/operations/v2earnswapquotechain.md +1 -1
- package/docs/models/operations/v2tokenizedassetsbalanceschain.md +1 -1
- package/docs/models/operations/v2tokenizedassetsmarketssymbolchain.md +1 -1
- package/docs/models/operations/v2tokenizedassetspositionschain.md +2 -2
- package/docs/models/operations/v2tokenizedassetsredemptionschain.md +1 -1
- package/examples/node_modules/tsx/dist/cjs/api/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/cjs/api/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/cjs/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/cjs/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/cli.cjs +3 -3
- package/examples/node_modules/tsx/dist/cli.mjs +3 -3
- package/examples/node_modules/tsx/dist/esm/api/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/esm/api/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/esm/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/esm/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/index-CVGQLgGk.mjs +14 -0
- package/examples/node_modules/tsx/dist/index-LWEOpzQe.cjs +14 -0
- package/examples/node_modules/tsx/dist/loader.cjs +1 -1
- package/examples/node_modules/tsx/dist/loader.mjs +1 -1
- package/examples/node_modules/tsx/dist/package-BPDo_TJ6.mjs +1 -0
- package/examples/node_modules/tsx/dist/package-D8zHkzom.cjs +1 -0
- package/examples/node_modules/tsx/dist/preflight.cjs +1 -1
- package/examples/node_modules/tsx/dist/preflight.mjs +1 -1
- package/examples/node_modules/tsx/dist/register-Bu1t3CsJ.mjs +2 -0
- package/examples/node_modules/tsx/dist/register-CRHZwkwo.cjs +10 -0
- package/examples/node_modules/tsx/dist/register-D3Z1kaw7.cjs +2 -0
- package/examples/node_modules/tsx/dist/register-DjEWBuYC.mjs +10 -0
- package/examples/node_modules/tsx/dist/repl.cjs +1 -1
- package/examples/node_modules/tsx/dist/repl.mjs +1 -1
- package/examples/node_modules/tsx/dist/{require-C7ivLNeu.cjs → require-BomokLx3.cjs} +1 -1
- package/examples/node_modules/tsx/dist/{require-awuW45Q3.mjs → require-DLrt45w5.mjs} +1 -1
- package/examples/node_modules/tsx/package.json +1 -1
- package/examples/package-lock.json +3 -3
- package/openapi_prepped_for_speakeasy.json +118 -14
- package/package.json +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/components/chain.ts +1 -0
- package/src/models/components/chainmarketinfo.ts +7 -1
- package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +5 -0
- package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +5 -0
- package/src/models/components/loopedpositioncurrentstate.ts +33 -3
- package/src/models/components/marketdetail.ts +5 -0
- package/src/models/components/morpholendingmarket.ts +12 -0
- package/src/models/components/reserveinfo.ts +7 -1
- package/src/models/components/tokenizedassetclass.ts +11 -0
- package/src/models/components/tokenizedassetprovider.ts +1 -0
- package/src/models/operations/v2earnswapquote.ts +1 -0
- package/src/models/operations/v2tokenizedassetsbalances.ts +1 -0
- package/src/models/operations/v2tokenizedassetsmarketssymbol.ts +1 -0
- package/src/models/operations/v2tokenizedassetspositions.ts +1 -0
- package/src/models/operations/v2tokenizedassetsredemptions.ts +1 -0
- package/examples/node_modules/tsx/dist/index-BN2t1Mfo.cjs +0 -14
- package/examples/node_modules/tsx/dist/index-CQhDiIsg.mjs +0 -14
- package/examples/node_modules/tsx/dist/package-CiRlP2hu.mjs +0 -1
- package/examples/node_modules/tsx/dist/package-DYbiKo1t.cjs +0 -1
- package/examples/node_modules/tsx/dist/register-BoI6-WNn.cjs +0 -10
- package/examples/node_modules/tsx/dist/register-DlUHyDDv.cjs +0 -2
- package/examples/node_modules/tsx/dist/register-HWZIKnmC.mjs +0 -10
- package/examples/node_modules/tsx/dist/register-zZ7SWseA.mjs +0 -2
|
@@ -21,18 +21,18 @@ let value:
|
|
|
21
21
|
|
|
22
22
|
## Fields
|
|
23
23
|
|
|
24
|
-
| Field
|
|
25
|
-
|
|
|
26
|
-
| `symbol`
|
|
27
|
-
| `underlyingTicker`
|
|
28
|
-
| `name`
|
|
29
|
-
| `contractAddress`
|
|
30
|
-
| `decimals`
|
|
31
|
-
| `balance`
|
|
32
|
-
| `currentPriceUsd`
|
|
33
|
-
| `balanceUsd`
|
|
34
|
-
| `provider`
|
|
35
|
-
| `assetClass`
|
|
36
|
-
| `chain`
|
|
37
|
-
| `pnl`
|
|
38
|
-
| `events`
|
|
24
|
+
| Field | Type | Required | Description | Example |
|
|
25
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `symbol` | *string* | :heavy_check_mark: | On-chain Ondo symbol (e.g. `TSLAon`). | |
|
|
27
|
+
| `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker. | |
|
|
28
|
+
| `name` | *string* | :heavy_check_mark: | Underlying equity name (or ticker fallback). | |
|
|
29
|
+
| `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address. | |
|
|
30
|
+
| `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals. | |
|
|
31
|
+
| `balance` | *string* | :heavy_check_mark: | Human-readable balance (already scaled by `decimals`). | |
|
|
32
|
+
| `currentPriceUsd` | *string* | :heavy_minus_sign: | USD spot price at read time (decimal string). | |
|
|
33
|
+
| `balanceUsd` | *string* | :heavy_minus_sign: | `balance * current_price_usd` when the price is available. | |
|
|
34
|
+
| `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_minus_sign: | Issuer/provider of a tokenized asset. | |
|
|
35
|
+
| `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_minus_sign: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and<br/>`DERWA` trade via the swap-based `transact/buy` and `transact/sell`<br/>endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell<br/>is an *asynchronous* redemption request settled off-chain by the vault<br/>operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles<br/>each buy/sell as a single instant DEX swap.<br/><br/>`MONEY_MARKET` (WisdomTree Connect digital funds) also uses `transact/buy`<br/>and `transact/sell`, but neither swaps nor mints: a buy transfers the<br/>settlement stablecoin to the issuer's deposit address and the issuer mints<br/>fund shares back at the next NAV cycle, so settlement is *asynchronous*. | |
|
|
36
|
+
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_minus_sign: | The chain to use. | |
|
|
37
|
+
| `pnl` | [components.TokenizedAssetsPnl](../../models/components/tokenizedassetspnl.md) | :heavy_minus_sign: | Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis). | |
|
|
38
|
+
| `events` | [components.TokenizedAssetsActivityEvent](../../models/components/tokenizedassetsactivityevent.md)[] | :heavy_minus_sign: | Chronological activity for this position (buy / sell / transfer_in / transfer_out). Pure-USDC funding is excluded — it appears on the balances endpoint. | [] |
|
|
@@ -16,16 +16,20 @@ let value: LoopedPositionCurrentState = {
|
|
|
16
16
|
|
|
17
17
|
## Fields
|
|
18
18
|
|
|
19
|
-
| Field
|
|
20
|
-
|
|
|
21
|
-
| `collateralAmount`
|
|
22
|
-
| `debtAmount`
|
|
23
|
-
| `collateralUsd`
|
|
24
|
-
| `debtUsd`
|
|
25
|
-
| `netUsdValue`
|
|
26
|
-
| `leverage`
|
|
27
|
-
| `healthFactor`
|
|
28
|
-
| `healthFactorScope`
|
|
29
|
-
| `collateralApy`
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
19
|
+
| Field | Type | Required | Description |
|
|
20
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| `collateralAmount` | *string* | :heavy_check_mark: | Current on-chain collateral amount for this position. When multiple open Aave positions share one collateral reserve (Aave holds a single pooled aToken balance per reserve), that pooled balance is attributed across them pro-rata by each position's event-ledger contribution — bookkeeping, not protocol truth; liquidation sees the pooled account, not this per-position split. |
|
|
22
|
+
| `debtAmount` | *string* | :heavy_check_mark: | Current on-chain debt amount for this position. |
|
|
23
|
+
| `collateralUsd` | *string* | :heavy_minus_sign: | Collateral value in USD (null if unpriced). Derived from the attributed collateral_amount for shared-reserve Aave positions. |
|
|
24
|
+
| `debtUsd` | *string* | :heavy_minus_sign: | Debt value in USD (null if unpriced). |
|
|
25
|
+
| `netUsdValue` | *string* | :heavy_minus_sign: | Net position value in USD (collateral - debt); null if unpriced. For shared-reserve Aave positions the collateral side uses the pro-rata attributed balance (bookkeeping, not protocol truth). |
|
|
26
|
+
| `leverage` | *string* | :heavy_minus_sign: | Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive. For shared-reserve Aave positions this is derived from the pro-rata attributed collateral (bookkeeping, not protocol truth). |
|
|
27
|
+
| `healthFactor` | *string* | :heavy_minus_sign: | Health factor. Above 1 is safe; below 1 risks liquidation. See health_factor_scope for what it covers. |
|
|
28
|
+
| `healthFactorScope` | [components.LoopedPositionCurrentStateHealthFactorScope](../../models/components/loopedpositioncurrentstatehealthfactorscope.md) | :heavy_check_mark: | 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures. |
|
|
29
|
+
| `collateralApy` | *string* | :heavy_minus_sign: | What the collateral leg currently earns, in percentage (e.g. 6.12 = 6.12%) — the sum of collateral_lending_apy and collateral_intrinsic_apy where both apply. Null when the token earns a yield outside the lending pool (a staked or wrapped asset) and no source for that yield is available: the pool's supply APY alone would understate the leg by percentage points and can invert the sign of net_apy, so it is withheld rather than reported as the whole yield. |
|
|
30
|
+
| `collateralLendingApy` | *string* | :heavy_minus_sign: | The supply half of the collateral leg, in percentage: interest paid by borrowers of the collateral asset (Aave supply APY). Near zero for staked assets, which almost nobody borrows. Exactly 0 on Morpho, whose collateral is held rather than lent — which is why a Morpho position's whole collateral leg is its vault yield. |
|
|
31
|
+
| `collateralIntrinsicApy` | *string* | :heavy_minus_sign: | The yield the collateral token earns inside its own price, in percentage, independent of the lending pool — a liquid-staking token's staking rewards (wstHYPE against HYPE) or an ERC-4626 share's vault yield — which of the two follows from the position's protocol. Null when the token has none or none is indexed.<br/><br/>A TRAILING 7-DAY measurement, not a forward rate: a week is a short sample of a staking rate, so consecutive readings move around the longer-run average by a few tenths of a percent.<br/><br/>A null here alongside a null collateral_apy and a NON-null collateral_lending_apy is the meaningful case: the token does earn outside the pool, but no source for that yield is available, so the total is withheld rather than understated. |
|
|
32
|
+
| `borrowApy` | *string* | :heavy_minus_sign: | What the debt leg currently costs, in percentage — the sum of borrow_lending_apy and borrow_intrinsic_apy where both apply. Debt owed in a token that appreciates inside its own price (a staked or wrapped asset) grows by that appreciation on top of the pool's interest, so the pool rate alone would understate the cost and overstate net_apy; for such a token with no yield source available this is null (withheld) rather than the pool rate. For ordinary debt assets it equals the market's spot borrow APY. Null also when the rate read was unavailable. |
|
|
33
|
+
| `borrowLendingApy` | *string* | :heavy_minus_sign: | The pool half of the debt leg, in percentage: the market's spot borrow APY (Morpho IRM rate / Aave variable borrow rate) — interest charged on the debt by the lending market itself. |
|
|
34
|
+
| `borrowIntrinsicApy` | *string* | :heavy_minus_sign: | The yield the DEBT token earns inside its own price, in percentage — which the borrower owes on top of pool interest, since the debt is denominated in an appreciating token. Same source and trailing 7-day window as collateral_intrinsic_apy. Null when the token has none or none is indexed; null alongside a null borrow_apy and a NON-null borrow_lending_apy means the debt token does earn outside the pool but no source is available, so the total cost is withheld rather than understated. |
|
|
35
|
+
| `netApy` | *string* | :heavy_minus_sign: | Levered net yield on the position's equity, in percentage: leverage x collateral_apy - (leverage - 1) x borrow_apy. Negative means the carry is upside down (borrowing costs more than the collateral earns). Null when leverage or either leg is unknown. This is a SNAPSHOT at today's rates, not a forecast, and it mixes a trailing collateral measurement with a spot borrow rate. It is also denominated in the debt asset, not USD: a wstHYPE/WHYPE loop earning a positive net_apy still loses USD value if HYPE falls. The borrow leg floats with the debt reserve's utilisation, so this figure can move without the position changing at all. |
|