Agent performance

getAgentApy

Get the agent's average APY performance over a time period.

• If agentId is omitted: retrieves APY for all agents.
• If agentId is provided: retrieves APY for the specified agent.

Requires wallet connection: No

Signature

getAgentApy(
  options: AgentsApyOptions
): Promise<OwneyAgentApy | AgentApy>

Example

const allApy = await owney.getAgentApy({ days: "30D" });

// Per-asset APY (Zyfai-aware; Sail currently returns its aggregate)
const usdcBaseApy = await owney.getAgentApy({
  days: "30D",
  tokenSymbol: "USDC",
  chainId: 8453,
});

Example Output

{
  "agentApy": {
    "zyfai": {
      "averageApy": 8.5
    },
    "sail": {
      "averageApy": 6.2,
      "detailedApys": {
        "apyPerAsset": {
          "8453": {
            "USDC": 6.5
          },
          "42161": {
            "USDT": 5.9
          }
        }
      }
    }
  }
}

Parameters

• options: AgentsApyOptions — Query options:
  • days: DailyApyDays — Lookback period. (See DailyApyDays for details).
  • agentId?: AgentId — Optional agent to query. If omitted, retrieves APY for all agents.
  • tokenSymbol?: string — Optional asset symbol (e.g. "USDC", "WETH") to scope the APY to a specific asset. Zyfai uses this; agents whose backends do not yet support per-asset APY (currently Sail) ignore it.
  • chainId?: number — Optional chain id for per-asset APY lookups. Typically paired with tokenSymbol.

Returns

• Promise<OwneyAgentApy> if agentId is omitted.
• Promise<AgentApy> if agentId is provided.

detailedApys is optional and is only returned by agents that provide a per-asset APY breakdown.

See OwneyAgentApy and AgentApy for details.