Skip to main content
GET
/
v1
/
vaults
/
apy
Fetch the APY of a vault
curl --request GET \
  --url https://api.paxoslabs.com/v1/vaults/apy
{
  "apy": 12.5,
  "error": null
}

Query Parameters

​
token_address
string
required

The address of the vault.

Example:

"0x19e099B7aEd41FA52718D780dDA74678113C0b32"

​
block_number
integer

Block number to calculate the APY at. Optional. Defaults to the latest block.

​
lookback_days
integer

Number of days to look back for the APY calculation. Defaults to 7 if not provided.

Example:

7

Response

Successful response with APY details

​
apy
number

Calculated APY value.

Example:

12.5

​
error
string | null

Error message if any occurred.

Example:

null