EmberVaultMetadata

Documentation for eth_defi.erc_4626.vault_protocol.ember.offchain_metadata.EmberVaultMetadata Python class.

class EmberVaultMetadata

Bases: TypedDict

Metadata about an Ember vault from offchain source.

Fetched from the Bluefin vaults API at vaults.api.sui-prod.bluefin.io. Official API spec at SwaggerHub.

• Listing endpoint: GET /api/v2/vaults?chain=ethereum

Attributes summary

name	Vault name, e.g.
long_name	Full vault name from API longName field
description	Full vault strategy description
strategy	Strategy type, e.g.
status	Vault status: active, paused, deprecated, beta
public_type	Public classification, e.g.
logo_url	Vault logo URL
management_fee	Annual management fee as fraction (e.g.
weekly_performance_fee	Weekly performance fee as fraction (e.g.
withdrawal_period_days	Withdrawal lock period in days
reported_apy	Current reported APY as fraction (e.g.
target_apy	Target APY as fraction, from reportedApy.targetApyE9
lending_apy	Lending APY component as fraction, from reportedApy.lendingApyE9
reward_apy	Reward APY component as fraction, from reportedApy.rewardApyE9
tvl_usd	Total vault TVL in USD
manager_name	Curator/manager name, e.g.
manager_url	Curator/manager website URL
manager_logo_url	Curator/manager logo URL
tags	Category tag names
total_depositors_count	Total number of depositors (all-time)
active_depositors_count	Currently active depositor count
created_at	Vault creation timestamp (Unix seconds)
rewards	Reward tokens distributed by the vault
supported_coins	Deposit asset symbols from chain-specific details

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.

name: str

Vault name, e.g. Crosschain USD Vault

long_name: Optional[str]

Full vault name from API longName field

description: Optional[str]

Full vault strategy description

strategy: Optional[str]

Strategy type, e.g. Stablecoin Strategy

status: Optional[str]

Vault status: active, paused, deprecated, beta

public_type: Optional[str]

Public classification, e.g. Defi Yield

logo_url: Optional[str]

Vault logo URL

management_fee: Optional[float]

Annual management fee as fraction (e.g. 0.02 = 2%)

weekly_performance_fee: Optional[float]

Weekly performance fee as fraction (e.g. 0.0001 = 0.01% per week)

withdrawal_period_days: Optional[int]

Withdrawal lock period in days

reported_apy: Optional[float]

Current reported APY as fraction (e.g. 0.08 = 8%)

target_apy: Optional[float]

Target APY as fraction, from reportedApy.targetApyE9

lending_apy: Optional[float]

Lending APY component as fraction, from reportedApy.lendingApyE9

reward_apy: Optional[float]

Reward APY component as fraction, from reportedApy.rewardApyE9

tvl_usd: Optional[float]

Total vault TVL in USD

manager_name: Optional[str]

Curator/manager name, e.g. Third Eye

manager_url: Optional[str]

Curator/manager website URL

manager_logo_url: Optional[str]

Curator/manager logo URL

tags: list[str]

Category tag names

total_depositors_count: Optional[int]

Total number of depositors (all-time)

active_depositors_count: Optional[int]

Currently active depositor count

created_at: Optional[int]

Vault creation timestamp (Unix seconds)

rewards: list[eth_defi.erc_4626.vault_protocol.ember.offchain_metadata.EmberRewardToken]

Reward tokens distributed by the vault

supported_coins: list[str]

Deposit asset symbols from chain-specific details

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