> ## 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.
# List vault rewards (net of fees)
> Returns the time-series of rewards distributed to a vault. All yield values are net of management and performance fees. `vaultAddress` and `chainId` are required. Time range: when both startTime and endTime are omitted, defaults to (now - 14 days, now); pass both to override. Pagination: pageSize default 25 (max 100); omit pageToken for the first page.
## OpenAPI
````yaml /v1.0.0/api-reference/openapi.yml get /v2/paxosRewards/vaultRewards
openapi: 3.0.0
info:
title: Paxos Labs API
description: >
Paxos Labs API V2.
---
# API overview
This document describes shared behavior and conventions for the Paxos Labs
API (REST and GraphQL).
Health check
A **health** endpoint is available for orchestrators (GitHub Actions, etc).
| Item |
Details
|
| ------------ |
---------------------------------------------------------------------------------------
|
| **Path** | `GET /health` (no version prefix; no API key or rate limit
applied). |
| **Response** | `200` with Terminus-style JSON when healthy; `503` when
unhealthy (e.g. database down). |
**Docker / healthcheck:** If your healthcheck uses `curl` (e.g. `curl -f
http://localhost:3000/health`), ensure your image has curl installed. Base
images like `node:bullseye-slim` or `node:alpine` do not—install it (e.g.
`RUN apk add --no-cache curl` for Alpine).
GraphQL endpoint
A **GraphQL** API is available in addition to REST. Use it to query address
book and vault data with a single request and flexible field selection.
| Item |
Details |
| ---------------------------- |
-------------------------------------------------------------------- |
| **Altair (interactive IDE)** |
[https://api.paxoslabs.com/altair](https://api.paxoslabs.com/altair) |
| **GraphQL endpoint** | Same base URL with path `/graphql` for
POST. |
| **Authentication** | Same as REST: send `x-api-key`
header. |
Open the Altair link in a browser to explore the schema and run queries.
Filter query parameter syntax
List endpoints that support a `filter` query parameter use a single string
with **keys**, **operators**, and **combinators**. This keeps the number of
query params small (AIP-160 style) while allowing flexible filtering.
Operators
| Operator | Meaning | Example |
| -------- | ---------- | ------------------ |
| `=` | Equals | `chainId=1` |
| `!=` | Not equals | `status!=REFUNDED` |
Combinators
| Combinator | Meaning |
Example |
| ---------- | -------------------------------------------- |
------------------------------- |
| `AND` | All conditions must match (case-insensitive) | `chainId=1 AND
name="Treasury"` |
| `OR` | Any condition may match (case-insensitive) | `chainId=1 OR
chainId=137` |
Value formatting
| Type | Use case |
Example |
| -------- | ----------------------------------------- |
------------------------- |
| Unquoted | Numbers, booleans, single-token values | `chainId=1`,
`valid=true` |
| Quoted | Strings with spaces or special characters | `name="Treasury
Wallet"` |
| Escape | Literal quote inside a quoted string |
`\"` |
Allowed **keys** and **value types** (number, hex address, string, etc.) are
defined per endpoint in the API docs and validated by the server.
Possible combinations (examples)
| Category |
Example |
| --------------------- |
--------------------------------------------------- |
| Single condition |
`chainId=1` |
| Single condition |
`status!=REFUNDED` |
| AND | `chainId=1 AND
name="Treasury"` |
| AND | `vaultAddress=0x123... AND
chainId=1` |
| OR | `chainId=1 OR
chainId=137` |
| OR | `status=PENDING OR
status=COMPLETE` |
| Mixed AND and OR | `chainId=1 AND (status=PENDING OR
status=COMPLETE)` |
| Equals and not-equals | `chainId=1 AND
status!=REFUNDED` |
| Equals and not-equals |
`name!=""` |
Mixed AND and OR: AND has higher precedence; use parentheses for grouping.
Without grouping, evaluation is left-to-right per implementation.
Implementation note
| Item |
Details |
| --------- |
------------------------------------------------------------------------- |
| Location |
`src/common/utils/filter.util.ts` |
| Supported | `=`, `!=`, `AND`,
`OR` |
| Errors | Invalid keys or value types return `400` with the standard
error envelope |
version: '2.0'
contact: {}
servers:
- url: https://api.paxoslabs.com/
description: Production
security: []
tags: []
paths:
/v2/paxosRewards/vaultRewards:
get:
tags:
- Paxos Rewards
summary: List vault rewards (net of fees)
description: >-
Returns the time-series of rewards distributed to a vault. All yield
values are net of management and performance fees. `vaultAddress` and
`chainId` are required. Time range: when both startTime and endTime are
omitted, defaults to (now - 14 days, now); pass both to override.
Pagination: pageSize default 25 (max 100); omit pageToken for the first
page.
operationId: PaxosRewardsController_listVaultRewards_v2
parameters:
- name: pageSize
required: false
in: query
description: Max items per page. Default 25, max 100.
schema:
minimum: 1
maximum: 100
default: 25
example: 25
type: number
- name: pageToken
required: false
in: query
description: Opaque cursor from a prior `nextPageToken`.
schema:
type: string
- name: vaultAddress
required: true
in: query
description: Vault contract address (0x + 40 hex chars).
schema:
example: '0x0000000000000000000000000000000000000001'
type: string
- name: chainId
required: true
in: query
description: EVM chain ID.
schema:
type: number
example: 1
- name: startTime
required: false
in: query
description: >-
Inclusive lower bound on the distribution snapshot timestamp. RFC
3339 UTC. When both startTime and endTime are omitted, defaults to
(now - 14 days, now).
schema:
example: '2026-01-01T00:00:00Z'
type: string
- name: endTime
required: false
in: query
description: >-
Inclusive upper bound on the distribution snapshot timestamp. RFC
3339 UTC. When both startTime and endTime are omitted, defaults to
(now - 14 days, now).
schema:
example: '2026-12-31T23:59:59Z'
type: string
responses:
'200':
description: List of vault rewards (net of fees).
content:
application/json:
schema:
$ref: '#/components/schemas/ListVaultRewardsResponseDto'
'400':
description: Missing or invalid vaultAddress / chainId, or malformed time params.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDto'
'404':
description: >-
No reward address registered for the supplied vaultAddress +
chainId.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDto'
'412':
description: Invalid or stale pageToken.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDto'
security:
- api-key: []
components:
schemas:
ListVaultRewardsResponseDto:
type: object
properties:
vaultRewards:
description: Time-series list of vault rewards, net of fees.
type: array
items:
$ref: '#/components/schemas/VaultRewardDto'
nextPageToken:
type: string
description: >-
Opaque cursor for the next page. Omitted when there are no further
results.
example: eyJjdXJzb3IiOiJhYmMifQ==
required:
- vaultRewards
ErrorResponseDto:
type: object
properties:
error:
description: Error object containing details
allOf:
- $ref: '#/components/schemas/ErrorObjectDto'
required:
- error
VaultRewardDto:
type: object
properties:
id:
type: string
description: Paxos claim id that produced this reward.
example: 01J9Z2P3Q4R5S6T7U8V9W0X1Y2
txHash:
type: string
description: >-
On-chain transaction hash of the rewards distribution to the
distribution address.
example: '0x0000000000000000000000000000000000000000000000000000000000000000'
decimals:
type: number
description: Token decimals (e.g. 6 for USDG).
example: 6
createdAt:
type: string
description: Timestamp of the rewards distribution snapshot. RFC 3339 UTC.
example: '2026-05-01T00:00:00Z'
chainId:
type: number
description: Chain on which the reward was distributed.
example: 1
usdgBalanceBase:
type: string
description: >-
Vault USDG balance at the time of the distribution, in token base
units. Omitted when the snapshot balance is unavailable.
example: '25000000'
realizedYield:
type: string
description: >-
Net yield in USDG for this distribution (gross yield minus fees).
Decimal string.
example: '12.345678'
cumulativeYield:
type: string
description: >-
Cumulative net yield in USDG up to and including this distribution.
Decimal string.
example: '125.50'
realizedApy:
type: string
description: >-
Realized APY at this distribution. Percent (e.g. "4.27" = 4.27%).
Decimal string.
example: '4.27'
required:
- id
- txHash
- decimals
- createdAt
- chainId
- realizedYield
- cumulativeYield
- realizedApy
ErrorObjectDto:
type: object
properties:
code:
type: number
description: HTTP status code
example: 400
message:
type: string
description: Human-readable error message
example: Invalid filter syntax.
status:
type: string
description: Error status enum value
enum:
- UNKNOWN
- INVALID_ARGUMENT
- NOT_FOUND
- PERMISSION_DENIED
- UNAUTHENTICATED
- RESOURCE_EXHAUSTED
- INTERNAL
- METHOD_NOT_ALLOWED
example: INVALID_ARGUMENT
details:
description: Additional error details
type: array
items:
$ref: '#/components/schemas/ErrorDetailDto'
required:
- code
- message
- status
ErrorDetailDto:
type: object
properties:
'@type':
type: string
description: Type URL identifying the error detail schema
example: type.paxoslabs.dev/errors/BadRequest
fieldViolations:
description: Field-level violations for validation errors
type: array
items:
$ref: '#/components/schemas/FieldViolationDto'
required:
- '@type'
FieldViolationDto:
type: object
properties:
field:
type: string
description: The field that caused the violation
example: filter
description:
type: string
description: Description of the violation
example: vaultAddress 0x0x is an invalid hex address.
required:
- field
- description
securitySchemes:
api-key:
type: apiKey
in: header
name: x-api-key
description: 'API key in format: pxl__'
````