{"uid":"cap_BvZCX-5CCPx_xMLbOW7vL","slug":"proyield-vault-state-api-7de2a4a5","name":"ProYield Vault State API","description":"Live Pro Yield vault state on HyperEVM: share price, total assets, live on-chain caps (TVL cap, per-user cap, deposits paused), and — when an address is supplied — that wallet's position value and wallet USDC. Use when an agent needs to check vault health or a position before depositing.","url":"https://pyd.fi/api/agents/vault?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET","HEAD","DELETE"],"type":"string"},"queryParams":{"type":"object","properties":{"address":{"type":"string"}}}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object"}}}}},"responseSchema":{"type":"json","example":{"kind":"vault","vault":{"caps":{"tvl_usdc":10000,"per_user_usdc":1000,"deposits_paused":false},"share_price_usdc":1.028268,"total_assets_usdc":126.269032},"position":null}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.01","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","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.01/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.01","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_KhG_Qbmpx511_EvvRxhu9","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.01","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Returns live ProYield vault metrics on HyperEVM — share price, total assets, TVL/per-user caps, deposit status, and optionally a specific wallet's position value and USDC balance.","exampleAgentPrompt":"Before I deposit into ProYield, can you check the current vault state — share price, total assets, whether deposits are paused, and the TVL and per-user caps — and also tell me what my position is worth for wallet 0xABC123?","exampleUseCases":[{"title":"Pre-deposit vault health check","prompt":"I'm about to put some USDC into ProYield — can you pull the current vault state and tell me the share price, total assets, whether deposits are paused, and what the TVL and per-user caps are so I know if there's room?"},{"title":"Monitor personal position value","prompt":"Can you check my ProYield position for wallet 0xDEF456 and tell me what it's currently worth along with how much USDC I have in the vault?"},{"title":"Automated vault capacity alert","prompt":"Every hour, check the ProYield vault on HyperEVM and let me know when the TVL is within 10% of the cap or if deposits get paused."}],"resultDescription":"Returns a JSON object with vault-level data (share price in USDC, total assets in USDC, TVL cap, per-user cap, deposits_paused flag) and, when an address is provided, the wallet's current position value and USDC balance. The `position` field is null if no address is supplied.","failureModes":["Invalid or malformed wallet address returns null position without error","If the vault contract is unreachable on HyperEVM, the API may return a 5xx error","Payment failure (x402) if USDC payment of $0.005 is not included or rejected","Rate limiting if called too frequently without valid payment headers","Network congestion on HyperEVM may cause stale or delayed on-chain reads"],"whenToPreferThis":"Use this endpoint when you need real-time, on-chain vault state for ProYield specifically — especially before executing a deposit to verify caps, paused status, and share price. Prefer this over general DeFi data aggregators when you need authoritative data directly from the ProYield contract on HyperEVM, or when you need to check a specific wallet's position value before acting.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-31T06:34:37.657Z","isFirstParty":false,"canonicalSlug":"proyield-vault-state-api-7de2a4a5"}