fetch_symbiotic_offchain_vaults

Documentation for eth_defi.erc_4626.vault_protocol.symbiotic.offchain_metadata.fetch_symbiotic_offchain_vaults function.

fetch_symbiotic_offchain_vaults(*, api_base_url='https://app.symbiotic.fi/api/v3', chain_name='Ethereum', vault_type='v2')

Yield vault rows from Symbiotic’s public application data API.

The application API currently serves Ethereum mainnet. It publishes its USD TVL calculation and joins curator display names in a separate curators response, so this function retrieves both small payloads and yields a normalised reporting record for each vault.

Parameters
  • api_base_url (str) – Symbiotic application API base URL, overridable for testing.

  • chain_name (str) – Human-readable name for the chain served by api_base_url.

  • vault_type (Optional[str]) – Optional implementation category filter. The default "v2" limits results to vaults that this integration can index; use None to yield every API vault type.

Returns

Iterator yielding normalised offchain vault records.

Return type

collections.abc.Iterator[eth_defi.erc_4626.vault_protocol.symbiotic.offchain_metadata.SymbioticOffchainVault]