HTTP endpoints

Get user leaderboard

Users ranked by portfolio PnL (equity change net of deposits, withdrawals, and vault flows) or fill volume over a time window.

Parameters

Parameter	Required	Type	Description
startTime	yes	integer (int64)	Start timestamp in milliseconds (optional). Omit or pass 0 for all available history.
endTime	yes	integer (int64)	End timestamp in milliseconds (optional). Omit or pass 0 for the latest available data.
count	yes	integer	null
metric	yes	—	Ranking metric. `pnl` orders by portfolio PnL (equity change net of cash flows); `volume` orders by fill notional.
account	yes	string (hex)	Optional account whose leaderboard position should be returned even if outside `count`.

Response fields

Parameter	Required	Type	Description
`accountPosition`	no	object	—
`leaderboard`	yes	object[]	Users ranked by portfolio PnL (equity change net of deposits, withdrawals, and vault flows) and fill notional over the requested time range.
`leaderboard[].pnl`	yes	string	—
`leaderboard[].user`	yes	string (hex)	An Ethereum-style account address (20 bytes).
`leaderboard[].volume`	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

leaderboard

Get user leaderboard

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

const options = {method: 'GET'};

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

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

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

{
  "leaderboard": [
    {
      "pnl": "12.34",
      "user": "0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b",
      "volume": "1000.25"
    }
  ]
}

"<string>"

"<string>"

Path Parameters

startTime

null | integer<int64>

required

Start timestamp in milliseconds (optional). Omit or pass 0 for all available history.

Required range: x >= 0

endTime

null | integer<int64>

required

End timestamp in milliseconds (optional). Omit or pass 0 for the latest available data.

Required range: x >= 0

count

integer | null

default:100

required

Maximum number of users to return (optional, defaults to 100, max 1000).

Required range: x >= 0

metric

null | any

default:pnl

required

Ranking metric. pnl orders by portfolio PnL (equity change net of cash flows); volume orders by fill notional.

account

string<hex>

required

Optional account whose leaderboard position should be returned even if outside count.

Response

Leaderboard

leaderboard

object[]

required

Users ranked by portfolio PnL (equity change net of deposits, withdrawals, and vault flows) and fill notional over the requested time range.

Show child attributes

accountPosition

null | object

Requested account's 1-based leaderboard position, if account was provided and ranked.

Show child attributes

Get user leaderboard

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

const options = {method: 'GET'};

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

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

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

{
  "leaderboard": [
    {
      "pnl": "12.34",
      "user": "0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b",
      "volume": "1000.25"
    }
  ]
}

"<string>"

"<string>"

Introduction

Public REST-API

Private REST-API

Indexer REST-API

Public WebSocket streams

Private WebSocket streams

WebSocket API

Error responses

Get user leaderboard

Parameters

Response fields

Response example

Path Parameters

Response