UpshiftVaultAPIResponse
Documentation for eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftVaultAPIResponse Python class.
- class UpshiftVaultAPIResponse
Bases:
TypedDictComplete raw response from Upshift’s tokenized-vault endpoint.
All 61 documented top-level fields were observed in the live response for NEMO USDC Prime on 2026-07-23. Nested structures are modelled by the associated
Upshift*TypedDicts above.Reference:
Attributes summary
Vault deployment address.
Optional yield-distributor address.
EVM chain ID.
Vault strategy description.
Upshift implementation family.
Marketplace product category.
Whether Upshift highlights the vault.
Whether Upshift displays the vault publicly.
Weekly performance fee in basis points.
Optional platform-fee override.
Vault creation timestamp.
Upshift display name.
Target reserve amount.
Allowed reserve variation.
Withdrawal-alert threshold.
Withdrawal-alert channel selection.
Vault lifecycle status.
Whether fee charging requires a manual action.
Receipt-token symbol.
Whether external asset updates are enabled.
Whether the vault wraps distributor fees.
Vault logo URL.
Risk label set by Upshift.
Maximum daily drawdown fraction.
Chain family.
Historical APY windows in days.
Whether Upshift spotlights the vault.
Whether Upshift shows a filled-cap indicator.
Whether only withdrawals are currently enabled.
Historical simple APY keyed by horizon days.
Default APY horizon in days.
Management-fee waiver expiry timestamp.
Management-fee waiver TVL threshold.
Performance-fee waiver expiry timestamp.
Performance-fee waiver TVL threshold.
NAV base-token metadata identifier.
Token pricing overrides keyed by
TokenSpec-*.Optional APY display overrides.
Largest historical drawdown fraction.
Latest reported TVL in USD.
Campaign APY override.
Metrics calculation timestamp.
Upshift vault UUID.
Solana-specific metadata.
Stellar-specific metadata.
Optional instant-redemption configuration.
App visibility mode.
Reward programmes.
Current APY breakdown.
Receipt-token integration metadata.
Strategy brands.
External composability integrations.
API cache timestamp.
Historical NAV snapshots.
Vault custody subaccounts.
Named EOA operator wallets.
Historical compounded APY keyed by horizon days.
Current reported TVL in USD.
Return per share keyed by horizon days.
Daily return per share keyed by timestamp.
Contract operators.
Methods summary
__init__(*args, **kwargs)clear()Remove all items from the dict.
copy()Return a shallow copy of the dict.
fromkeys([value])Create a new dictionary with keys from iterable and values set to value.
get(key[, default])Return the value for key if key is in the dictionary, else default.
items()Return a set-like object providing a view on the dict's items.
keys()Return a set-like object providing a view on the dict's keys.
pop(k[,d])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()Return an object providing a view on the dict's values.
- address: str
Vault deployment address. Example:
"0x955256B31097dDf47a9E47A95aDfDFB4460D8522".
- yield_distributor: Optional[str]
Optional yield-distributor address. Example:
None.
- chain: int
EVM chain ID. Example:
1for Ethereum mainnet.
- description: Optional[str]
Vault strategy description. Example:
"NEMO USDC Prime is an automated, multi-strategy...".
- internal_type: str
Upshift implementation family. Example:
"multiAssetVault".
- public_type: Optional[str]
Marketplace product category. Example:
"DeFi Yield".
- is_featured: bool
Whether Upshift highlights the vault. Example:
False.
- is_visible: Optional[bool]
Whether Upshift displays the vault publicly. Example:
True.
- weekly_performance_fee_bps: Optional[float]
Weekly performance fee in basis points. Example:
20.0.
- platform_fee_override: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftPlatformFeeOverride]
Optional platform-fee override. Example:
{"management_fee": 0, "is_fee_waived": False}.
- start_datetime: Optional[str]
Vault creation timestamp. Example:
"2026-06-25T10:19:00".
- vault_name: Optional[str]
Upshift display name. Example:
"NEMO USDC Prime".
- reserve_target: Optional[float]
Target reserve amount. Example:
0.0.
- reserve_tolerance: Optional[float]
Allowed reserve variation. Example:
0.0.
- withdrawal_alert_threshold: Optional[float]
Withdrawal-alert threshold. Example:
None.
- withdrawal_alert_channels: Optional[str]
Withdrawal-alert channel selection. Example:
"both".
- status: str
Vault lifecycle status. Example:
"active".
- is_charge_fees_manual: bool
Whether fee charging requires a manual action. Example:
False.
- receipt_token_symbol: Optional[str]
Receipt-token symbol. Example:
"NEMO USDC Yield".
- enable_external_assets_update: bool
Whether external asset updates are enabled. Example:
False.
- is_distributor_fee_wrapper: bool
Whether the vault wraps distributor fees. Example:
False.
- vault_logo_url: Optional[str]
Vault logo URL. Example:
"https://imagedelivery.net/.../nemoicon-light.svg/public".
- risk: Optional[str]
Risk label set by Upshift. Example:
None.
- max_daily_drawdown: Optional[float]
Maximum daily drawdown fraction. Example:
None.
- chain_type: str
Chain family. Example:
"evm".
- is_spotlighted: bool
Whether Upshift spotlights the vault. Example:
False.
- show_cap_filled: bool
Whether Upshift shows a filled-cap indicator. Example:
False.
- withdrawal_only: bool
Whether only withdrawals are currently enabled. Example:
False.
- historical_apy: dict[str, float]
Historical simple APY keyed by horizon days. Example:
{"7": 0.31189842638050264}.
- default_apy_horizon: Optional[int]
Default APY horizon in days. Example:
7.
- management_fee_waived_until_date: Optional[str]
Management-fee waiver expiry timestamp. Example:
None.
- management_fee_waived_until_tvl: Optional[float]
Management-fee waiver TVL threshold. Example:
None.
- performance_fee_waived_until_date: Optional[str]
Performance-fee waiver expiry timestamp. Example:
None.
- performance_fee_waived_until_tvl: Optional[float]
Performance-fee waiver TVL threshold. Example:
None.
- nav_base_asset_token_id: Optional[str]
NAV base-token metadata identifier. Example:
None.
- nav_pricing_overrides: Optional[dict[str, eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftNAVPricingOverride]]
Token pricing overrides keyed by
TokenSpec-*. Example:{"TokenSpec-1-0xA0b8...": {"mode": "hardpeg", "value": 1}}.
- apy_override: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftAPYOverride]
Optional APY display overrides. Example:
{"hardcoded_apy": 0.12, "is_show_hardcoded_apy": True}.
- max_drawdown: Optional[float]
Largest historical drawdown fraction. Example:
0.0002156861650454448.
- latest_reported_tvl: Optional[float]
Latest reported TVL in USD. Example:
3591665.1170049477.
- campaign_apy: Optional[float]
Campaign APY override. Example:
None.
- metrics_last_updated: Optional[str]
Metrics calculation timestamp. Example:
"2026-07-23T17:01:41.120995".
- id: str
Upshift vault UUID. Example:
"58c28ee6-aff6-49e0-9291-625f9f82e90f".
- solana_vault_metadata: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftSolanaVaultMetadata]
Solana-specific metadata. Example:
Nonefor an EVM vault.
- stellar_vault_metadata: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftStellarVaultMetadata]
Stellar-specific metadata. Example:
Nonefor an EVM vault.
- instant_redeem_config: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftInstantRedeemConfig]
Optional instant-redemption configuration. Example:
None.
- view_type: Optional[str]
App visibility mode. Example:
"all".
- rewards: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftReward]
Reward programmes. Example: one
{"text": "Upshift Points", "multiplier": 5.0}record.
- reported_apy: Optional[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftReportedAPY]
Current APY breakdown. Example:
None.
- receipt_token_integrations: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftReceiptTokenIntegration]
Receipt-token integration metadata. Example:
[].
- hardcoded_strategists: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftStrategist]
Strategy brands. Example: one
{"strategist_name": "NEMO"}record.
- composability_integrations: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftComposabilityIntegration]
External composability integrations. Example:
[].
- cached_at: Optional[str]
API cache timestamp. Example:
None.
- historical_snapshots: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftHistoricalSnapshot]
Historical NAV snapshots. Example: one
{"block_id": 25396895, "tvl": 0.0}record.
- subaccounts: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftSubaccount]
Vault custody subaccounts. Example:
[].
- eoa_operators: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftEOAOperator]
Named EOA operator wallets. Example: one
{"name": "NEMO USDC Yield Sub 1"}record.
- historical_compound_apy: dict[str, float]
Historical compounded APY keyed by horizon days. Example:
{"7": 0.3647473251285198}.
- tvl: Optional[float]
Current reported TVL in USD. Example:
3591665.1170049477.
- pnl_per_share: dict[str, float]
Return per share keyed by horizon days. Example:
{"7": 0.005170042919987905}.
- daily_pnl_per_share: dict[str, float]
Daily return per share keyed by timestamp. Example:
{"2026-07-23T00:00:00": 0.0008179999999999854}.
- operators: list[eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftOperator]
Contract operators. Example: one
{"operator_type": "eoa"}record.
- __init__(*args, **kwargs)
- __new__(**kwargs)
- clear()
Remove all items from the dict.
- copy()
Return a shallow copy of the dict.
- fromkeys(value=None, /)
Create a new dictionary with keys from iterable and values set to value.
- get(key, default=None, /)
Return the value for key if key is in the dictionary, else default.
- items()
Return a set-like object providing a view on the dict’s items.
- keys()
Return a set-like object providing a view on the dict’s keys.
- pop(k[, d]) v, remove specified key and return the corresponding value.
If the key is not found, return the default if given; otherwise, raise a KeyError.
- popitem()
Remove and return a (key, value) pair as a 2-tuple.
Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.
- setdefault(key, default=None, /)
Insert key with a value of default if key is not in the dictionary.
Return the value for key if key is in the dictionary, else default.
- update([E, ]**F) None. Update D from mapping/iterable E and F.
If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values()
Return an object providing a view on the dict’s values.