Skip to main content
GET
/
v1
/
query
/
apy
/
{vault_id}
Get single product APY
curl --request GET \
  --url https://api.example.com/v1/query/apy/{vault_id} \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.byzantine.fi/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Pubkey, X-Timestamp, X-Signature
string
header
required

Headers

​
X-Pubkey
string
required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

​
X-Timestamp
string
required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

​
X-Signature
string
required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

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