Skip to main content
GET
/
v1
/
apy
/
{vault_id}
Get single product APY
curl --request GET \
  --url https://api.example.com/v1/apy/{vault_id}
{
  "vault_id": "<string>",
  "latest_share_price": "1000.00",
  "calculated_at": "2023-11-07T05:31:56Z",
  "daily_apy": 123,
  "weekly_apy": 123,
  "monthly_apy": 123,
  "yearly_apy": 123,
  "daily_period_days": 123,
  "weekly_period_days": 123,
  "monthly_period_days": 123,
  "yearly_period_days": 123
}

Path Parameters

vault_id
string
required

Vault ID

Query Parameters

period
string | null

Specific period (daily, weekly, monthly, yearly, all)

Response

APY data retrieved successfully

vault_id
string
required
latest_share_price
string
required

A decimal number represented as a string

Example:

"1000.00"

calculated_at
string<date-time>
required
daily_apy
number<double> | null
weekly_apy
number<double> | null
monthly_apy
number<double> | null
yearly_apy
number<double> | null
daily_period_days
integer<int32> | null
weekly_period_days
integer<int32> | null
monthly_period_days
integer<int32> | null
yearly_period_days
integer<int32> | null