Name: ProYield API: USDC Vault Data and Stablecoin Lending Rates
Brand: proyield
SKU: api-proyield-yield
Availability: InStock
Author: API Market

# ProYield Yield API

## Overview

The ProYield Yield API returns read-only data about ProYield, a non-custodial USDC vault on HyperEVM (chain id 999). The strategies endpoint returns the vault itself: its address, share price, total assets, the live on-chain caps (TVL cap, per-wallet cap and whether deposits are paused), how the assets are split across the deployed strategies, and a list of stablecoin lending venue rates sourced from DefiLlama. The positions endpoint takes any wallet address and returns that wallet's vault shares, what those shares redeem for, the live share price and the wallet's USDC balance on HyperEVM. The series endpoint returns the vault's daily share-price history from its signed attestation feed, one point per day, plus day-over-day growth in basis points.

It is built for developers of wallets, dashboards, portfolio trackers and AI agents that need to show or reason about this vault's state. Every response is JSON and carries the network, an `as_of` timestamp for the upstream data, and an `errors[]` array. The API is information only. It has no transaction builder and no deposit or withdraw endpoint, it never holds funds or keys, and nothing it returns is investment, legal or tax advice. A rate in a response is a dated, sourced reading or a labelled policy anchor, never a forecast or a promised return.

## Features

*   **3 endpoints**: Vault catalog with caps, strategies and venue rates; live wallet position; daily share-price series.
*   **Live on-chain reads**: Caps, share price and wallet positions are read from the chain at request time. Nothing is stored for positions.
*   **Values passed through as read**: Figures are copied from the vault's on-chain reads and its published feeds. They are not recomputed, rounded or replaced.
*   **Failures reported, not hidden**: When a sub-read fails, the affected field is `null` and a line is added to `errors[]`, on a 200 response. A failed read is never turned into a zero.
*   **No filled-in history**: The series is not interpolated. A day with no on-chain read has `share_price_usdc: null`, and the growth value that depends on it is `null` too.
*   **Dated and sourced**: Responses include `as_of`, and the strategies and series responses include `generated_at`; venue rates name their source and generation time.
*   **Input**: Only the positions endpoint takes a parameter, a 0x-prefixed 20-byte EVM wallet address.
*   **Rate limit**: 10 requests per second on the pay-as-you-go plan.

## Use Cases

*   **Wallet and portfolio apps**: Show a user's ProYield shares, their USDC value and their wallet USDC balance on HyperEVM.
*   **Dashboards**: Display the vault's total assets, caps, paused state and strategy split.
*   **Share-price charts**: Plot the vault's daily share price from the attestation series, with gaps shown where a day has no reading.
*   **Deposit pre-checks**: Read the TVL cap, per-wallet cap and `deposits_paused` before sending a user to the vault's own app.
*   **AI agents**: Give an agent a read-only tool that answers questions about the vault's current state and history, with sources and timestamps.

## API Documentation

### Base URL

All requests go through the API.market gateway at this base URL:

```
https://prod.api.market/api/v1/proyield/yield
```

### Authentication

Every request needs your API.market key in the `x-api-market-key` header:

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Get the vault catalog

Returns the vault's address, share price, total assets, total shares and idle USDC; the live on-chain caps (`tvl_usdc`, `per_user_usdc`, `deposits_paused`); the deployed strategies with the USDC in each and its `apy_pct`; the `blend` object; and `venue_rates`, a list of stablecoin lending venue rates with their source and generation time. `blend.target_pct` is a policy anchor taken from measured history. It carries `guarantee: false` and is not a rate the vault pays or promises. A strategy's `apy_pct` can be `null`.

**Method:** `GET`

**Endpoint:** `/api/yield/strategies`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| - | - | This endpoint takes no parameters. | - | - | - | - |

**Example Request:**

```bash
curl -X GET "https://prod.api.market/api/v1/proyield/yield/api/yield/strategies" \
  -H "x-api-market-key: YOUR_API_KEY"
```

**Example Response (200 OK, abridged: blend note and 2 of 4 core rates omitted):**

```json
{
  "api": "proyield-yield-api",
  "version": "0.1",
  "kind": "strategy_catalog",
  "as_of": "2026-10-15T18:00:11.548Z",
  "generated_at": "2026-10-15T21:50:58.368Z",
  "network": {
    "name": "HyperEVM Mainnet",
    "chain_id": 999
  },
  "vault": {
    "address": "0x8954a73Bb36D17e4B212137Eb7B2328A1A14D1C1",
    "share_price_usdc": 1.008980560691058,
    "total_assets_usdc": 123.90047,
    "total_shares": 122.797678,
    "idle_usdc": 5.725348,
    "caps": {
      "tvl_usdc": 10000,
      "per_user_usdc": 1000,
      "deposits_paused": false
    },
    "flags": {
      "boostLive": true
    }
  },
  "strategies": [
    {
      "kind": "lending",
      "name": "Morpho Blue",
      "address": "0xBF4C5e339D63EEB393DA2797679879a0a5Af2D53",
      "assets_usdc": 50.536945,
      "apy_pct": 4.92
    },
    {
      "kind": "funding",
      "name": "Funding sleeve",
      "address": "0xeD40C3c34e2d4D6F2e1C0F0e688a6c05c82F9Bf4",
      "assets_usdc": 30.575532,
      "apy_pct": 10.95
    },
    {
      "kind": "fixed",
      "name": "Fixed-rate sleeve (PT)",
      "address": "0x2D3E5bf1D34791b8b66Ac4eEA6D281E918577B6b",
      "assets_usdc": 0,
      "apy_pct": 0
    },
    {
      "kind": "fixed",
      "name": "Fixed-rate sleeve (PT, ETH lane)",
      "address": "0xA96D0BB29cEE6F9e26239529789CEb74912C4b25",
      "assets_usdc": 18.962423,
      "apy_pct": 14.55
    },
    {
      "kind": "lending",
      "name": "HL Earn (idle-cash)",
      "address": "0xA2e535970dc1492f77843E26F25Ab314735F4dF5",
      "assets_usdc": 17.960165,
      "apy_pct": null
    }
  ],
  "blend": {
    "target_pct": 6.5,
    "guarantee": false
  },
  "venue_rates": {
    "source": "yields.llama.fi/pools (DefiLlama)",
    "generated_utc": "2026-10-15T13:01:44Z",
    "core_rates": [
      {
        "apy": 6.49858,
        "chain": "Monad",
        "full": "morpho-blue HYPERUSDCA",
        "name": "HYPERUSDCA",
        "tag": "core",
        "tvl": 51843760
      },
      {
        "apy": 5.61745,
        "chain": "Ethereum",
        "full": "morpho-blue PENDLEUSDC",
        "name": "PENDLEUSDC",
        "tag": "core",
        "tvl": 53535262
      }
    ],
    "fixed_pool_apy": 0,
    "satellite_apy": 10.132715
  },
  "errors": []
}
```

In the full response, `blend` also carries a `note` field stating that the value is a policy anchor from measured history and not a promised rate.

#### 2. Get a wallet position

Returns a wallet's live position in the vault: its vault shares, `value_usdc` (what those shares redeem for, using the vault's own offset share math, floor-rounded like the contract), the live share price, the wallet's share of the vault, and the wallet's USDC balance on HyperEVM. All values are chain reads made at request time. Earnings are not computed: to work them out, subtract your own deposit history from `value_usdc`. If the wallet balance read fails, `usdc_hyperevm` is `null` and the failure is listed in `errors[]`.

**Method:** `GET`

**Endpoint:** `/api/yield/positions`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| `address` | query | The wallet to read, as a 0x-prefixed 20-byte EVM address (`0x` plus 40 hex characters). | string | Yes | - | - |

**Example Request:**

```bash
curl -X GET "https://prod.api.market/api/v1/proyield/yield/api/yield/positions?address=0x8954a73Bb36D17e4B212137Eb7B2328A1A14D1C1" \
  -H "x-api-market-key: YOUR_API_KEY"
```

**Example Response (200 OK, abridged: 1 of 2 notes shown):**

```json
{
  "api": "proyield-yield-api",
  "version": "0.1",
  "kind": "position",
  "as_of": "2026-10-15T21:51:00.172Z",
  "network": {
    "name": "HyperEVM Mainnet",
    "chain_id": 999
  },
  "address": "0x8954a73Bb36D17e4B212137Eb7B2328A1A14D1C1",
  "vault": {
    "address": "0x8954a73Bb36D17e4B212137Eb7B2328A1A14D1C1",
    "shares": 0,
    "value_usdc": 0,
    "share_price_usdc": 1.00898,
    "percent_of_vault": 0,
    "total_assets_usdc": 123.90047,
    "total_shares": 122.797678
  },
  "wallet": {
    "usdc_hyperevm": 5.725348
  },
  "notes": [
    "reads are live eth_calls at request time; value uses the vault's offset share math"
  ],
  "errors": []
}
```

The omitted note says that earnings are not computed and that you should subtract your deposit history from `value_usdc`.

#### 3. Get the daily share-price series

Returns the vault's daily share-price series from its signed attestation feed. `points[]` has one entry per day with the share price, total assets, insurance balance and coverage ratio. `daily_growth_bps[]` gives the growth from the previous consecutive day in basis points, calculated as (today's share price / previous day's share price minus 1) times 10,000, rounded to 4 decimal places. Days are never interpolated or simulated: a day with no on-chain read has `share_price_usdc: null`, and any growth value that depends on it is `null` too. If the feed read fails, the response is an empty series plus an entry in `errors[]`, on a 200. The series is a record of the past, not a forecast.

**Method:** `GET`

**Endpoint:** `/api/yield/series`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| - | - | This endpoint takes no parameters. | - | - | - | - |

**Example Request:**

```bash
curl -X GET "https://prod.api.market/api/v1/proyield/yield/api/yield/series" \
  -H "x-api-market-key: YOUR_API_KEY"
```

**Example Response (200 OK, abridged: 2 of 22 points shown; source, daily_growth_bps, notes and errors omitted):**

```json
{
  "api": "proyield-yield-api",
  "version": "0.1",
  "kind": "share_price_series",
  "as_of": "2026-10-15",
  "generated_at": "2026-10-15T21:51:01.622Z",
  "network": {
    "name": "HyperEVM Mainnet",
    "chain_id": 999
  },
  "points_count": 22,
  "first_date": "2026-09-24",
  "last_date": "2026-10-15",
  "points": [
    {
      "date": "2026-09-24",
      "chain_id": 999,
      "share_price_usdc": null,
      "total_assets_usdc": 0,
      "insurance_usdc": 0,
      "coverage_ratio": null
    },
    {
      "date": "2026-10-01",
      "chain_id": 999,
      "share_price_usdc": 1.027913,
      "total_assets_usdc": 53.392731,
      "insurance_usdc": 0,
      "coverage_ratio": null
    }
  ]
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The data is in the response body. Check `errors[]`: if it is not empty, a sub-read failed and the affected field is `null` or the series is empty. |
| 400 | Bad Request | The positions `address` is missing or is not a 0x-prefixed 20-byte hex address (`invalid_address`). |
| 401 | Unauthorized | The `x-api-market-key` value is invalid or expired. |
| 403 | Forbidden | Your subscription does not include this endpoint. |
| 404 | Not Found | The endpoint path does not exist. Check the path against this page. |
| 429 | Too Many Requests | You went over 10 requests per second, or hit the provider's own rate limit (`rate_limited`). Wait for the `Retry-After` seconds and retry. |
| 500 | Internal Server Error | Something failed while processing the request. Retry after a short delay. |
| 503 | Service Unavailable | The positions endpoint could not complete its chain reads (`upstream_unavailable`). This is temporary; retry. |

## Rate Limits

The pay-as-you-go plan allows 10 requests per second. The provider also applies its own rate limit, which answers `429` with a `Retry-After` header. Requests above either limit return `429 Too Many Requests`; back off before retrying and honour the `Retry-After` header. The series only gains one point per day and venue rates are generated upstream on their own schedule, so poll them at a modest interval rather than in a tight loop.

## FAQ

**How am I charged?**

US$0.01 per request on the pay-as-you-go plan, paid from your API.market wallet. There is no monthly fee.

**Does this API promise or predict any return?**

No. Every rate is a dated reading from the chain or a named source, or a labelled policy anchor. `blend.target_pct` carries `guarantee: false`, and the share-price series is a record of past days, not a forecast. Nothing here is investment, legal or tax advice.

**Can I deposit or withdraw through this API?**

No. It is read-only. There is no transaction builder and no deposit or withdraw endpoint, and the API never holds funds, signs transactions or holds keys.

**Why is a field null instead of a number?**

A sub-read failed or there was no reading for that day. The API reports this as `null` with an entry in `errors[]` rather than substituting a value. In the series, a day with no on-chain read has `share_price_usdc: null`, and the matching growth value is also `null`.

**Does the positions endpoint show my earnings?**

No. It returns shares, their current USDC value and your wallet USDC. To get earnings, subtract your own deposit history from `value_usdc`.

**Where do the venue rates come from?**

From DefiLlama's pools data. The `venue_rates` object names the source and the time the rates were generated, which can be earlier than the time of your request.

**Has the vault been audited?**

The provider does not describe the vault as audited. Its contracts are under community review.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


ProYield API returns read-only data for a USDC vault on HyperEVM: on-chain caps, strategy split, wallet positions, lending rates and daily share prices.