Yield Farming

get_yield_farming_active_positions

Example Request
Example Response
{
  "clientAddress": "0xF4614C8C45beF5700e491E627aeecd4d5aabac61"
}
{
  "clientAddress": "0xF4614C8C45beF5700e491E627aeecd4d5aabac61",
  "positions": [
     {
       "farmPositionId": "farm_493201",
       "depositTxnHash": "0x839ddcf5813dc45b44fdff5bafb882f248f26f881eef5805e25031cad8f14f9e",
       "protocol": "Pendle",
       "chain": "Base",
       "poolName": "USDC-ETH Yield Pool",
       "poolAddress": "0x6cb9a013604a567a5834fadd411165b1ca616783",
       "assetDeposited": ["USDC", "ETH"],
       "usdDepositedValue": 5000.0,
       "lpTokenAmount": 120.45,
       "apy": 18.6,
       "rewardTokens": ["PENDLE"],
       "usdAccruedRewards": 86.25,
       "usdUnclaimedRewards": 32.10,
       "lockupPeriodDays": 30,
       "isLocked": true,
       "positionStatus": "active",
       "openedAt": "2025-01-10T09:30:00Z"
     }
  ],
  "lastUpdatedAt": "2025-01-15T10:40:00Z"
}

get_yield_farming_historical_positions

Example Request
Example Response
{
  "clientAddress": "0xF4614C8C45beF5700e491E627aeecd4d5aabac61"
}
{
  "clientAddress": "0xF4614C8C45beF5700e491E627aeecd4d5aabac61",
  "positions": [
     {
       "farmPositionId": "farm_482119",
       "depositTxnHash": "0x839ddcf5813dc45b44fdff5bafb882f248f26f881eef5805e25031cad8f14f9e",
       "withdrawalTxnHash": "0x19761fea995ffb52a346fb1e4979331da456bd334c60980829c3b54f9498faea",
       "protocol": "Pendle",
       "chain": "Base",
       "poolName": "Pendle Staking Pool",
       "poolAddress": "0x6cb9a013604a567a5834fadd411165b1ca616783",
       "assetDeposited": ["USDC"],
       "usdDepositedValue": 3000.0,
       "usdTotalRewardsEarned": 245.8,
       "apy": 22.4,
       "rewardTokens": ["USDC"],
       "exitReason": "manual_withdraw",
       "openedAt": "2024-12-01T14:10:00Z",
       "closedAt": "2025-01-05T08:22:00Z"
     }
  ]
}

is_yield_farm_available

Example Request
Example Response
{
  "protocol": "Pendle",
  "chain": "Base",
  "poolName": "USDC-ETH Yield Pool"
}
// IF AVAILABLE
{
  "protocol": "Pendle",
  "chain": "Base",
  "poolName": "USDC-ETH Yield Pool",
  "poolAddress": "0x6cb9a013604a567a5834fadd411165b1ca616783",
  "isAvailable": true,
  "estimatedApy": 18.6,
  "minDepositUsd": 100,
  "lockupPeriodDays": 30,
  "checkedAt": "2025-01-14T11:05:44Z"
}

// IF NOT AVAILABLE
{
  "protocol": "Pendle",
  "chain": "Base",
  "poolName": "USDC-ETH Yield Pool",
  "poolAddress": "0x6cb9a013604a567a5834fadd411165b1ca616783",
  "isAvailable": false,
  "reasonCode": "POOL_PAUSED",
  "checkedAt": "2025-01-14T11:05:44Z"
}

Last updated