Documentation

Yield

yield

Domain types

EthereumVaultDetailsInput = { vault_id }

Input for fetching vault details.

EthereumVaultDetailsResponse = { id, asset_address, available_liquidity_usd, 6 more... }

Detailed vault information including current APY and liquidity.

EthereumVaultPosition = { asset, assets_in_vault, shares_in_vault, 2 more... }

A user's position in a DeFi vault.

EthereumVaultResponse = { id, asset_address, caip2, 4 more... }

A vault configuration for yield features.

EthereumYieldClaimIDInput = { id }

Input for fetching a yield reward claim by ID.

EthereumYieldClaimInput = { caip2 }

Input for claiming incentive rewards from vault participation.

EthereumYieldClaimResponse = { id, caip2, created_at, 3 more... }

Response from a yield reward claim operation.

EthereumYieldClaimReward = { amount, token_address, token_symbol }

A single reward token claimed from vault participation.

EthereumYieldDepositInput = { asset_amount, vault_id }

Input for depositing assets into an ERC-4626 vault.

EthereumYieldPositionResponse = { asset, assets_in_vault, shares_in_vault, 2 more... }

A user's position in a yield vault.

EthereumYieldPositionsInput = { vault_id }

Input for fetching yield positions.

EthereumYieldProvider = "morpho" | "aave"

Supported yield/lending protocol providers.

EthereumYieldSweepIDInput = { id }

Input for fetching a yield sweep by ID.

EthereumYieldSweepResponse = { id, asset_amount, created_at, 6 more... }

A yield sweep record representing a deposit or withdrawal.

EthereumYieldSweepStatus = "pending" | "confirmed" | "failed"

Status of a yield sweep.

EthereumYieldSweepType = "deposit" | "withdraw"

Type of yield sweep.

EthereumYieldWithdrawInput = { asset_amount, vault_id }

Input for withdrawing assets from an ERC-4626 vault.

EvmCaip2ChainID = string

An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).