πŸ“ˆVault Performance API Integration

An API endpoint that allows clients to analyse historical vault performance (return) across a number of different time periods.

Summary

The Vault Performance API provides the historical returns of a Vault over a number of different time periods. The returns are provided using three different calculation methodologies:

Cumulative: Is the percentage change between the initial value and the final value over the full measurement period.

Annualised Simple: Converts a return observed over a partial period into an annual rate using linear scaling. This is equivalent to an APR (Annual Percentage Rate).

Annualised Compound: Represents the effective annual growth rate assuming returns are reinvested. This is equivalent to an APY(Annual Percentage Yield).

Period

Cumulative

Annualized (Simple & Compound)

1 Day

βœ…

n/a

Trailing 7 Day

βœ…

n/a

Trailing 30 day

βœ…

βœ…

Trailing 90 day

βœ…

βœ…

Trailing 12 Month

βœ…

βœ…

Calendar Month (once completed)

βœ…

βœ…

Calendar Year (once completed)

βœ…

βœ…

Since Inception

βœ…

βœ…

circle-info

Cumulative returns: are primarily used to reflect the short-term performance of a Vault. Short-term returns are not annualized because annualizing short periods may exaggerate performance. The API does not provide annualised returns for periods <30 days.

Annualized returns: are primarily used to reflect the medium and long-term performance of a Vault.

circle-exclamation

Use Cases

OpenTrade clients and partners can use this API to:

  • Analyse historical Vault Performance from a specific date.

  • Analyse Vault Performance over a range of dates.

  • Use the data to build visualisations of vault performance over time for internal dashboards or end-user facing UI.

circle-info

Note: This API is only available for V5 Vaults.

Documentation

Full documentation for all endpoints can be found in swaggerarrow-up-right.

Authentication

Please contact a member of the Open Trade Sales team for further details on Authentication.

Endpoint

The core endpoint for the Vault Performance API is:

Parameters

Parameter

Type

Required

Description

vaultAddress

string

Yes

Ethereum address of the PoolDynamic vault (path parameter)

startDayStr

string

No

Start date in YYYY-MM-DD format (defaults to latest available: today after 9:30am GMT, else yesterday)

endDayStr

string

No

End date in YYYY-MM-DD format (defaults to latest available: today after 9:30am GMT, else yesterday)

includeMetadata

string

No

Set to "true" to include metadata explaining why metrics are null (default: not included)

Important Timing Notes:

  • Return metrics are calculated at 9:30 AM GMT daily. For more information on how metrics are calculatedarrow-up-right.

  • Metrics for "today" are only available after 9:30 AM GMT.

  • Before 9:30 AM GMT, the API returns the previous day's data.

  • If no date parameters are provided, the API returns the latest available single day's metrics.

Response

Below is an example of the API response returned for a given day. Full documentation is available in swagger.arrow-up-right

Field Descriptions

Identity Fields

  • poolAddr - Vault's Ethereum address

  • dayNumber - Unix day number (timestamp / 86400)

  • date - ISO 8601 date string (YYYY-MM-DD)

  • calculatedTimestamp - Unix timestamp when metrics were calculated (9:30am GMT)

  • calculatedBlockNumber - Blockchain block number used to get the exchangeRate value (blockNumber at 9:30 GMT)

Metadata

  • chainId - Blockchain network ID (e.g., 1 for Ethereum mainnet, 11155111 for Sepolia testnet)

  • createdAt - ISO 8601 timestamp of record creation

Null Values

Metrics return null when:

  • Insufficient historical data exists for that time period.

  • The period is incomplete (e.g., current month not yet finished).

  • The metric calculation requires data that predates vault inception.

  • Annualized metrics require a minimum of 30 days of data - If a vault has less than 30 days of history, all annualized fields will be null (cumulative values will still be provided).

Last updated