# ProYield Vault State API

> ProYield Vault State API is a paid API for AI agents from pyd.fi, paid per call via x402, $0.01/call, status unknown (last checked 2026-10-31).

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.

## Facts

- Endpoint: GET https://pyd.fi/api/agents/vault?utm_source=zero.xyz
- Price: $0.01/call
- Payment: x402
- Status: unknown
- Last checked: 2026-10-31
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/proyield-vault-state-api-7de2a4a5
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_BvZCX-5CCPx_xMLbOW7vL

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability proyield-vault-state-api-7de2a4a5
```

Example prompt: 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?

## When to prefer this

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.

## Known failure modes

- 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

## How this service works

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.

## Output

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.

## Request schema (JSON Schema)

```json
{
 "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"
    }
   }
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "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
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/proyield-vault-state-api-7de2a4a5/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from pyd.fi](https://www.zero.xyz/host/pyd.fi/llms.txt)