HTTP endpoints

Get vault history

Vault return curve, NAV curve, TVL curve, and annualized APR for an account over a time range.

Parameters

Parameter	Required	Type	Description
address	yes	string (hex)	Account address.
from	yes	integer (int64)	Start timestamp in milliseconds (inclusive). Use 0 for all available history.
to	yes	integer (int64)	End timestamp in milliseconds (inclusive). Use 0 for the latest available snapshot.
interval	yes	string	Aggregation interval for the return and NAV curves.

Response fields

Parameter	Required	Type	Description
`apr`	yes	string	Annualized percentage return as a decimal string.
`nav`	yes	object[]	Per-share NAV curve normalized to 1.0 at the vault’s first positive NAV.
`nav[].timestamp`	yes	integer (int64)	—
`nav[].value`	yes	string	—
`returns`	yes	object[]	Return curve derived from vault account equity snapshots.
`returns[].timestamp`	yes	integer (int64)	—
`returns[].value`	yes	string	—
`tvl`	yes	object[]	TVL curve derived from vault account equity snapshots.
`tvl[].timestamp`	yes	integer (int64)	—
`tvl[].value`	yes	string	—
`vaultStats`	yes	object	—
`vaultStats.averageReturns`	yes	string	—
`vaultStats.maxDrawdown`	yes	string	—
`vaultStats.returnsVolatility`	yes	string	—
`vaultStats.sharpeRatio`	yes	string	—

Response example

A sample 200 response body is attached to this operation as an OpenAPI example — see the Example panel on this page.

GET

vault-history

Get vault history

curl --request GET \
  --url https://beta.rocket-cluster-1.com/indexer/vault-history

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/vault-history', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.rocket-cluster-1.com/indexer/vault-history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://beta.rocket-cluster-1.com/indexer/vault-history"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://beta.rocket-cluster-1.com/indexer/vault-history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "apr": "0.438",
  "nav": [
    {
      "timestamp": 1774360800000,
      "value": "1.25"
    }
  ],
  "returns": [
    {
      "timestamp": 1774360800000,
      "value": "0.0012"
    }
  ],
  "tvl": [
    {
      "timestamp": 1774360800000,
      "value": "1250000.42"
    }
  ],
  "vaultStats": {
    "averageReturns": "0.0012",
    "maxDrawdown": "0.031",
    "returnsVolatility": "0.0042",
    "sharpeRatio": "1.2"
  }
}

"<string>"

"<string>"

Path Parameters

address

string<hex>

required

Account address.

from

integer<int64>

required

Start timestamp in milliseconds (inclusive). Use 0 for all available history.

Required range: x >= 0

integer<int64>

required

End timestamp in milliseconds (inclusive). Use 0 for the latest available snapshot.

Required range: x >= 0

interval

enum<string>

required

Aggregation interval for the return and NAV curves. Candle timeframe/interval for aggregation

Available options:

1m,

5m,

15m,

30m,

1h,

4h,

1d

Example:

"1h"

Response

Vault history

Response containing vault returns, NAV, TVL, annualized APR, and summary stats.

apr

string

required

Annualized percentage return as a decimal string.

nav

object[]

required

Per-share NAV curve normalized to 1.0 at the vault's first positive NAV.

Show child attributes

returns

object[]

required

Return curve derived from vault account equity snapshots.

Show child attributes

tvl

object[]

required

TVL curve derived from vault account equity snapshots.

Show child attributes

vaultStats

object

required

Summary stats derived from the per-share NAV returns over the requested range.

Show child attributes

Get vault history

curl --request GET \
  --url https://beta.rocket-cluster-1.com/indexer/vault-history

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/vault-history', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.rocket-cluster-1.com/indexer/vault-history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://beta.rocket-cluster-1.com/indexer/vault-history"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://beta.rocket-cluster-1.com/indexer/vault-history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "apr": "0.438",
  "nav": [
    {
      "timestamp": 1774360800000,
      "value": "1.25"
    }
  ],
  "returns": [
    {
      "timestamp": 1774360800000,
      "value": "0.0012"
    }
  ],
  "tvl": [
    {
      "timestamp": 1774360800000,
      "value": "1250000.42"
    }
  ],
  "vaultStats": {
    "averageReturns": "0.0012",
    "maxDrawdown": "0.031",
    "returnsVolatility": "0.0042",
    "sharpeRatio": "1.2"
  }
}

"<string>"

"<string>"

Introduction

Public REST-API

Private REST-API

Indexer REST-API

Public WebSocket streams

Private WebSocket streams

WebSocket API

Error responses

Get vault history

Parameters

Response fields

Response example

Path Parameters

Response