> ## Documentation Index
> Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PAXGy APY

> Read the current and historical PAXGy APY over REST

PAXGy accrues through its exchange rate: the amount of PAXG each PAXGy is worth rises over time. The APY endpoint turns that exchange-rate history into an annualized yield figure you can show in a UI or chart.

> [!NOTE]
>
> The endpoint is named `vaultApys` because it is shared across Paxos Labs
> yield products. Filter it to the PAXGy token address to get PAXGy only.

## Current APY

Request the most recent point, newest first:

```bash theme={null}
curl -G "https://api.paxoslabs.com/v2/amplify/vaultApys" \
  -H "x-api-key: pxl_your_key" \
  --data-urlencode "filter=vaultAddress=0x6c6494Fd9962eB98B94ffA48F6679058F820700e" \
  --data-urlencode "orderByTimestamp=desc" \
  --data-urlencode "pageSize=1"
```

```json theme={null}
{
  "vaultApys": [
    {
      "vaultAddress": "0x6c6494fd9962eb98b94ffa48f6679058f820700e",
      "chainId": 1,
      "timestamp": "2026-10-22T00:00:00Z",
      "interval": "1d",
      "apy": "4.2500"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjF9",
  "tokenMetadata": {}
}
```

`nextPageToken` is non-null here because `pageSize=1` leaves the rest of the series on later pages. Ignore it when you only want the latest point.

`apy` is already a percentage: `"4.2500"` means 4.25%. Do not multiply by 100.

## APY history

Omit `pageSize` and `orderByTimestamp` to get a chronological series. By default you get one point per day for the last 30 days, each annualizing the exchange-rate change over the preceding 7 days.

```bash theme={null}
curl -G "https://api.paxoslabs.com/v2/amplify/vaultApys" \
  -H "x-api-key: pxl_your_key" \
  --data-urlencode "filter=vaultAddress=0x6c6494Fd9962eB98B94ffA48F6679058F820700e" \
  --data-urlencode "startTime=2026-07-01T00:00:00Z" \
  --data-urlencode "endTime=2026-10-01T00:00:00Z" \
  --data-urlencode "interval=1w" \
  --data-urlencode "lookback=30d"
```

Pages hold up to 100 points. Pass the returned `nextPageToken` as `pageToken` to fetch the next page; it is `null` on the last one.

### Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `filter` | `string` | No | `vaultAddress=<PAXGy address>` to return PAXGy only. Omit to get every vault |
| `startTime` | `string` | No | First timestamp to return (RFC 3339 UTC). Defaults to 30 days before `endTime` |
| `endTime` | `string` | No | Last timestamp to return (RFC 3339 UTC). Defaults to now |
| `interval` | `string` | No | Spacing between points: `1d`, `1w`, `1m`, or `1y`. Defaults to `1d` |
| `lookback` | `string` | No | Window each point annualizes over: `1d`, `7d`, `14d`, or `30d`. Defaults to `7d` |
| `orderByTimestamp` | `string` | No | `asc` or `desc`. Defaults to `asc` |
| `pageSize` | `number` | No | 1 to 100. Defaults to 25 |
| `pageToken` | `string` | No | Token from the previous page |

### Choosing a lookback

A short lookback reacts quickly to rate changes but is noisier. A long lookback smooths the series. For a headline figure, `7d` is a reasonable default; for a long-range chart, pair `interval=1w` with `lookback=30d`.

A window that starts before PAXGy's history begins is shortened to the available span, so the earliest points can cover less than the requested lookback.

## Response fields

| Field | Type | Description |
| - | - | - |
| `vaultAddress` | `string` | The PAXGy token address, lowercased |
| `chainId` | `number` | Always `1`. PAXGy reports a single APY from Ethereum even though it is held on X Layer too |
| `timestamp` | `string` | Timestamp of the point (RFC 3339 UTC) |
| `interval` | `string` | Echoes the requested `interval` |
| `apy` | `string` | APY in percent |

> [!NOTE]
>
> For the exchange rate itself, or a wallet's PAXGy balance and its value in
> PAXG, use `GET /v2/amplify/userPositions`. For the full parameter and
> response schema, see the
> [List vault APYs](https://developers.paxoslabs.com/v1.0.0/api-reference/vaults/list-vault-apys.md) reference.
> For size rather than yield, see [PAXGy TVL](https://developers.paxoslabs.com/v1.0.0/intro/products/paxgy/tvl.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.