Before implementing yield features in your application, you’ll need to retrieve essential information such as APY rates, minimum deposit requirements, and other terms. This guide explains how to fetch this data using our API endpoints.
In the yield category, we encompass various passive income-generating activities in DeFi. This includes lending (where users earn interest by providing liquidity), investing in yield-generating vaults (which automatically compound returns), and staking (where users lock tokens to earn rewards).
Two Integration Approaches
A) Protocol-Specific Approach (Explicit)
Use this when you want to work with a specific yield protocol.
Get Available Protocols
First, retrieve the list of all supported protocols: Query Protocol Details
Then, fetch specific protocol information using:Required Parameters:| Parameter | Description | Example |
|---|
| :id | Strategy ID | 679044af61866a32dd2d39e9 |
GET /strategies/679044af61866a32dd2d39e9
- Current APY rate (
apy)
- Total value locked (
tvl)
- Asset details (
asset.symbol, asset.contract, asset.decimals)
- Protocol fee (
fee)
- Pause status (
paused)
Example Response:
{
"_id": "679044af61866a32dd2d39e9",
"name": "Aave DAI Lending",
"slug": "aave-dai-polygon",
"protocol": "Aave",
"network": "polygon",
"asset": {
"symbol": "DAI",
"contract": "0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063",
"decimals": 18
},
"apy": 4.17,
"tvl": "52000000",
"paused": false,
"fee": "10"
}
B) Protocol-Agnostic Approach (Less Explicit)
Let our system automatically select the optimal protocol for your needs.
Use the Generic Endpoint:
Our system will analyze your requirements and return the best protocol option based on:
- Highest APY rates
- Additional reward incentives
- Current market conditions
- Protocol reliability
UI Integration Example
Example UI implementation showing protocol selection
Next Steps
