HTTP endpoints

Get portfolio

Equity and PnL curves plus summary stats for an account over a time range.

Parameters

Parameter	Required	Type	Description
account	yes	string (hex)	Ethereum-style account address for the sub-account context.
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 portfolio curves.

Response fields

Parameter	Required	Type	Description
`equity`	yes	object[]	Equity curve sampled from account snapshots.
`equity[].timestamp`	yes	integer (int64)	—
`equity[].value`	yes	string	—
`pnl`	yes	object[]	PnL curve derived from equity, net of bridge and vault cash flows.
`pnl[].timestamp`	yes	integer (int64)	—
`pnl[].value`	yes	string	—
`summary`	yes	object	—
`summary.averageLoss`	yes	string	—
`summary.averageWin`	yes	string	—
`summary.avgDailyPnl`	yes	string	—
`summary.longPnl`	yes	string	—
`summary.losses`	yes	string	—
`summary.maxDrawdownPct`	yes	string	—
`summary.pnl`	yes	string	—
`summary.pnlVolatilityPct`	yes	string	—
`summary.pnlVolatilityUsd`	yes	string	—
`summary.profitFactor`	yes	string	—
`summary.returnPct`	yes	string	—
`summary.sharpeRatio`	yes	string	—
`summary.shortPnl`	yes	string	—
`summary.totalFunding`	yes	string	—
`summary.totalTrades`	yes	integer (int64)	—
`summary.volume`	yes	string	—
`summary.winRate`	yes	string	—
`summary.wins`	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

portfolio

Get portfolio

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

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/portfolio', 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/portfolio",
  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/portfolio"

	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/portfolio")

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

{
  "equity": [
    {
      "timestamp": 1774360800000,
      "value": "1000.00"
    }
  ],
  "pnl": [
    {
      "timestamp": 1774360800000,
      "value": "0"
    }
  ],
  "summary": {
    "averageLoss": "-3.1",
    "averageWin": "3.1",
    "avgDailyPnl": "1.2%",
    "longPnl": "4.20",
    "losses": "10",
    "maxDrawdownPct": "12.00%",
    "pnl": "13.21",
    "pnlVolatilityPct": "18.00%",
    "pnlVolatilityUsd": "180.00",
    "profitFactor": "1.2",
    "returnPct": "2.00%",
    "sharpeRatio": "1.2",
    "shortPnl": "3.2",
    "totalFunding": "1.20",
    "totalTrades": 7,
    "volume": "21.21",
    "winRate": "1.4",
    "wins": "14"
  }
}

"<string>"

"<string>"

Path Parameters

account

string<hex>

required

Ethereum-style account address for the sub-account context.

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 portfolio curves. Candle timeframe/interval for aggregation

Available options:

1m,

5m,

15m,

30m,

1h,

4h,

1d

Example:

"1h"

Response

Portfolio curves

equity

object[]

required

Equity curve sampled from account snapshots.

Show child attributes

pnl

object[]

required

PnL curve derived from equity, net of bridge and vault cash flows.

Show child attributes

summary

object

required

Aggregate portfolio metrics for the requested range.

Show child attributes

Get portfolio

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

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/portfolio', 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/portfolio",
  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/portfolio"

	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/portfolio")

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

{
  "equity": [
    {
      "timestamp": 1774360800000,
      "value": "1000.00"
    }
  ],
  "pnl": [
    {
      "timestamp": 1774360800000,
      "value": "0"
    }
  ],
  "summary": {
    "averageLoss": "-3.1",
    "averageWin": "3.1",
    "avgDailyPnl": "1.2%",
    "longPnl": "4.20",
    "losses": "10",
    "maxDrawdownPct": "12.00%",
    "pnl": "13.21",
    "pnlVolatilityPct": "18.00%",
    "pnlVolatilityUsd": "180.00",
    "profitFactor": "1.2",
    "returnPct": "2.00%",
    "sharpeRatio": "1.2",
    "shortPnl": "3.2",
    "totalFunding": "1.20",
    "totalTrades": 7,
    "volume": "21.21",
    "winRate": "1.4",
    "wins": "14"
  }
}

"<string>"

"<string>"

Introduction

Public REST-API

Private REST-API

Indexer REST-API

Public WebSocket streams

Private WebSocket streams

WebSocket API

Error responses

Get portfolio

Parameters

Response fields

Response example

Path Parameters

Response