UpshiftReportedAPY

Documentation for eth_defi.erc_4626.vault_protocol.upshift.offchain_metadata.UpshiftReportedAPY Python class.

class UpshiftReportedAPY

Bases: TypedDict

Current APY breakdown reported by Upshift.

Example response: {"apy": 0.1, "underlying_apy": 0.0, "rewards_compounded": 0.0}.

Attributes summary

underlying_apy	Underlying strategy APY.
rewards_compounded	APY from compounded rewards.
liquid_apy	Liquid reward APY.
id	Report UUID.
updated_at	Report update timestamp.
tokenized_vault_id	Parent vault UUID.
apy	Total reported APY.
rewards_claimable	APY from claimable rewards.
explainer	Optional APY methodology explanation.
created_at	Report creation timestamp.

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.

underlying_apy: Optional[float]

Underlying strategy APY. Example: 0.0.

rewards_compounded: Optional[float]

APY from compounded rewards. Example: 0.0.

liquid_apy: Optional[float]

Liquid reward APY. Example: 0.0.

id: str

Report UUID. Example: "78d43044-2c0a-40dd-bbcd-043750ecc38f".

updated_at: str

Report update timestamp. Example: "2025-11-20T18:38:43.474000".

tokenized_vault_id: str

Parent vault UUID. Example: "672db4d8-72cd-46cb-bde3-746d1dd973a8".

apy: Optional[float]

Total reported APY. Example: 0.1 for 10%.

rewards_claimable: Optional[float]

APY from claimable rewards. Example: 0.0.

explainer: Optional[str]

Optional APY methodology explanation. Example: "".

created_at: str

Report creation timestamp. Example: "2025-11-20T18:38:43.474000".

__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.