{"uid":"cap_icwZq4IgX1briTbke-Wl1","slug":"vaults-fyi-total-returns-for-user-vault-position-6b013036","name":"vaults.fyi Total Returns for User Vault Position","description":"Retrieves the total returns for a user's position in a specific vault, including asset details and native returns amount.","url":"https://api.vaults.fyi/v2/portfolio/total-returns/:userAddress/:network/:vaultId?utm_source=zero.xyz","method":"HEAD","headers":{},"bodySchema":null,"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.002","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"registry","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.002/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.002","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.002","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_SoXQ6LHcCaVlpKDaJDwu2","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.002","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Retrieves the total returns earned by a user for their position in a specific vault, including asset details and native returns amount.","exampleAgentPrompt":"What are the total returns my wallet 0xAbC123... has earned in vault 0xDEF456 on the Ethereum network on vaults.fyi?","exampleUseCases":[{"title":"Personal DeFi yield tracking","prompt":"Can you check how much my wallet 0xAbC123... has earned in total returns from vault 0xDEF456 on the Arbitrum network?"},{"title":"Portfolio performance review","prompt":"I want to review all my vault gains — start by getting the total returns for address 0x789XYZ on Optimism for vault 0xAAA111."},{"title":"Investor reporting on vault earnings","prompt":"Pull the total returns for wallet address 0xInvestor99 in vault 0xVAULT77 on the Base network so I can include it in a client report."}],"resultDescription":"Returns the total returns earned by the specified user address in the given vault on the specified network, including asset metadata (symbol, decimals, address) and the native returns amount denominated in the vault's underlying asset.","failureModes":["Invalid or non-existent userAddress returns 404 or empty result","Unsupported network identifier returns an error","Invalid vaultId returns 404 not found","User has no position in the specified vault, returning zero or null returns","Network congestion or RPC issues causing delayed or failed data fetch"],"whenToPreferThis":"Use this endpoint when you need the cumulative total returns for a specific user's position in a known vault on a specific network. Prefer this over general vault listing endpoints when you have all three identifiers (userAddress, network, vaultId) and want earnings data rather than current APY or TVL.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-11T06:50:20.737Z","isFirstParty":false,"canonicalSlug":"vaults-fyi-total-returns-for-user-vault-position-6b013036"}